Publish to public pypi (#3)

* Prepare for public pypi

* Wording on UserGuide

* Feedback

Author: michael-groundlight

.github/workflows/publish.yaml

@@ -1,4 +1,4 @@
-# When a release is created on github, publish the groundlight package to our internal pypi repository
+# When a release is created on github, publish the groundlight package to public pypi
 # (Similar to https://github.com/positronix-ai/predictors/blob/main/.github/workflows/publish.yaml)
 name: publish package
 on:
@@ -8,7 +8,7 @@ jobs:
   publish-python-package:
     runs-on: ubuntu-latest
     env:
-      INTERNAL_REPO_URL: https://positronix-723181461334.d.codeartifact.us-west-2.amazonaws.com/pypi/internal/
+      POETRY_PYPI_TOKEN_PYPI: ${{ secrets.PYPI_PUBLISH_TOKEN }}
     steps:
       - name: install python
         uses: actions/setup-python@v2
@@ -18,19 +18,9 @@ jobs:
         run: |
           pip install -U pip
           pip install poetry
-      - name: configure AWS credentials
-        uses: aws-actions/configure-aws-credentials@v1
-        with:
-          aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
-          aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
-          aws-region: us-west-2
       - name: get code
         uses: actions/checkout@v2
       - name: build package
         run: poetry build
       - name: configure poetry and publish
-        run: |
-          export POETRY_HTTP_BASIC_INTERNAL_USERNAME=aws
-          export POETRY_HTTP_BASIC_INTERNAL_PASSWORD=$(aws codeartifact get-authorization-token --domain positronix --query authorizationToken --output text)
-          poetry config repositories.internal $INTERNAL_REPO_URL
-          poetry publish -r internal
+        run: poetry publish

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Groundlight AI
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -4,7 +4,7 @@ This package holds an SDK for accessing the Groundlight public API.
 
 ### Installation
 
-[Make sure you have internal pypi credentials set up](https://github.com/positronix-ai/tools/blob/main/internal-pip-login.sh), and then install with `pip` or `poetry`.
+Install with `pip` or `poetry`.
 
 ```Bash
 # pip
@@ -16,26 +16,22 @@ $ poetry add groundlight
 
 ### Basic Usage
 
-To access the API, you need an API token. You can create one at [app.groundlight.ai](https://app.positronix.ai/reef/my-account/api-tokens). Then, add it as an environment variable called `GROUNDLIGHT_API_TOKEN`:
-
-```Bash
-$ export GROUNDLIGHT_API_TOKEN=tok_abc123
-```
-
-Now you can use the python SDK!
+To access the API, you need an API token. You can create one on the [groundlight website](https://app.positronix.ai/reef/my-account/api-tokens). Then, you're ready to use the SDK!
 
 ```Python
 from groundlight import Groundlight
 
 # Load the API client. This defaults to the prod endpoint,
 # but you can specify a different endpoint like so:
 # gl = Groundlight(endpoint="https://device.integ.positronix.ai/device-api")
-gl = Groundlight()
+gl = Groundlight(api_token="<YOUR_API_TOKEN>")
 
 # Call an API method (e.g., retrieve a list of detectors)
 detectors = gl.list_detectors()
 ```
 
+(Alternatively, you can use the token by setting the `GROUNDLIGHT_API_TOKEN` environment variable.)
+
 ### What API methods are available?
 
 Check out the [User Guide](UserGuide.md)!

UserGuide.md

@@ -1,31 +1,28 @@
 # User Guide
 
-## Pre-reqs
+`groundlight` is a python SDK for working with the Groundlight API. You can send image queries and receive predictions powered by a mixture of machine learning models and human labelers in-the-loop.
+
+*Note: The SDK is currently in "alpha" phase.*
 
-For all the examples, there are 3 pre-reqs:
+## Pre-reqs
 
-1. [Make sure you have internal pypi credentials set up](https://github.com/positronix-ai/tools/blob/main/internal-pip-login.sh), and then install with `pip` or `poetry`.
+1. Install the `groundlight` sdk.
 
     ```Bash
-    # pip
     $ pip install groundlight
-
-    # poetry
-    $ poetry add groundlight
     ```
 
-1. To access the API, you need an API token. You can create one at [app.groundlight.ai](https://app.positronix.ai/reef/my-account/api-tokens). Then, add it as an environment variable called `GROUNDLIGHT_API_TOKEN`:
+1. To access the API, you need an API token. You can create one on the [groundlight website](https://app.positronix.ai/reef/my-account/api-tokens).
 
-    ```Bash
-    $ export GROUNDLIGHT_API_TOKEN=tok_abc123
-    ```
-
-1. Create the `Groundlight` API client. We usually use `gl` as a shorthand name, but you are free to name it what you like!
+1. Use the `Groundlight` client!
 
     ```Python
     from groundlight import Groundlight
-    gl = Groundlight()
+    gl = Groundlight(api_token="<YOUR_API_TOKEN>")
     ```
+
+    The API token should be stored securely - do not commit it to version control! Alternatively, you can use the token by setting the `GROUNDLIGHT_API_TOKEN` environment variable.
+
 ## Basics
 
 #### Create a new detector
@@ -76,24 +73,6 @@ image_queries = gl.list_image_queries(page=3, page_size=25)
 
 ## Advanced
 
-#### Use a different API endpoint
-
-```Python
-from groundlight import Groundlight
-
-# Integ
-integ_gl = Groundlight(endpoint="https://device.integ.positronix.ai/device-api")
-
-# Local
-local_gl = Groundlight(endpoint="http://localhost:8000/device-api")
-```
-
-#### Do more with the object models
-
-You can see the different model types [here](generated/model.py). (TODO: Use something like [autodoc_pydantic](https://github.com/mansenfranzen/autodoc_pydantic) to create docs).
-
-All of the `Groundlight` methods return [pydantic](https://pydantic-docs.helpmanual.io/) models - `Detector`, `ImageQuery`, `PaginatedDetectorList`, etc. This provides several benefits: you can access model fields with dot notation, get auto-complete in your IDE, have `model.dict()`, `model.json()`, `model.pickle()` serializers, etc. See more on the [pydantic docs](https://pydantic-docs.helpmanual.io/usage/models/).
-
 ### Handling HTTP errors
 
 If there is an HTTP error during an API call, it will raise an `ApiException`. You can access different metadata from that exception:

pyproject.toml

@@ -1,6 +1,9 @@
 [tool.poetry]
 name = "groundlight"
-version = "0.1.7"
+version = "0.2.0"
+license = "MIT"
+readme = "UserGuide.md"
+homepage = "https://app.positronix.ai"
 description = "Call the Groundlight API from python"
 authors = ["Groundlight AI <[email protected]>"]
 packages = [

src/groundlight/client.py

@@ -32,10 +32,7 @@ class Groundlight:
 
     def __init__(self, endpoint: str = "https://device.positronix.ai/device-api", api_token: str = None):
         """
-        :param endpoint: optionally specify a different endpoint. E.g.
-            - Prod (default): https://device.positronix.ai/device-api
-            - Integ: https://device.integ.positronix.ai/device-api
-            - Localhost tunnel to a GPU instance: http://localhost:8000/device-api
+        :param endpoint: optionally specify a different endpoint
         :param api_token: use this API token for your API calls. If unset, fallback to the
             environment variable "GROUNDLIGHT_API_TOKEN".
         """