aee6e95380
Projects that want to enable a comprehensive doc8 check of code, including D000, need Pygmnets to be installable. It's an option library used by docutils so we need to track it here. While this isn't really a linter, neither is it really required at runtime for the projects using it so it's added to the blacklist Is the library actively maintained? Yes - https://bitbucket.org/birkenfeld/pygments-main Is the library good code? Yes - It is the defacto syntax highlighting code in Python Is the library python 3 compatible? Yes Is the library license compatible? Yes - BSD Is the library already packaged in the distros we target (Ubuntu latest / Fedora latest)? Yes Is the function of this library already covered by other libraries in global-requirements.txt? No Is the library required for OpenStack project or related dev or infrastructure setup? (Answer to this should be Yes, of course) Which? Yes - for doc8 checking where there is code snippets. It is also a transient dependancy of sphinx - https://github.com/sphinx-doc/sphinx/blob/master/setup.py#L21 Change-Id: I643c7632a02c87820c9c51f03fa34f0764384783 Close-bug: #1771479 |
||
|---|---|---|
| .zuul.d | ||
| babel-test | ||
| doc/source | ||
| openstack_requirements | ||
| playbooks | ||
| tools | ||
| .gitignore | ||
| .gitreview | ||
| .testr.conf | ||
| bindep.txt | ||
| blacklist.txt | ||
| detail.py | ||
| global-requirements.txt | ||
| lower-constraints-xfails.txt | ||
| lower-constraints.txt | ||
| MANIFEST.in | ||
| projects.txt | ||
| README.rst | ||
| requirements.txt | ||
| setup.cfg | ||
| setup.py | ||
| test-requirements.txt | ||
| tox.ini | ||
| update.py | ||
| upper-constraints-xfails.txt | ||
| upper-constraints.txt | ||
Global Requirements for OpenStack Projects
Why Global Requirements?
Refer to the Dependency Management section of the Project Team Guide for information about the history of the project and the files involved.
Tools
All the tools require openstack_requirements to be installed (e.g. in a Python virtualenv). They all have help, which is the authoritative documentation.
update-requirements
This will update the requirements in a project from the global
requirements file found in .. Alternatively, pass
--source to use a different global requirements file:
update-requirements --source /opt/stack/requirements /opt/stack/novaEntries in all requirements files will have their versions updated to match the entries listed in the global requirements. Excess entries will cause errors in hard mode (the default) or be ignored in soft mode.
generate-constraints
Compile a constraints file showing the versions resulting from
installing all of global-requirements.txt:
generate-constraints -p /usr/bin/python2.7 -p /usr/bin/python3 \
-b blacklist.txt -r global-requirements.txt > new-constraints.txtedit-constraints
Replace all references to a package in a constraints file with a new specification. Used by DevStack to enable git installations of libraries that are normally constrained:
edit-constraints oslo.db "-e file://opt/stack/oslo.db#egg=oslo.db"Proposing changes
Look at the Review Guidelines and make sure your change meets them.
All changes to global-requirements.txt may dramatically
alter the contents of upper-constraints.txt due to adding
or removing transitive dependencies. As such you should always generate
a diff against the current merged constraints, otherwise your change may
fail if it is incompatible with the current tested constraints.
A change to the minimum specified vesion of a library in
global-requirements.txt currenty requires adjusting the
lower-constraints.txt file alongside with the new
constrainted coinstallable version of minimums.
Regenerating involves five steps.
Install the dependencies needed to compile various Python packages:
sudo apt-get install $(bindep -b)Create a reference file (do this without your patch applied):
generate-constraints -p /usr/bin/python2.7 -p /usr/bin/python3 \ -b blacklist.txt -r global-requirements.txt > baselineApply your patch and generate a new reference file:
generate-constraints -p /usr/bin/python2.7 -p /usr/bin/python3 \ -b blacklist.txt -r global-requirements.txt > updatedDiff them:
diff -p baseline updatedApply the patch to
upper-constraints.txt. This may require some fiddling.edit-constraintcan do this for you when the change does not involve multiple lines for one package.