This repository holds those infrastructure-level modules, that every application requires that follows the core 12-factor principles.
Project description
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
License
The scripts and documentation in this project are released under the MIT License
References
Development tools
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for py_12f_common-0.4.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | be09695c52361ce9cb47346c8b2e32b212e3ecec4638838a8d14cc80d0d2ec9c |
|
MD5 | 54f222c95faaee98d48879ca228c2f58 |
|
BLAKE2b-256 | 76417823666e4a85d29020314af92484b5a64d0556697d6c6234b9126a989756 |