HW1: Technology Template Repository (Python)

---

Team Umbreon members :

• Jeevan Vasanthan
• Jimmy Shong
• Jordi Del Castillo
• Mudit Nigam
• Savitha Nair
• Tahmid Asif

---

Installation :

1. Create a template using this repository
2. Clone the repository

   git clone https://github.com/OpenSource-Spring2024/python-template.git
   

3. Install dependencies using pdm

   pdm install
   

4. Run unit tests using pytest

   pdm run pytest
   

5. Perform static analysis using mypy

   pdm run mypy .
   

6. Perform code formatting using Ruff

   pdm run ruff check .
   pdm run ruff format .
   

---

Features :

• Programming language - Python
• Toolchain / runtime environment - Python 3.11
• Testing framework is selected - pytest
• Continuous integration solution - CircleCI
• Static analysis solution - mypy
• Code formatting solution - Ruff
• Package manager - Python Dependency Management
• License - MIT

---

Objectives Satisfied :

✅ Template git repo is created
✅ “Hello World” program main.py
✅ A test in the repo asserting 2 + 2 == 4 test_1.py
✅ A Circle CI pipeline that executes the test config.yml
✅ A comprehensive README.md file
✅ An appropriate .gitignore .gitignore
✅ An appropriate license MIT License
✅ Created two components backend and hw1 that interact with each other.
✅ Created an issue and pull request template.