diff options
Diffstat (limited to 'python/README.md')
| -rw-r--r-- | python/README.md | 34 |
1 files changed, 22 insertions, 12 deletions
diff --git a/python/README.md b/python/README.md index 8f252512..9b244e2d 100644 --- a/python/README.md +++ b/python/README.md @@ -1,5 +1,26 @@ -## Python Web Interface +## 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`). + +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 + +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. + +To re-generate swagger-codegen python client library (requires docker installed +locally): + + ./codegen_python_client.sh + +## Web Interface This project uses `pipenv` to manage dependencies, and assumes Python 3.5 (which pipenv may install if you are running a different local version). You @@ -13,17 +34,6 @@ server on the same machine by default), use: # will listen on http://localhost:9810 by default pipenv run fatcat_webface.py -## Python Client Library - -An 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. - -To re-generate swagger-codegen python client library (requires docker installed -locally): - - ./codegen_python_client.sh - ## Running Tests Many (though not all) python tests depend on access to a local running API |