https://github.com/greenbone/python-project-template
Python Project Template
https://github.com/greenbone/python-project-template
base devops documentation python
Last synced: 12 months ago
JSON representation
Python Project Template
- Host: GitHub
- URL: https://github.com/greenbone/python-project-template
- Owner: greenbone
- License: agpl-3.0
- Created: 2021-07-05T12:34:22.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-04-15T07:01:34.000Z (almost 2 years ago)
- Last Synced: 2024-04-17T16:11:17.759Z (almost 2 years ago)
- Topics: base, devops, documentation, python
- Language: Python
- Homepage:
- Size: 761 KB
- Stars: 2
- Watchers: 10
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# python-project-template
Python Project Template
## Table of Contents
- [Requirements](#requirements)
- [Development](#development)
- [Maintainer](#maintainer)
- [License](#license)
## Requirements
Python 3.9 and later is supported.
## Development
**example** uses [poetry] for its own dependency management and build
process.
First install poetry via [pipx]
python3 -m pipx install poetry
Afterwards run
poetry install
in the checkout directory of **example** (the directory containing the
`pyproject.toml` file) to install all dependencies including the packages only
required for development.
Afterwards activate the git hooks for auto-formatting and linting via
[autohooks].
poetry run autohooks activate
Validate the activated git hooks by running
poetry run autohooks check
## Maintainer
This project is maintained by [Greenbone AG][Greenbone]
## License
Copyright (C) 2024 [Greenbone AG][Greenbone]
Licensed under the [GNU Affero General Public License v3.0 or later](LICENSE).
[Greenbone]: https://www.greenbone.net/
[poetry]: https://python-poetry.org/
[pip]: https://pip.pypa.io/
[pipx]: https://pypa.github.io/pipx/
[autohooks]: https://github.com/greenbone/autohooks