https://github.com/aniketmaurya/python-project-template
A template to kick-start your Python project ✨🚀
https://github.com/aniketmaurya/python-project-template
litserve packaging-python pip python python3 ruff
Last synced: about 1 month ago
JSON representation
A template to kick-start your Python project ✨🚀
- Host: GitHub
- URL: https://github.com/aniketmaurya/python-project-template
- Owner: aniketmaurya
- License: mit
- Created: 2021-09-04T12:28:23.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-12-27T23:21:56.000Z (5 months ago)
- Last Synced: 2025-03-25T09:49:23.292Z (about 2 months ago)
- Topics: litserve, packaging-python, pip, python, python3, ruff
- Language: Python
- Homepage: https://aniketmaurya.github.io/python-project-template/
- Size: 615 KB
- Stars: 51
- Watchers: 2
- Forks: 8
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
Python Project Template 🐍
A template to kick-start your open-source Python project.
# Features
- 🚀 Modern Python project structure
- 📦 Pre-configured [pyproject.toml](pyproject.toml)
- 🤖 ML server template with [LitServe](https://github.com/Lightning-AI/LitServe)
- 🧪 Testing setup with [pytest](https://docs.pytest.org/en/latest/)
- 👷 CI/CD with [GitHub Actions](https://github.com/aniketmaurya/python-project-template/blob/main/.github/workflows)
- 📝 Auto-generated documentation
- 🎯 Type hints and static type checking
- 🔍 Code formatting with ruff and isort
- 🐛 Linting with ruff
# Project Structure
```
python-project-template/
├── .github/
│ └── workflows/ # GitHub Actions workflows
├── docs/ # Documentation
├── src/ # Source code
│ └── python_project_template/
├── tests/ # Test files
├── .gitignore
├── LICENSE
├── README.md
├── pyproject.toml # Project metadata and dependencies
└── setup.py # Package installation
```
# Installation
## From Source
```bash
git clone https://github.com/aniketmaurya/python-project-template.git
cd python-project-template
pip install .
```
## Development Installation
```bash
git clone https://github.com/aniketmaurya/python-project-template.git
cd python-project-template
pip install -e ".[dev]"
```
## Usage
```python
from python_project_template import do_something_awesome
print(do_something_awesome())
```
# Development
1. Clone the repository
```bash
git clone https://github.com/aniketmaurya/python-project-template.git
cd python-project-template
```
2. Create a virtual environment
```bash
python -m venv venv
source venv/bin/activate # On Windows, use `venv\Scripts\activate`
```
3. Install development dependencies
```bash
pip install -e ".[dev]"
```
## Running Tests
```bash
pytest tests/
```
# Contributing
Contributions are always welcome! Here's how you can help:
1. Fork the repository
2. Create a new branch (`git checkout -b feature/amazing-feature`)
3. Make your changes
4. Commit your changes (`git commit -m 'Add some amazing feature'`)
5. Push to the branch (`git push origin feature/amazing-feature`)
6. Open a Pull Request
Please make sure to update tests as appropriate and follow the existing coding style.
# License
[MIT](https://choosealicense.com/licenses/mit/) - Feel free to use this template for your projects!
](https://codespaces.new/aniketmaurya/python-project-template?template=false){kind=icon}