From 572fdc7caf74d9539e642e97855d8c8ba94ff93a Mon Sep 17 00:00:00 2001
From: Bryan Newbold <bnewbold@robocracy.org>
Date: Tue, 13 Nov 2018 12:34:04 -0800
Subject: update python README and TODO

---
 python/README.md | 34 ++++++++++++++++++++++------------
 python/TODO      |  8 +++-----
 2 files changed, 25 insertions(+), 17 deletions(-)

(limited to 'python')

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
diff --git a/python/TODO b/python/TODO
index 7a6eb10f..46fceb69 100644
--- a/python/TODO
+++ b/python/TODO
@@ -1,9 +1,7 @@
 
-Idea for new module structure: refactor 'fatcat_client' into 'fatcat' and have
-that be the general purpose API client. create a new 'fatcat_services' for web
-interface, importers, workers, etc, which depends on the other module.
-potentially, move library module into subdirectory or another top-level folder
-("python-fatcat"? "python-library"?).
+Idea for further module simplification: move codegen'd library into it's own
+directory (with it's own README, tests, etc), and reference it here via
+symlink.
 
 - use dict counter type (in python collections) instead of currently janky counters
 - schema.org metadata for releases
-- 
cgit v1.2.3