Skip to content

Commit

Permalink
Mention retrieval and listing in the README.
Browse files Browse the repository at this point in the history
  • Loading branch information
LTLA committed Apr 25, 2024
1 parent b1cc890 commit a0776bf
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,5 +68,14 @@ import time
sr.query(url, after=time.time() - 3600) # created less than 1 hour ago
```

Once we find a file of interest from a registered directory, we can retrieve its metadata, or other files in the same directory, or the entire directory itself:

```python
sr.retrieve_metadata(mydir + "/metadata.json", url)
sr.list_files(mydir, url)
sr.retrieve_file(mydir + "/diet/metadata.json", url)
sr.retrieve_directory(mydir, url)
```

Check out the [API documentation](https://artifactdb.github.io/SewerRat-py/) for more details on each function.
For the concepts underlying the SewerRat itself, check out the [repository](https://github.com/ArtifactDB/SewerRat) for a detailed explanation.

0 comments on commit a0776bf

Please sign in to comment.