aleasoluciones/pydevlib

🛠️ 🐍 Alea Soluciones development utils & scripts meant to be used in Python projects

pydevlib

Alea Soluciones' development utils & scripts meant to be used in Python 3 projects.

Requirements

You'll need bash as your shell.

Install

Simply run this on your virtualenv:

pip install -e git+https://github.com/aleasoluciones/pydevlib.git#egg=pydevlib

or add this to your requirements-dev.txt (recommended) to make it persistent:

-e git+https://github.com/aleasoluciones/pydevlib.git#egg=pydevlib

Usage

Once the module is installed, you can simply run

pydevlib

to list available commands. Actually, the commands list is:

mambo -> Alias for mamba -f documentation
git_hooks -> Install pre-commit and pre-push git hooks
linter -> Run pylint for production and specs code
type_checker -> Run MyPY for production and specs code to perform static type checking
formatter -> Run Black to format python code
focused_specs -> Search for focused specs across the code
unit_tests -> Run unit tests
factory_tests -> Run factory tests
integration_tests -> Run integration tests
functional_tests -> Run functional tests
acceptance_tests -> Run acceptance tests
regression_tests -> Run regression tests
fast_tests -> Run all fast tests (unit, factory and integration tests)
all_tests -> Run all tests but acceptance tests (unit, factory, integration and functional tests)

The way you can use the commands is simply like this:

git_hooks

For scripts that may accept arguments, you can do:

linter staged
formatter your_file another_file
unit_tests doc

Development

Simply clone this repository and run the following in a virtual environment:

dev/setup_venv.sh

TODO

• Document virtualenv path to be searched is the default repository name
• Document special script cases
• Unify functional test across projects
• Add a command to list the installed python development libraries with a link to documentation