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

Document constraints.txt usage. #585

Merged
merged 5 commits into from Aug 25, 2017
Merged

Conversation

@loechel
Copy link
Contributor

@loechel loechel commented Aug 23, 2017

I have documented the corresponding constrains.txt usage with tox, as it work similar to requirements.txt but was not documented.

Here's a quick checklist of what we'd like you to think off:

  • Add yourself to CONTRIBUTORS;
  • make a descriptive Pull Request text (it will be used for changelog)

.. versionadded:: 1.6.1

(experimental) If you have a ``constrains.txt`` file you can add it to your ``deps``varaiable like this::

This comment has been minimized.

@obestwalter

obestwalter Aug 23, 2017
Member

typo: varaiable


(experimental) If you have a ``constrains.txt`` file you can add it to your ``deps``varaiable like this::

deps = constrains.txt

This comment has been minimized.

@obestwalter

obestwalter Aug 23, 2017
Member

This would have to be deps = -cconstrains.txt

@obestwalter
Copy link
Member

@obestwalter obestwalter commented Aug 23, 2017

Hi @loechel thanks for the PR. I guess you mean this: https://pip.pypa.io/en/stable/user_guide/#constraints-files?

If yes: this is nothing that is implemented as such - it is basically a side effect of the way how deps is implemented. deps passes the -<someflag>whatever.txt through to pip, so you can theoretically use any flag that would make sense to pip there.

Maybe it would be better to explain that in above section documenting -r that mentions that it is also possible to pass e.g. the -c flag with a constraints file?

@obestwalter obestwalter changed the title Document constrains.txt usage. Document constraints.txt usage. Aug 23, 2017
CHANGELOG Outdated
@@ -9,6 +9,7 @@ Not released yet
- #518: Forward `USERPROFILE` by default on Windows.
- #515: Don't require environment variables in test environments
where they are not used.
- : Add documentation for constrains.txt

This comment has been minimized.

@obestwalter

obestwalter Aug 23, 2017
Member

s/constrains/constraints/g

@loechel
Copy link
Contributor Author

@loechel loechel commented Aug 23, 2017

@obestwalter thanks for the feedback, I have adjusted the documentation. I hope it is better now and ready to merge.

@obestwalter obestwalter merged commit ddf56be into tox-dev:master Aug 25, 2017
0 of 2 checks passed
0 of 2 checks passed
continuous-integration/appveyor/pr Waiting for AppVeyor build to complete
Details
continuous-integration/travis-ci/pr The Travis CI build is in progress
Details
@loechel loechel deleted the loechel:doc_constrains branch Aug 25, 2017
@obestwalter obestwalter mentioned this pull request Sep 22, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

2 participants