https://github.com/aleasoluciones/pydevlib
🛠️ 🐍 Alea Soluciones development utils & scripts meant to be used in Python projects
https://github.com/aleasoluciones/pydevlib
black formatter githook library mamba pylint python3 typechecker
Last synced: 3 months ago
JSON representation
🛠️ 🐍 Alea Soluciones development utils & scripts meant to be used in Python projects
- Host: GitHub
- URL: https://github.com/aleasoluciones/pydevlib
- Owner: aleasoluciones
- Created: 2019-11-05T12:56:18.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2025-10-31T07:07:32.000Z (6 months ago)
- Last Synced: 2025-10-31T09:10:10.081Z (6 months ago)
- Topics: black, formatter, githook, library, mamba, pylint, python3, typechecker
- Language: Python
- Homepage:
- Size: 93.8 KB
- Stars: 0
- Watchers: 13
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 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