Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pamelafox/python-project-template
A Github template repository for a Python project with support for Codespaces, devcontainer, and Github Actions.
https://github.com/pamelafox/python-project-template
codespaces devcontainer python python3
Last synced: 12 days ago
JSON representation
A Github template repository for a Python project with support for Codespaces, devcontainer, and Github Actions.
- Host: GitHub
- URL: https://github.com/pamelafox/python-project-template
- Owner: pamelafox
- License: mit
- Created: 2022-10-16T13:20:25.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-07-30T22:33:25.000Z (3 months ago)
- Last Synced: 2024-10-26T10:39:45.942Z (16 days ago)
- Topics: codespaces, devcontainer, python, python3
- Language: Python
- Homepage:
- Size: 37.1 KB
- Stars: 111
- Watchers: 7
- Forks: 26
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: .github/CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Python project template
This is a template repository for any Python project that comes with the following dev tools:
* `ruff`: identifies many errors and style issues (`flake8`, `isort`, `pyupgrade`)
* `black`: auto-formats code
Those checks are run as pre-commit hooks using the `pre-commit` library.
It includes `pytest` for testing plus the `pytest-cov` plugin to measure coverage.
The checks and tests are all run using Github actions on every pull request and merge to main.
This repository is setup for Python 3.11. To change the version:
1. Change the `image` argument in `.devcontainer/devcontainer.json` (see [https://github.com/devcontainers/images/tree/main/src/python](https://github.com/devcontainers/images/tree/main/src/python#configuration) for a list of pre-built Docker images)
1. Change the config options in `.precommit-config.yaml`
1. Change the version number in `.github/workflows/python.yaml`
## Development instructions
## With devcontainer
This repository comes with a devcontainer (a Dockerized Python environment). If you open it in Codespaces, it should automatically initialize the devcontainer.
Locally, you can open it in VS Code with the Dev Containers extension installed.
## Without devcontainer
If you can't or don't want to use the devcontainer, then you should first create a virtual environment:
```
python3 -m venv .venv
source .venv/bin/activate
```
Then install the dev tools and pre-commit hooks:
```
python3 -m pip install --user -r requirements-dev.txt
pre-commit install
```
## Adding code and tests
This repository starts with a very simple `main.py` and a test for it at `tests/main_test.py`.
You'll want to replace that with your own code, and you'll probably want to add additional files
as your code grows in complexity.
When you're ready to run tests, run:
```
python3 -m pytest
```
# File breakdown
Here's a short explanation of each file/folder in this template:
* `.devcontainer`: Folder containing files used for setting up a devcontainer
* `devcontainer.json`: File configuring the devcontainer, includes VS Code settings
* `.github`: Folder for Github-specific files and folders
* `workflows`: Folder containing Github actions config files
* `python.yaml`: File configuring Github action that runs tools and tests
* `tests`: Folder containing Python tests
* `main_test.py`: File with pytest-style tests of main.py
* `.gitignore`: File describing what file patterns Git should never track
* `.pre-commit-config.yaml`: File listing all the pre-commit hooks and args
* `main.py`: The main (and currently only) Python file for the program
* `pyproject.toml`: File configuring most of the Python dev tools
* `README.md`: You're reading it!
* `requirements-dev.txt`: File listing all PyPi packages required for development
* `requirements.txt`: File listing all PyPi packages required for production
For a longer explanation, read [this blog post](http://blog.pamelafox.org/2022/09/how-i-setup-python-project.html).
# 🔎 Found an issue or have an idea for improvement?
Help me make this template repository better by letting us know and opening an issue!