Python Template Repository
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 v3.11.x
- Testing Framework: unittest
- Continuous Integration: GitHub Actions
- Static Analysis: Flake8
- Code Formatting: Black
- Package Manager: pip
- License: MIT License
Getting Started
To use this template for your Python project, follow these steps:
-
Fork this repository: Click the "Fork" button at the top right of this page to create a copy of this template repository in your GitHub account.
-
Clone your fork: Use
git clone
to clone the repository to your local machine:git clone https://github.com/kimonk0299/python-template.git
-
Set up virtual environment:
python -m venv .venv source .venv/bin/activate
-
Install Dependencies:
pip install -r requirements.txt
-
Add your files to
src/
and unit tests totests/
-
Format code:
black .
-
Run static analysis:
flake8
-
Run tests:
python -m unittest discover -s tests
-
Push code on GitHub to run CI tests on GitHub Actions