python-tuf/docs
Lukas Puehringer 15d1e933a0 Restructure requirements files
* Use suffixed instead of prefixed sub-requirements files to group
  them alphabetically in the file tree.
* Layer requirements files akin to the in-toto project
  (see in-toto/in-toto#294). The hierarchy is:

  - *requirements.in*
    tuf runtime requirements, including optional requirements
    (pynacl and cyrptography)

  - *requirements-pinned.txt*
    pinned tuf runtime requirements, including optional
    and transitive (1 level deep) requirements and their hashes.

    The file is generated semi-automatically using pip-compile
    and a bash script (see document header), based off of
    requirements.in, combining requirements from all supported
    Python versions.

    This file should be auto-updated, by e.g. dependabot, and be used
    for ci/cd tests, to catch issues with new dependencies.

  - *requirements-test.txt*
    additional test runtime requirements

  - *requirements-tox.txt*
    combines requirements.txt, requirements-test.txt and additional
    test tools (for linting and coverage), i.e. everything that is
    needed in each tox environment to run the tests.

  - *requirements-dev.txt*
    lists tox for local development and testing, and also
    requirements-tox.txt and tuf in editable mode to run
    the test suite or individual tests directly.

  - *requirements.txt*
    requirements-pinned.txt with the hashes of the dependencies
    as reported by pip at the time of creating the file.
    NOTE: this is not used for testing or  dev-install because pip
    doesn't allow mixed (with and without hashes) installations.

    This file should also be auto-updated, by e.g. dependabot.

* Removes an obsolete version constraint on coverage

Signed-off-by: Lukas Puehringer <lukas.puehringer@nyu.edu>
2020-02-06 17:35:51 +01:00
..
images Add banner_readme.png 2018-01-23 16:36:51 -05:00
latex Fix some typos in docs 2019-02-25 17:00:26 +07:00
papers Add Mercury paper and entry in README.rst 2017-08-31 10:13:05 -04:00
ADOPTERS.md Add signoff to commit 2019-02-22 09:08:52 +07:00
AUTHORS.txt Explaining GOVERNANCE structure to better match CNCF graduation ask 2018-10-11 10:50:47 -04:00
CHANGELOG.md release: 0.12.2 2020-01-10 15:43:44 -05:00
CLI.md DOC: collapse CLI_EXAMPLES.md into CLI.md 2019-04-08 11:54:10 -04:00
CODE-OF-CONDUCT.md Move docs to the docs/ directory 2018-01-24 10:57:01 -05:00
CONTRIBUTORS.rst Restructure requirements files 2020-02-06 17:35:51 +01:00
GETTING_STARTED.rst DOC: collapse CLI_EXAMPLES.md into CLI.md 2019-04-08 11:54:10 -04:00
GOVERNANCE.md Governance clarifications 2019-11-11 15:51:52 +01:00
INSTALLATION.rst Fix typo in section "Release Verification" 2019-12-20 10:06:44 +01:00
MAINTAINERS.txt Update MAINTAINERS.txt 2019-11-05 09:56:28 -05:00
METADATA.md Update deprecated url 2019-02-21 16:50:19 +07:00
OVERVIEW.rst Update deprecated links in docs 2019-02-26 08:58:59 +07:00
QUICKSTART.md DOC: cover possible environment requirements in QUICKSTART 2019-04-08 15:21:52 -04:00
ROADMAP.md DOC: Update the outdated ROADMAP.md 2019-02-26 11:22:47 -05:00
SECURITY.md Add slow retrieval disclaimer 2019-10-10 16:43:46 +02:00
TAP.rst Move docs to the docs/ directory 2018-01-24 10:57:01 -05:00
tuf-spec.0.9.txt Update link to historical tuf-spec.0.9.txt 2019-09-16 15:43:39 +02:00
tuf-spec.md Edit specifiation files to point to their new location 2017-10-11 15:49:47 -04:00
tuf-spec.txt Edit specifiation files to point to their new location 2017-10-11 15:49:47 -04:00
TUTORIAL.md doc: Revert accidental space deletion in tutorial 2019-12-16 15:16:24 +01:00