Skip to content

Commit 1ea497a

Browse files
author
Jussi Kukkonen
committed
README: Update descriptions of the provided APIs
* ngclient and Metadata API are production ready: start with them, then mention legacy * link to API reference instead of code * link to examples instead of (legacy) getting started document Signed-off-by: Jussi Kukkonen <[email protected]>
1 parent 89b532d commit 1ea497a

File tree

1 file changed

+17
-25
lines changed

1 file changed

+17
-25
lines changed

README.md

+17-25
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
----------------------------
1010
*__IMPORTANT NOTICE:__ A stable 1.0.0 release of the modern implementation only
1111
is scheduled for January 2022. Please see the [*1.0.0
12-
announcement*](1.0.0-ANNOUNCEMENT.md) page for more details about the release
12+
announcement*](docs/1.0.0-ANNOUNCEMENT.md) page for more details about the release
1313
and the deprecation of the legacy implementation, including migration
1414
instructions.*
1515

@@ -19,31 +19,22 @@ This repository is the **reference implementation** of
1919
It is written in Python and intended to conform to version 1.0 of the
2020
[TUF specification](https://theupdateframework.github.io/specification/latest/).
2121

22-
The repository currently includes two implementations:
23-
1) A *legacy implementation*, with
24-
[`tuf/client/updater.py`](tuf/client/updater.py) implementing the detailed
25-
client workflow and [`tuf/repository_tool.py`](tuf/repository_tool.py)
26-
providing a high-level interface for repository operations.
27-
The legacy implementation is in use in production systems, but is [no longer
28-
being actively worked on](docs/adr/0002-pre-1-0-deprecation-strategy.md).
29-
2) A *modern implementation*. We are in the process of rewriting the reference
30-
implementation in [modern Python](docs/adr/0001-python-version-3-6-plus.md)
31-
to both: a) address scalability and integration issues identified in
32-
supporting integration into the Python Package Index (PyPI), and other
33-
large-scale repositories, and b) to ensure maintainability of the project.
34-
This implementation consists of:
35-
* a "low-level" metadata API, designed to provide easy and safe access to
36-
TUF metadata and handle (de)serialization from/to files, provided in the
37-
[`tuf/api/metadata.py`](tuf/api/metadata.py) module.
38-
* an implementation of the detailed client workflow built on top of the
39-
metadata API, provided in the
40-
[`tuf/ngclient/updater.py`](tuf/ngclient/updater.py) module.
41-
The modern implementation is not considered production ready and does not yet
42-
provide any high-level support for implementing
43-
[repository operations](https://theupdateframework.github.io/specification/latest/#repository-operations),
44-
though the addition of API to support them is planned.
22+
Python-TUF provides two APIs:
23+
* [`tuf.api.metadata`](https://theupdateframework.readthedocs.io/en/latest/api/tuf.api.html),
24+
a "low-level" API, designed to provide easy and safe access to TUF
25+
metadata and to handle (de)serialization from/to files.
26+
* [`tuf.ngclient`](https://theupdateframework.readthedocs.io/en/latest/api/tuf.ngclient.html),
27+
a client implementation built on top of the metadata API.
4528

29+
High-level support for implementing
30+
[repository operations](https://theupdateframework.github.io/specification/latest/#repository-operations)
31+
is planned but not yet provided: see [1.0.0 plans](docs/1.0.0-ANNOUNCEMENT.md).
4632

33+
In addition to these APIs the project also provides a *legacy
34+
implementation* with `tuf.client` implementing the client workflow and
35+
`tuf.repository_tool` providing a high-level interface for repository
36+
operations. The legacy implementation is going to be
37+
[deprecated](docs/1.0.0-ANNOUNCEMENT.md) in the near future.
4738

4839
The reference implementation strives to be a readable guide and demonstration
4940
for those working on implementing TUF in their own languages, environments, or
@@ -75,7 +66,8 @@ Documentation
7566
-------------
7667
* [Introduction to TUF's Design](docs/OVERVIEW.rst)
7768
* [The TUF Specification](https://theupdateframework.github.io/specification/latest/)
78-
* [Getting Started with the TUF Reference Implementation](docs/GETTING_STARTED.rst)
69+
* Examples: [client](examples/client_example) and [repository](examples/repo_example)
70+
* [API Reference](https://theupdateframework.readthedocs.io/)
7971
* [Governance](docs/GOVERNANCE.md) and [Maintainers](docs/MAINTAINERS.txt)
8072
for the reference implementation
8173
* [Miscellaneous Docs](docs/)

0 commit comments

Comments
 (0)