Skip to content

rmoralespp/pymince

Repository files navigation

pymince

CI pypi versions codecov license Downloads Code style: black Linter: ruff pre-commit

About

pymince is a collection of useful tools that are "missing" from the Python standard library.

Installation (via pip)

pip install pymince

Documentation

See project documentation for more details.

Development

Build documentation

(env)$ pip install -r requirements-doc.txt   # Ignore this command if it has already been executed
(env)$ python upgrade-doc.py # Upgrade the documentation from the source code
(env)$ mkdocs serve # Start the live-reloading docs server
(env)$ mkdocs build # Build the documentation site

Tests

(env)$ pip install -r requirements-dev.txt   # Ignore this command if it has already been executed
(env)$ pytest tests/
(env)$ pytest --cov pymince # Tests with coverge

License

This project is licensed under the terms of the MIT license.