nyuoss/23-fall-python-template-1

Technology Template Repository for Python

python-template

This is a template repository for Python projects that provides a starting point for designing and developing Python applications. It includes a basic project structure, configuration for continuous integration, static analysis, code formatting, and more. You can use this template as a foundation for your Python projects.

Features

• Programming language: Python
• Runtime environment: Python 3.9
• Testing framework: pytest
• Continuous Integration: GitHub Actions
• Static analysis: flake8
• Code formatting: black
• Package manager: Poetry
• License: MIT

Getting started

1. Click the Use this template button to create a new repository from this template.
2. Clone your new repository to your local machine.

   git clone https://github.com/vchrombie/python-template

3. Install the required dependencies using Poetry.

   poetry install

4. Activate the virtual environment using Poetry.

   poetry shell

5. Run tests using pytest.

   pytest

6. Run static analysis using flake8.

   flake8

7. Run code formatting using black.

   black .

8. Start building your project!
9. You can add the source code of your project to the src directory and tests to the tests directory.
10. Push your changes to the master branch of your repository to trigger a CI build on GitHub Actions.

Team 🅰️

• Carolina Martin
• Jessie Theisen
• Sonia Susanto
• Yamini Lakshmi Narasimhan
• Venu Vardhan Reddy Tekula