mirror of
https://github.com/theupdateframework/python-tuf
synced 2026-05-24 10:08:28 +00:00
e32beb5845
Add .rst source files for building documentation with 'sphinx'. The two mandatory files are conf.py containing the build configuration and the master doc file index.rst. Sphinx uses 'autodoc' to automatically include docstrings. 'autodoc' imports the modules and needs TUF installed in the environment. The following command will generate the documentation from the source files in an html format: `sphinx-build -b html docs/sphinx/source docs/sphinx/build/html` Signed-off-by: Teodora Sechkova <tsechkova@vmware.com>
31 lines
No EOL
1.1 KiB
ReStructuredText
31 lines
No EOL
1.1 KiB
ReStructuredText
Modern implementation
|
|
=====================
|
|
|
|
The reference implementation is being refactored using
|
|
`modern Python <https://github.com/theupdateframework/tuf/tree/develop/docs/adr/0001-python-version-3-6-plus.md>`_
|
|
to both:
|
|
|
|
* Address scalability and integration issues identified in supporting integration
|
|
into the Python Package Index (PyPI), and other large-scale repositories.
|
|
* Ensure maintainability of the project.
|
|
|
|
This implementation consists of:
|
|
|
|
* a "low-level" metadata API, designed to provide easy and safe access to
|
|
TUF metadata and handle (de)serialization from/to files, provided in the
|
|
:doc:`tuf.api` module.
|
|
|
|
* an implementation of the detailed client workflow built on top of the
|
|
metadata API, provided in the :doc:`tuf.ngclient` module.
|
|
|
|
.. note:: The modern implementation is not considered production ready and
|
|
does not yet provide any high-level support for implementing
|
|
`repository operations <https://theupdateframework.github.io/specification/latest/#repository-operations>`_,
|
|
though the addition of API to support them is planned.
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
:caption: Contents:
|
|
|
|
tuf.api
|
|
tuf.ngclient |