SETI / rms-pds4indextools

PDS4 index tools Python module
Apache License 2.0
0 stars 0 forks source link

Add documentation. Add entry point installation. #25

Closed rfrenchseti closed 1 month ago

rfrenchseti commented 1 month ago

Support PyPI-based installation by a user:

To test installation, open a terminal that is unrelated to this project and:

cd <some temporary directory>
python3 -m venv venv
source venv/bin/activate
pip install <dir>/rms-pds4indextools

At this point you should be able to type:

pds4_create_xml_index --help

Add documentation:

cd docs
make html

Miscellaneous

codecov[bot] commented 1 month ago

Codecov Report

Attention: Patch coverage is 40.00000% with 9 lines in your changes missing coverage. Please review.

Project coverage is 72.36%. Comparing base (fc88c40) to head (4c8a0a1). Report is 1 commits behind head on main.

Files Patch % Lines
pds4indextools/pds4_create_xml_index.py 40.00% 8 Missing and 1 partial :warning:
Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #25 +/- ## ========================================== - Coverage 73.22% 72.36% -0.87% ========================================== Files 1 1 Lines 564 579 +15 Branches 128 130 +2 ========================================== + Hits 413 419 +6 - Misses 130 138 +8 - Partials 21 22 +1 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.