1919 </a >
2020</p >
2121
22-
2322<p align =" center " >
2423 <a href =" https://github.com/codespaces/badge.svg)](https://codespaces.new/aniketmaurya/python-project-template?template=false " >
2524 <img src="https://github.com/codespaces/badge.svg" alt="Open in GitHub Codespaces">
2625 </a >
2726</p >
2827
28+ # Features
2929
30+ - π Modern Python project structure
31+ - π¦ Pre-configured [ pyproject.toml] ( pyproject.toml )
32+ - π€ ML server template with [ LitServe] ( https://github.com/Lightning-AI/LitServe )
33+ - π§ͺ Testing setup with [ pytest] ( https://docs.pytest.org/en/latest/ )
34+ - π· CI/CD with [ GitHub Actions] ( https://github.com/aniketmaurya/python-project-template/blob/main/.github/workflows )
35+ - π Auto-generated documentation
36+ - π― Type hints and static type checking
37+ - π Code formatting with ruff and isort
38+ - π Linting with ruff
39+
40+ # Project Structure
41+
42+ ```
43+ python-project-template/
44+ βββ .github/
45+ β βββ workflows/ # GitHub Actions workflows
46+ βββ docs/ # Documentation
47+ βββ src/ # Source code
48+ β βββ python_project_template/
49+ βββ tests/ # Test files
50+ βββ .gitignore
51+ βββ LICENSE
52+ βββ README.md
53+ βββ pyproject.toml # Project metadata and dependencies
54+ βββ setup.py # Package installation
55+ ```
3056
3157# Installation
3258
3359## From Source
60+
3461``` bash
3562git clone https://github.com/aniketmaurya/python-project-template.git
3663cd python-project-template
3764pip install .
3865```
3966
4067## Development Installation
68+
4169``` bash
4270git clone https://github.com/aniketmaurya/python-project-template.git
4371cd python-project-template
4472pip install -e " .[dev]"
4573```
4674
47- # Usage
75+ ## Usage
4876
4977``` python
5078from python_project_template import do_something_awesome
5179
5280print (do_something_awesome())
5381```
5482
55- # Features
56-
57- - π Modern Python project structure
58- - π¦ Pre-configured setup.py and pyproject.toml
59- - π§ͺ Testing setup with pytest
60- - π· CI/CD with GitHub Actions
61- - π Auto-generated documentation
62- - π― Type hints and static type checking
63- - π Code formatting with black and isort
64- - π Linting with flake8
65-
66- # Project Structure
67-
68- ```
69- python-project-template/
70- βββ .github/
71- β βββ workflows/ # GitHub Actions workflows
72- βββ docs/ # Documentation
73- βββ src/ # Source code
74- β βββ python_project_template/
75- βββ tests/ # Test files
76- βββ .gitignore
77- βββ LICENSE
78- βββ README.md
79- βββ pyproject.toml # Project metadata and dependencies
80- βββ setup.py # Package installation
81- ```
82-
8383# Development
8484
85851 . Clone the repository
86+
8687``` bash
8788git clone https://github.com/aniketmaurya/python-project-template.git
8889cd python-project-template
8990```
9091
91922 . Create a virtual environment
93+
9294``` bash
9395python -m venv venv
9496source venv/bin/activate # On Windows, use `venv\Scripts\activate`
9597```
9698
97993 . Install development dependencies
100+
98101``` bash
99102pip install -e " .[dev]"
100103```
@@ -105,7 +108,7 @@ pip install -e ".[dev]"
105108pytest tests/
106109```
107110
108- ## Contributing
111+ # Contributing
109112
110113Contributions are always welcome! Here's how you can help:
111114
0 commit comments