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
11 Oct 11, 2022
4.9k Jan 02, 2023
3 Oct 14, 2022
2 Nov 13, 2022
4 Dec 14, 2022
12 Mar 01, 2021
1 Jul 16, 2021
10 Jan 23, 2022
1 Jan 10, 2022
1 Jan 10, 2022
154 Jan 06, 2023
5 Jun 19, 2022
10 Jun 05, 2022
1 Jan 09, 2022
13 Nov 27, 2022
1.2k Jan 06, 2023
2 Dec 24, 2021
104 Dec 07, 2022
275 Jan 02, 2023
3 Nov 16, 2022