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

Relax version requirement for argcomplete #31

Merged
merged 1 commit into from
Mar 19, 2021
Merged

Relax version requirement for argcomplete #31

merged 1 commit into from
Mar 19, 2021

Conversation

dadada
Copy link
Contributor

@dadada dadada commented Mar 15, 2021

This change is motivated by dadada/nixpkgs@482a1e9 . Overriding dependencies would be considered bad practice and I'd like to avoid it if possible.

@tstehr
Copy link
Owner

tstehr commented Mar 16, 2021

Would argcomplete>=1.10.0,<2.0.0 also work for you? This wouldn't force current users to update argcomplete and possibly create conflicts with other installed packages. It should still allow you to depend on a current version in your package.

Also, thank you for your packaging effort 👍 If I read the nix file correctly I should tag a v4.0.6 once the versioning problems are resolved, correct? Let me know if there's anything else you need!

@dadada
Copy link
Contributor Author

dadada commented Mar 16, 2021

Thank you for the quick reply! argcomplete>=1.10.0,<2.0.0 works fine for me, if it works for RecipeMD.
If you'd publish a new release that relaxes the dependencies for argcomplete and yarl #30 a bit, that would be ideal for nixpkgs.

Technically, another possibility would be to override the version of the argcomplete package in nixpkgs, but just for builds of RecipeMD, but I'm not sure what the policy is on that. Just to be clear, this change is not part of nixpkgs, yet, and would only be included if you, as the maintainer of the upstream project, give their consent.

The usual way for nixpkgs would be to fetch the release from pypi.org, if this is the official release channel of the project. Then the module is build and the tests are run (see the pytestCheckHook). One thing I came across when packaging RecipeMD was that the test data is not part of the distribution on PyPi, but the test cases are. This unfortunately means that the included tests fail, if you run them (e.g. with pip install --install-option test). Fetching the last release tag from GitHub is currently a bit of a work-around, but should work fine. Would it be possible to include the test data into the distribution on PyPi?

@dadada dadada changed the title Update argcomplete to ~=1.12.0 Relax version requirement for argcomplete Mar 16, 2021
@tstehr
Copy link
Owner

tstehr commented Mar 19, 2021

If you'd publish a new release that relaxes the dependencies for argcomplete and yarl #30 a bit, that would be ideal for nixpkgs.

I'll do that once I've figured out what to do about the test data.

Just to be clear, this change is not part of nixpkgs, yet, and would only be included if you, as the maintainer of the upstream project, give their consent.

I'll give my consent for that right now :) With the caveat that since I'm not a nix user I'll not be able to work on the formula itself. But I'm very willing to review PRs or make changes to recipemd to accommodate packaging needs.

The usual way for nixpkgs would be to fetch the release from pypi.org, if this is the official release channel of the project.

This would also be my preferred approach. Relying on the tags in this repo feels a little flakey, since I currently add these manually and there is no automated check that the tagged version actually matches the released version.

One thing I came across when packaging RecipeMD was that the test data is not part of the distribution on PyPi, but the test cases are. […] Would it be possible to include the test data into the distribution on PyPi?

I'll look into it, tracking in #32

@tstehr tstehr merged commit bda787f into tstehr:master Mar 19, 2021
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.

None yet

2 participants