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

Update client_setup_and_repository_example.md

Browse source 
Add formatting and reorganize
This commit is contained in:
Vladimir Diaz 2014-07-07 19:24:11 -04:00
parent 20d5a6b3e4
commit e11a87b2ec
1 changed files with 12 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

23
tuf/client_setup_and_repository_example.md
View file

@ -1,28 +1,29 @@
# Client Setup and Repository Example #
## Client Setup and Repository Example ##
The following function creates a directory structure that a client
downloading new software using TUF (via tuf/client/updater.py) will expect.
The "root.json" metadata file must exist, and also the directories that hold the
The `root.json` metadata file must exist, and also the directories that hold the
metadata files downloaded from a repository. Software updaters integrating with
TUF may use this directory to store TUF updates saved on the client side.
create_tuf_client_directory() moves metadata from "path/to/repository/metadata"
to "path/to/client/". The repository in "path/to/repository/" is the repository
created in the "Create TUF Repository" section.
```python
>>> from tuf.repository_tool import *
>>> create_tuf_client_directory("path/to/repository/", "path/to/client/")
```
# Test TUF Locally #
```Bash
# Run the local TUF repository server.
$ cd "path/to/repository/"; python -m SimpleHTTPServer 8001
**create_tuf_client_directory()** moves metadata from `/path/to/repository/metadata`
to `/path/to/client/`. The repository in `/path/to/repository/` may be the repository
example created in the repository tool README.
# Retrieve targets from the TUF repository and save them to "path/to/client/". The
# "basic_client.py" module is available in "tuf/client/".
## Test TUF Locally ##
Run the local TUF repository server.
```Bash
$ cd "path/to/repository/"; python -m SimpleHTTPServer 8001
```
Retrieve targets from the TUF repository and save them to "path/to/client/". The
`basic_client.py` module is available in `tuf/client/`.
In a different command-line prompt . . .
```Bash
$ cd "path/to/client/"