Python Project Template 🐍

A template to kick-start your open-source Python project.

Installation

From Source

git clone https://github.com/aniketmaurya/python-project-template.git
cd python-project-template
pip install .

Development Installation

git clone https://github.com/aniketmaurya/python-project-template.git
cd python-project-template
pip install -e ".[dev]"

Usage

from python_project_template import do_something_awesome

print(do_something_awesome())

Features

• 🚀 Modern Python project structure
• 📦 Pre-configured setup.py and pyproject.toml
• 🧪 Testing setup with pytest
• 👷 CI/CD with GitHub Actions
• 📝 Auto-generated documentation
• 🎯 Type hints and static type checking
• 🔍 Code formatting with black and isort
• 🐛 Linting with flake8

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

Development

1. Clone the repository

git clone https://github.com/aniketmaurya/python-project-template.git
cd python-project-template

2. Create a virtual environment

python -m venv venv
source venv/bin/activate  # On Windows, use `venv\Scripts\activate`

3. Install development dependencies

pip install -e ".[dev]"

Running Tests

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 - Feel free to use this template for your projects!