Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rcmdnk/python-template
Template for python project using poetry
https://github.com/rcmdnk/python-template
Last synced: about 1 month ago
JSON representation
Template for python project using poetry
- Host: GitHub
- URL: https://github.com/rcmdnk/python-template
- Owner: rcmdnk
- License: apache-2.0
- Created: 2023-01-10T15:23:27.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-30T08:14:08.000Z (7 months ago)
- Last Synced: 2024-05-01T12:24:45.580Z (7 months ago)
- Language: Shell
- Size: 533 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# python-template
Template for python project using poetry. abc.
This **README.md** will be overwritten by **setup.sh**.
[](https://github.com/rcmdnk/python-template/actions/workflows/test.yml)
[](https://github.com/rcmdnk/python-template/tree/coverage)
## Repository initialization
Modify the repository info in **setup.sh** if necessary:
| Value | Explanation | Default |
| :-------- | :------------------------------------------------------------------------------------------------------------------------------------ | :---------------------------- |
| `py_ver` | Python version. Multiple versions can be set as comma separated value like "3.10,3.9,3.8". | "3.10" |
| `py_main` | Main python version used by GitHub Actions. | The first version in `py_ver` |
| `os` | OS on which GitHub Actions job runs. Multiple OS can be set as comma separated value like "ubuntu-latest,macos-latest,windows-latest" | "ubuntu-latest" |
| `os_main` | Main OS used by GitHub Actions. | The first OS in `os` |
| `user` | User name in **pyproject.toml** and **LICCENSE**. | `git config --get user.name` |
| `email` | Email address in **pyproject.toml**. | `git config --get user.email` |
| `cli` | Set `yes` to create a template for command line interface. | "no" |
Run `setup.sh`.
## The repository features
The repository has following features:
- Environment management with [Poetry](https://python-poetry.org/).
- Code check/lint with [pre-commit](https://pre-commit.com/).
- For Python
- [Black](https://black.readthedocs.io/en/stable/)
- [Flake8](https://flake8.pycqa.org/en/latest/) (actually, [pyproject-flake8](https://pypi.org/project/pyproject-flake8/) is used to read options from pyproject.toml)
- [isort](https://pycqa.github.io/isort/)
- [mypy](https://www.mypy-lang.org/)
- For shell script
- [ShellCheck](https://www.shellcheck.net/)
- For Markdown
- [mdformat](https://mdformat.readthedocs.io/en/stable/)
- And other small checks including YAML/JSON/TOML checks.
- All packages instead of **pre-commit-hooks** are managed by Poetry (**pyproject.toml**).
- Most of options are managed by **pyproject.toml**.
- Tests using [pytest](https://docs.pytest.org/).
- [pytest-xdist](https://pytest-xdist.readthedocs.io/en/latest/) is used for the parallel test.
- Automatic tests with [GitHub Actions](https://github.co.jp/features/actions).
- Generate coverage results in coverage branch (made for `py_main` and `os_main`).
- Package version check/update with [Renovate](https://docs.renovatebot.com/).
- To enable renovate, you need to [install Renovate into your repository](https://docs.renovatebot.com/getting-started/installing-onboarding/).
- The example of the renovate.json is given in this template.
- .gitignore for Python