py-12f-common
About
This repository holds those infrastructure-level modules, that every application requires that follows the core 12-factor principles.
Install
Prerequisites
- Python3
- Task
Install Python and module dependencies
Install Python 3, using some virtual environment.
Create and switch to a virtual environment dedicated to this project.
For development, install the package and its dependencies in editable mode, using task:
task install-dev-editable
or directly with the pip command:
pip install -e .[dev] .
NOTE: The task install-... tasks also installs git hooks (e.g. pre-commit). The git hooks are simple bash scripts, that call tasks, for example the pre-commit hook will call the task pre-commit command.
Usage
List the available tasks:
task list
task: Available tasks for this project:
* build-docker: Build docker image
* clean: Clean temporary files and folders
* coverage: Test coverage
* default: Executes all the tests then build the binary.
* docs: Generate module documentation into the docs/ folder
* format: Autoformat the source files
* install: Install the package and its dependencies
* install-dev: Install the package and its dependencies for development
* install-dev-editable: Install the package and its dependencies for development with editablility
* install-git-hooks: Install git hooks
* lint: Run python linter
* pre-commit: Runs the QA tasks from a git pre-commit hook
* test: Run all the tests.
* test-verbose: Run all the go tests.
Run tests:
task test-verbose
912 Jan 5, 2023
44 Nov 15, 2022
243 Dec 30, 2022
17 Dec 17, 2022
9 Jan 7, 2023
15 Oct 14, 2022
2 Oct 18, 2021
1 Oct 22, 2021
1 Nov 2, 2021
1.2k Dec 28, 2022
5 Dec 22, 2022
4 Jun 05, 2022
0 Dec 27, 2021
1 Jan 04, 2022
4 Sep 13, 2021
8 Nov 07, 2021
5 Feb 12, 2022
27 Sep 23, 2022
10 Jun 30, 2022
5 Sep 27, 2021
7 Feb 06, 2022
17 Dec 05, 2022
5 Dec 20, 2022
2 Dec 29, 2021
3 Jun 15, 2022
10 Oct 03, 2021
10 Sep 18, 2022
8 Nov 18, 2021
5 May 13, 2022