Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

pgdtools v0.1.0 #43

Merged
merged 21 commits into from
Jul 26, 2024
Merged

pgdtools v0.1.0 #43

merged 21 commits into from
Jul 26, 2024

Conversation

trappitsch
Copy link
Collaborator

This is the first implementation of an actually feasible version. It is far from perfect, but ready for users to hack against it and try to test it out.
The current version contains (some major features):

  • Database download and management section
  • Filtering, data retrieval
  • Information on the database, techniques, and references

The maintainer tools stayed mostly the same.

Still, a bunch of documentation is missing, especially examples in the docstrings. This will come.

Note: The "very early dev version..." warning upon import is gone. Basically all user functionality with that version is broken and does not exist anymore. You have been warned ;)

- remove proxy list
- move inner classes into individual files in their own folders
  - keep pgdtools.py cleaner
  - allow for keeping all files together cleaner
  - use imports in `__init__.py` in `sub_tools`
- Restructure tests to follow along with everything.

There are still a bunch of garbage routines in the files, these will need to be cleaned up next and stuff we don't want deleted.
Technique json file handling added, similar to how we handle the references.
@codecov-commenter
Copy link

Codecov Report

Attention: Patch coverage is 96.96970% with 16 lines in your changes missing coverage. Please review.

Project coverage is 95.90%. Comparing base (2bd2d38) to head (6f3dff9).

Files Patch % Lines
src/pgdtools/pgdtools.py 89.58% 5 Missing ⚠️
src/pgdtools/classify.py 89.65% 3 Missing ⚠️
src/pgdtools/sub_tools/data.py 97.22% 2 Missing ⚠️
src/pgdtools/sub_tools/info.py 96.42% 2 Missing ⚠️
src/pgdtools/sub_tools/utilities.py 95.12% 2 Missing ⚠️
src/pgdtools/sub_tools/format.py 95.65% 1 Missing ⚠️
src/pgdtools/sub_tools/references.py 98.79% 1 Missing ⚠️
Additional details and impacted files
@@             Coverage Diff             @@
##             main      #43       +/-   ##
===========================================
+ Coverage   84.37%   95.90%   +11.52%     
===========================================
  Files          11       19        +8     
  Lines         608      927      +319     
===========================================
+ Hits          513      889      +376     
+ Misses         95       38       -57     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@trappitsch trappitsch merged commit 74c83b9 into main Jul 26, 2024
6 checks passed
@trappitsch trappitsch deleted the pgdtools_first_version branch July 26, 2024 13:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants