This projet uses Hach to manage the development environment.
➢ To install the development environment, run:
hatch env createSee hatch env create documentation
This command will create a virtual environment and install the development dependencies.
NOTE:
hatchcreates a virtual environment in the~/.local/share/hatch/env/virtual/antares-study-versiondirectory.
➢ To activate the virtual environment, run:
hatch shellSee hatch shell documentation
This command will spawn a new shell with the virtual environment activated. Use Ctrl+D to exit the shell.
NOTE: this command will display the full path to the virtual environment. You can use it to configure PyCharm or Visual Studio Code to use this virtual environment.
➢ To format and lint the source code with ruff, run:
hatch fmtSee hatch fmt documentation
➢ To run the tests on the current Python version, run:
hatch run testSee hatch run documentation
➢ To run the tests on Python 3.12, for example, run:
hatch run all.py3.12:test➢ To generate the test coverage report, run:
hatch run covThis command will run the unit tests and generate a coverage report in the htmlcov directory.
➢ To check the typing with mypy, run:
hatch run types:check➢ To check the typing on unit tests, run:
hatch run types:check-tests➢ To prepare the documentation environment, run:
hatch env create docs➢ To generate the documentation with mkdocs, run:
hatch run docs:buildThis command will generate the documentation in the site directory.
➢ To serve the documentation locally, run:
hatch run docs:serveThis command will start a local web server to serve the documentation at http://127.0.0.1:8000/.
➢ To build the package, run:
hatch buildThis command will create a dist directory with the built package.
➢ To build the package and upload it to PyPI, run:
hatch publish➢ To clean the project, run:
hatch cleanThis command will remove the dist directory.