Merge pull request #476 from Labelbox/gj/readme-upload

Finalize readme upload

Author: Gareth

examples/Makefile

@@ -1,6 +1,3 @@
 
-
-
-
-convert:
-	python scripts/tutorials.py --config-path  'scripts/config.json'
+upload:
+	python scripts/upload_documentation.py --config-path  'scripts/config.json'

examples/scripts/config.json

@@ -1,7 +1,7 @@
 [
   {
     "dir": "basics",
-    "title": "Basics",
+    "title": "Getting started",
     "order": 0
   },
   {
@@ -16,7 +16,7 @@
   },
   {
     "dir": "annotation_import",
-    "title": "Annotation import",
+    "title": "Annotation import (Ground Truth & MAL)",
     "order": 3
   },
   {

examples/scripts/tutorials.py renamed to examples/scripts/upload_documentation.py

@@ -15,7 +15,8 @@
 
 
 def upload_doc(path, section):
-    title = path.split('/')[-1].replace(".ipynb", '').capitalize().replace('_', ' ')
+    title = path.split('/')[-1].replace(".ipynb",
+                                        '').capitalize().replace('_', ' ')
 
     with open(path) as fb:
         nb = nbformat.reads(json.dumps(json.load(fb)), as_version=4)
@@ -27,11 +28,16 @@ def upload_doc(path, section):
     body, resources = exporter.from_notebook_node(nb)
 
     payload = {
-        "hidden": True,
-        "title": f'{section["slug"]}-' + title.replace(' ', '-'),
-        "category": CATEGORY_ID,
-        "parentDoc": section['id'],
-        "body": body
+        "hidden":
+            True,
+        "title":
+            f'{section["slug"]}-' + title.replace(' ', '-').replace("(", ''),
+        "category":
+            CATEGORY_ID,
+        "parentDoc":
+            section['id'],
+        "body":
+            body
     }
 
     headers = {
@@ -52,7 +58,7 @@ def make_sections(sections):
         payload = {
             "hidden": True,
             "order": section['order'],
-            "title": section['title'].replace(' ', '-') + '-nb-section',
+            "title": 'section-' + section['dir'] + '-notebooks',
             "category": CATEGORY_ID
         }
         headers = {
@@ -73,29 +79,29 @@ def make_sections(sections):
 
 
 def change_name(slug, title, headers):
-    resp = requests.put(
-        f'{README_DOC_ENDPOINT}/{slug}',
-        json={
-            "title": title,
-            "category": CATEGORY_ID
-        },
-        headers=headers
-    )
+    resp = requests.put(f'{README_DOC_ENDPOINT}/{slug}',
+                        json={
+                            "title": title,
+                            "category": CATEGORY_ID
+                        },
+                        headers=headers)
     resp.raise_for_status()
 
 
 def erase_category_docs(cat_slug):
-    headers = {
-        "Accept": "application/json",
-        "Authorization": README_AUTH
-    }
+    headers = {"Accept": "application/json", "Authorization": README_AUTH}
 
-    response = requests.request("GET", f'https://dash.readme.com/api/v1/categories/{cat_slug}/docs', headers=headers)
+    response = requests.request(
+        "GET",
+        f'https://dash.readme.com/api/v1/categories/{cat_slug}/docs',
+        headers=headers)
     docs = response.json()
     for doc in docs:
         for child in doc["children"]:
-            resp = requests.delete(f'{README_DOC_ENDPOINT}/{child["slug"]}', headers=headers)
-        resp = requests.delete(f'{README_DOC_ENDPOINT}/{doc["slug"]}', headers=headers)
+            resp = requests.delete(f'{README_DOC_ENDPOINT}/{child["slug"]}',
+                                   headers=headers)
+        resp = requests.delete(f'{README_DOC_ENDPOINT}/{doc["slug"]}',
+                               headers=headers)
 
 
 @click.command()