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

rename requirements-txt and requirements-txt-dev #609

Merged
merged 22 commits into from
Mar 24, 2024
Merged

Conversation

fpgmaas
Copy link
Owner

@fpgmaas fpgmaas commented Mar 16, 2024

Rename requirements-txt and requirements-txt-dev to requirements-file and requirements-file-dev

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!
  • Documentation in docs is updated

Description of changes

This PR proposes to rename requirements-txt and requirements-txt-dev to requirements-files and requirements-files-dev. If users still use the old parameters, they will be shown a deprecation warning:

Warning: In an upcoming release, support for the --requirements-txt command-line option and the requirements_txt configuration parameter will be discontinued. Instead, use --requirements-files or requirements_files under the [tool.deptry] section in pyproject.toml.

@fpgmaas fpgmaas linked an issue Mar 16, 2024 that may be closed by this pull request
@fpgmaas fpgmaas marked this pull request as draft March 16, 2024 18:28
Copy link

codecov bot commented Mar 17, 2024

Codecov Report

Attention: Patch coverage is 96.29630% with 1 lines in your changes are missing coverage. Please review.

Project coverage is 91.3%. Comparing base (e5ca1a7) to head (d9de39c).

Files Patch % Lines
python/deptry/core.py 75.0% 1 Missing ⚠️
Additional details and impacted files
@@           Coverage Diff           @@
##            main    #609     +/-   ##
=======================================
+ Coverage   90.7%   91.3%   +0.5%     
=======================================
  Files         33      34      +1     
  Lines        986     996     +10     
  Branches     198     202      +4     
=======================================
+ Hits         895     910     +15     
+ Misses        74      69      -5     
  Partials      17      17             

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

@fpgmaas fpgmaas marked this pull request as ready for review March 17, 2024 08:55
@mkniewallner mkniewallner added this to the 0.15 milestone Mar 18, 2024
@fpgmaas fpgmaas mentioned this pull request Mar 21, 2024
4 tasks
Copy link
Collaborator

@mkniewallner mkniewallner left a comment

Choose a reason for hiding this comment

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

A few nit comments, but this mostly looks good to me. Just wondering if we should not name the parameters requirements-files and requirements-files-dev since they are lists.

docs/usage.md Outdated Show resolved Hide resolved
python/deptry/cli.py Outdated Show resolved Hide resolved
python/deptry/deprecate/requirements_txt.py Outdated Show resolved Hide resolved
python/deptry/deprecate/requirements_txt.py Outdated Show resolved Hide resolved
@fpgmaas
Copy link
Owner Author

fpgmaas commented Mar 24, 2024

A few nit comments, but this mostly looks good to me. Just wondering if we should not name the parameters requirements-files and requirements-files-dev since they are lists.

Good idea. I was doubting about this a bit, since deptry . --requirements-files requirements.txt feels less intuitive than deptry . --requirements-file requirements.txt, and most projects likely have a single requirements file. But on the other hand, it is correct since it accepts a list. So let's change it to plural.

docs/usage.md Outdated Show resolved Hide resolved
docs/usage.md Outdated Show resolved Hide resolved
docs/usage.md Outdated Show resolved Hide resolved
python/deptry/dependency_getter/requirements_files.py Outdated Show resolved Hide resolved
python/deptry/dependency_getter/requirements_files.py Outdated Show resolved Hide resolved
python/deptry/dependency_getter/requirements_files.py Outdated Show resolved Hide resolved
fpgmaas and others added 2 commits March 24, 2024 10:13
@fpgmaas fpgmaas enabled auto-merge (squash) March 24, 2024 10:24
@fpgmaas fpgmaas merged commit 4f697a1 into main Mar 24, 2024
29 checks passed
@fpgmaas fpgmaas deleted the requirements-file branch March 24, 2024 10:45
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.

Better support of projects that use uv + requirements.in
2 participants