Elgato_dark/python-tuf
1
0
Fork 0
mirror of https://github.com/theupdateframework/python-tuf synced 2026-05-24 10:08:28 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Use a working example in the overview section

Browse source 
Some users will actually attempt to execute the example listed in the overview section.  Use a working example that doesn't raise an error.

Signed-off-by: Vladimir Diaz <vladimir.v.diaz@gmail.com>
This commit is contained in:
Vladimir Diaz 2018-06-21 11:19:59 -04:00
parent 965e121148
commit fbc02d3034
No known key found for this signature in database
GPG key ID: 5DEE9B97B0E2289A
1 changed files with 6 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
docs/TUTORIAL.md
View file

@ -35,11 +35,11 @@ software repository is the focus of this tutorial. There is also separate
document that [demonstrates how TUF protects against malicious
updates](../tuf/ATTACKS.md).
The [repository tool](../tuf/repository_tool.py) contains functions to generate all of
the files needed to populate and manage a TUF repository. The tool may either
be imported into a Python module, or used with the Python interpreter in
interactive mode. For instance, here is an example of loading a TUF repository
in interactive mode:
The [repository tool](../tuf/repository_tool.py) contains functions to generate
all of the files needed to populate and manage a TUF repository. The tool may
either be imported into a Python module, or used with the Python interpreter in
interactive mode. For instance, here is an example of initializing a TUF
repository in interactive mode:
```Bash
$ python
@ -47,7 +47,7 @@ Python 2.7.3 (default, Sep 26 2013, 20:08:41)
[GCC 4.6.3] on linux2
Type "help", "copyright", "credits" or "license" for more information.
>>> from tuf.repository_tool import *
>>> repository = load_repository("path/to/repository")
>>> repo = create_new_repository("my_repo")
```
A repository object that encapsulates the metadata files of the repository can