summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorBryan Newbold <bnewbold@robocracy.org>2019-01-09 11:34:52 -0800
committerBryan Newbold <bnewbold@robocracy.org>2019-01-09 11:34:52 -0800
commit8bd35d2b452cef9d4537e2b84180aad0f43347ac (patch)
tree63c317c9a53f5db2ccab1a943870076881e8f880
parent17db6a45192f817c45cddf9340c681e4a74176f3 (diff)
downloadfatcat-8bd35d2b452cef9d4537e2b84180aad0f43347ac.tar.gz
fatcat-8bd35d2b452cef9d4537e2b84180aad0f43347ac.zip
update READMEs about python client library
-rw-r--r--README.md3
-rw-r--r--python/README.md12
2 files changed, 9 insertions, 6 deletions
diff --git a/README.md b/README.md
index 4c75dffc..6ed45cb1 100644
--- a/README.md
+++ b/README.md
@@ -37,6 +37,9 @@ Internet Archive's internal (not public) infrastructure.
See `./python/README.md` and `./rust/README.md` for details on building,
running, and testing these components.
+The python client library, which is automatically generated from the API
+schema, lives under `./python_client/`.
+
## Status
- SQL and HTTP API schemas
diff --git a/python/README.md b/python/README.md
index 922499f3..2760885c 100644
--- a/python/README.md
+++ b/python/README.md
@@ -1,19 +1,19 @@
## Fatcat Python Code
-This directory contains all python code for the fatcat project: an API client
-library (`fatcat_client`), a web interface (`fatcat_web`), and a series of
-utilities and worker processes (`fatcat_tools`).
+This directory contains python code for the fatcat project: a web interface
+(`fatcat_web`) and a series of utilities and worker processes (`fatcat_tools`).
+These depend on the API client library (`fatcat_client`, see below).
Most of this code is an "application" which is tightly interwoven and intended
to be run from this directory, but the client library is distributed on
pypi.org.
-## Client Library
+## API Client Library
The auto-generated python client library for the fatcat API lives under
-`./fatcat_client`. It includes entity model objects and functions to call all
-API endpoints; see `./README_client.md` for details.
+`../fatcat_client`. It includes entity model objects and functions to call all
+API endpoints; see the `README.md` for details.
To re-generate swagger-codegen python client library (requires docker installed
locally):