Development

Building from source

This project uses hatch for its management. In a nutshell:

First clone the repository:

git clone 

Build project:

hatch build

It will generate a .whl file in the dist directoy, which can be installed using pip:

pip install dist/eclipse_care-0.0.1-py3-none-any.whl 

Testing

We use pytest for the tests of this project. In conjunction with hatch, you can test the project with a single command line:

hatch test

Example:

% hatch test
============================================ test session starts ============================================
platform darwin -- Python 3.14.0, pytest-9.0.1, pluggy-1.6.0
rootdir: /Users/borisbaldassari/Xork/eclipse/ecare
configfile: pyproject.toml
plugins: mock-3.15.1, xdist-3.8.0, rerunfailures-14.0
collected 1 item

tests/eclipse/care/utils/test_cli_utils.py F                                                          [100%]

================================================= FAILURES ==================================================
_____________________________________________ test_print_error ______________________________________________

    def test_print_error():
>     assert 1 == 2
E     assert 1 == 2

tests/eclipse/care/utils/test_cli_utils.py:7: AssertionError
========================================== short test summary info ==========================================
FAILED tests/eclipse/care/utils/test_cli_utils.py::test_print_error - assert 1 == 2
============================================= 1 failed in 0.05s =============================================

Documentation

We use mkdocs and mkdocstrings for the documentation of this project.

The in-code documentation uses the Numpy docstrings formatting.

Building the documentation website in the site/ directory:

mkdocs build

Starting a server for local development:

mkdocs serve