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.

Sign up for GitHub

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

Document constraints.txt usage. #585

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
b78b151
document constrains.txt usage.
loechel Aug 23, 2017
5721d68
add myself to contributors
loechel Aug 23, 2017
ffcbd60
add changelog entry
loechel Aug 23, 2017
17802da
correct documentation
loechel Aug 23, 2017
4ef5c22
Merge branch 'master' into doc_constrains
loechel Aug 25, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Copy link
Member

Choose a reason for hiding this comment

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

s/constrains/constraints/g


2.7.0
-----
Expand Down
1 change: 1 addition & 0 deletions CONTRIBUTORS
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,3 +49,4 @@ Nick Douma
Cyril Roelandt
Bartolome Sanchez Salado
Laszlo Vasko
Alexander Loechel
12 changes: 12 additions & 0 deletions doc/example/basic.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,18 @@ All installation commands are executed using ``{toxinidir}``
working directory. Therefore, the underlying ``pip`` installation
will assume ``requirements.txt`` to exist at ``{toxinidir}/requirements.txt``.

defining constrains
-----------------------------------------------

.. versionadded:: 1.6.1

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

Choose a reason for hiding this comment

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

typo: varaiable


deps = constrains.txt
Copy link
Member

Choose a reason for hiding this comment

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

This would have to be deps = -cconstrains.txt


All installation commands are executed using ``{toxinidir}`` (the directory where ``tox.ini`` resides) as the current working directory.
Therefore, the underlying ``pip`` installation will assume ``contrains.txt`` to exist at ``{toxinidir}/contrains.txt``.

using a different default PyPI url
-----------------------------------------------

Expand Down