improve docs

Author: Johannes Hötter

README.md

@@ -21,26 +21,29 @@ password = "your-password"
 project_id = "your-project-id" # can be found in the URL of the web application
 
 client = Client(username, password, project_id)
-# if you run the application locally, please the following instead:
+# if you run the application locally, please use the following instead:
 # client = Client(username, password, project_id, uri="http://localhost:4455")
 ```
 
-Alternatively, you can provide a `secrets.json` file in your repository, looking as follows:
+Alternatively, you can provide a `secrets.json` file in your directory where you want to run the SDK, looking as follows:
 ```json
 {
     "user_name": "your-username",
     "password": "your-password",
     "project_id": "your-project-id"
 }
 ```
-Again, if you run on your local machine, you should provide also `"uri": "http://localhost:4455"`.
+Again, if you run on your local machine, you should also provide `"uri": "http://localhost:4455"`. Afterwards, you can access the client like this:
+```python
+client = Client.from_secrets_file("secrets.json")
+```
 
 Now, you can easily fetch the data from your project:
 ```python
 df = client.get_record_export()
 ```
 
-Alternatively, you can also just run `kern pull` in your CLI given that you have provided the `secrets.json` file.
+Alternatively, you can also just run `kern pull` in your CLI given that you have provided the `secrets.json` file in the same directory.
 
 The `df` contains data of the following scheme:
 - all your record attributes are stored as columns, e.g. `headline` or `running_id` if you uploaded records like `{"headline": "some text", "running_id": 1234}`

cli.py

@@ -0,0 +1,42 @@
+from kern import Client
+import sys
+from wasabi import msg
+
+
+def pull():
+    client = Client.from_secrets_file("secrets.json")
+    project_name = client.get_project_details()["name"]
+    download_to = f"{project_name}.json"
+    client.get_record_export(download_to=download_to)
+
+
+def help():
+    msg.info(
+        "With the Kern SDK, you can type commands as `kern <command>`. Currently, we provide the following:"
+    )
+    msg.info(
+        "- kern pull: Download the record export of the project defined in `settings.json` to your local storage."
+    )
+    msg.info(
+        "- kern push <path>: Upload a record file to the project defined in `settings.json` from your local storage. Currently in development."
+    )
+
+
+def main():
+    cli_args = sys.argv[1:]
+    if len(cli_args) == 0:
+        msg.fail(
+            "Please provide some arguments when running kern. Type `kern help` for some instructions."
+        )
+    else:
+        command = cli_args[0]
+        if command == "pull":
+            pull()
+        elif command == "push":
+            msg.warn("Currently in development.")
+        elif command == "help":
+            help()
+        else:
+            msg.fail(
+                f"Could not understand command `{command}`. Type `kern help` for some instructions."
+            )

kern/cli.py

@@ -46,7 +46,7 @@
     ],
     entry_points={
         "console_scripts": [
-            "kern=cli:main",
+            "kern=kern.cli:main",
         ],
     },
 )