El proyecto fue empaquetado con poetry para manejar dependencias cómodamente. Puede seguir la guía de instalación para instalar la herramienta.
Para instalar el paquete, sus dependencias, y las dependencias de desarrollo, debe ejecutar el siguiente comando:
poetry installEl proyecto usa pre-commit para correr diferentes linters, formateadores, la suite de tests, y otros hook. Para instalar los hooks, se deben ejecutar los siguientes comandos:
poetry run pre-commit install
poetry run pre-commit install -t pre-pushEl proyecto sigue PEP8.
Si se instalaron los hooks de pre-commit, no debiera ser una preocupación esta sección. Varios de los hooks se encargan de arreglar el código o advertir sobre errores de estilo. Se usan los siguientes hooks:
- black:
An opinionated code formatting tool that ensures consistency across all projects using it - mypy:
A static type checker for Python - pylint:
A source code, bug and quality checker
El proyecto utiliza la guía de estilos de google para docstrings.
El proyecto utiliza SemVer. El manejo de versiones se hace a través de poetry. Para subir la versión del paquete el comando es poetry version <patch|minor|major>.
El archivo CHANGELOG.md mantiene un log de los cambios relevantes del proyecto, siguiendo la guía de Keep a Changelog.
Para generar los diagramas a través de pyreverse y guardarlos en el lugar correspondiente:
poetry run pyreverse lazarus -o png
mv classes.png informe/images/classes.png
mv packages.png informe/images/packages.png