https://github.com/thiagohrcosta/calculator-app
Calculator APP is a Python-based API developed as part of the Rockeseat specialization in Python. The project simulates a real-world application while applying best practices in software design, architecture, and scalability. The main focus is on:
https://github.com/thiagohrcosta/calculator-app
api design-patterns flask numpy python
Last synced: 2 months ago
JSON representation
Calculator APP is a Python-based API developed as part of the Rockeseat specialization in Python. The project simulates a real-world application while applying best practices in software design, architecture, and scalability. The main focus is on:
- Host: GitHub
- URL: https://github.com/thiagohrcosta/calculator-app
- Owner: thiagohrcosta
- Created: 2024-06-24T17:46:53.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2025-02-12T01:05:37.000Z (over 1 year ago)
- Last Synced: 2025-02-12T02:23:53.983Z (over 1 year ago)
- Topics: api, design-patterns, flask, numpy, python
- Language: Python
- Homepage:
- Size: 36.1 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 📟 Calculator APP
## 🚀 About the Project
Calculator APP is a Python-based API developed as part of the Rockeseat specialization in Python. The project simulates a real-world application while applying best practices in software design, architecture, and scalability. The main focus is on:
- 🏗 **Clean and scalable code structure**
- 🧪 **Unit testing for reliability**
- 🔄 **Separation of concerns** for maintainability
- 🚨 **Request error handling** for robustness
This project is designed to strengthen coding skills while following industry best practices in Python development.
## Technologies
  
----------
## 🏗 Project Architecture
The application follows a structured folder organization:
```
📦 calculator-app
┣ 📂 src
┃ ┣ 📂 calculators ➝ Contains different calculator implementations & tests
┃ ┣ 📂 errors ➝ Handles API errors and exceptions
┃ ┣ 📂 main ➝ Application entry point, factories, and routes
┃ ┃ ┣ 📂 factories ➝ Factory pattern for modular calculator instances
┃ ┃ ┣ 📂 routes ➝ API endpoints and request handling
┃ ┃ ┗ 📂 server ➝ Server initialization
┗ 📂 .vscode ➝ Development environment settings
```
## ⚙️ Installation & Setup
1️⃣ **Clone the Repository:**
```
git clone https://github.com/your-username/calculator-app.git
cd calculator-app
```
2️⃣ **Create a Virtual Environment (Recommended):**
```
python -m venv venv
source venv/bin/activate # For macOS/Linux
venv\Scripts\activate # For Windows
```
3️⃣ **Install Dependencies:**
```
pip install -r requirements.txt
```
4️⃣ **Run the Application:**
```
python src/main/server/__init__.py or
python3 run.py
```
----------
## 🧪 Running Tests
To ensure code reliability, run the unit tests with:
```
pytest
```
## 📌 Features
✅ Modular calculator implementations
✅ Factory pattern for scalability
✅ Structured error handling
✅ Unit-tested components
✅ API-ready architecture
✅ NumPy-powered calculations for high-performance processing
## 🎯 Why This Project?
This project is an excellent demonstration of Python best practices, test-driven development, and scalable software architecture. If you're looking for a well-structured API project, this is it!
🔹 **Built for scalability** ➝ Designed with clean architecture principles
🔹 **Focused on maintainability** ➝ Code is structured for easy modifications
🔹 **Industry-standard patterns** ➝ Factory design, error handling, and unit testing
🔹 **NumPy integration** ➝ Optimized mathematical computations for performance
## 📄 License
This project is licensed under the MIT License.
----------