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

docs: better showcase supported dependency managers #895

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

mkniewallner
Copy link
Collaborator

@mkniewallner mkniewallner commented Oct 16, 2024

PR Checklist

  • A description of the changes is added to the description of this PR.
  • If there is a related issue, make sure it is linked to this PR.
  • If you've fixed a bug or added code that should be tested, add tests!
  • If you've added or modified a feature, documentation in docs is updated

Description of changes

With the recent implementation of PEP 735 dependency groups (and the upcoming setuptools dynamic dependencies one), the dependencies extraction documentation became even more cluttered that it was.

Having a dedicated documentation that lists supported dependency managers would make things way more readable for users, and makes it possible to provide clear examples that explain how deptry extracts dependencies for each manager.

Copy link

codecov bot commented Oct 16, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.4%. Comparing base (1210c0d) to head (77e884b).

Additional details and impacted files
@@          Coverage Diff          @@
##            main    #895   +/-   ##
=====================================
  Coverage   92.4%   92.4%           
=====================================
  Files         37      37           
  Lines        994     994           
  Branches      96      96           
=====================================
  Hits         919     919           
  Misses        60      60           
  Partials      15      15           

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

@mkniewallner mkniewallner force-pushed the docs/better-showcase-supported-dependency-managers branch from c96871b to f4bada4 Compare October 16, 2024 07:05
@mkniewallner mkniewallner force-pushed the docs/better-showcase-supported-dependency-managers branch 3 times, most recently from d046ea4 to 902d1dc Compare October 16, 2024 20:56
@mkniewallner mkniewallner force-pushed the docs/better-showcase-supported-dependency-managers branch from 902d1dc to 77e884b Compare October 16, 2024 21:01
@mkniewallner mkniewallner marked this pull request as ready for review October 16, 2024 21:02
]
```

### Setuptools
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This section depends on #894 being merged. If it takes more time than expected to get it merged, we can remove the section entirely in this PR.

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.

1 participant