Release 0.5.0

README.md

@@ -1,20 +1,18 @@
 # calpads
-An experimental and unofficial Python Web API wrapper for California Department of Education CALPADS.
+An unofficial Python Web API wrapper for California Department of Education's CALPADS.
 
-[Version 0.3.0](https://github.com/yo-my-bard/calpads/tree/0.3.0) is pretty great and covers many use-cases. Given its lack of official support, the wrapper is subject to break at any moment if the internals of CALPADS magic change hence why we remain experimental. Also, we're still experimenting.
+[Version 0.5.0](https://github.com/yo-my-bard/calpads/tree/0.5.0) is pretty great and covers many use-cases. Given its lack of official support, the wrapper is subject to break at any moment if the internals of CALPADS magic change.
 
-# Supported Endpoints
-* `Leas` - lists all(?) Leas
+# We Have Documentation!
+Supported endpoints, downloads, and other features are [documented in our GitBook website](https://summit-public-schools.gitbook.io/calpads-api/).
+Here are some of our favorite highlights:
 * A number of `/Students` endpoints are currently functional. These are the famous individual sub-sections on the student page, but delivered in JSON with ⚡️ speed
-
-# Features
 * `Reports` downloads for reports with an expressive API that exposes most form fields
 * `Extracts` downloads for most extracts with an expressive API to support many requesting "modes" (e.g. by date range)
 * Supports switching between multiple LEAs
+* Supports uploading *and* posting files
+* Supports fetching file upload errors (using the `Extracts` downloads)
 
 # Installation
 * To get much of this speed gain, we depend on `lxml`. They have specific [installation instructions here](https://lxml.de/installation.html).
-* Recommend pip: `pip install git+https://github.com/SummitPublicSchools/[email protected]`
-
-# Planned Experimentations
-* Extract/File Upload operations
+* Recommend pip: `pip install git+https://github.com/SummitPublicSchools/[email protected]`

calpads/client.py

@@ -911,4 +911,4 @@ def safe_json_load(response):
     try:
         return json.loads(response.content)
     except JSONDecodeError:
-        return {}
+        return {}

setup.py

@@ -8,14 +8,14 @@
 
 setup(
     name="calpads",
-    version="0.4.0",
+    version="0.5.0",
     author="Yusuph Mkangara",
     author_email="[email protected]",
     description="Python Web API wrapper for CDE's CALPADS with a focus on data extraction",
     long_description=long_description,
     long_description_content_type="text/markdown",
     license=lic,
-    url="https://github.com/yo-my-bard/calpads",
+    url="https://github.com/SummitPublicSchools/calpads",
     packages=find_packages(include=["calpads"]),
     python_requires=">=3.6", #Might be able to support earlier versions, but would have to see
     install_requires=[