highlighter-sdk 0.5.0__tar.gz

highlighter_sdk-0.5.0/.gitignore

@@ -0,0 +1,6 @@
+*/__pycache__
+*.pyc
+*.swp
+dist/*
+hl/*
+venv/*

highlighter_sdk-0.5.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

highlighter_sdk-0.5.0/PKG-INFO

@@ -0,0 +1,215 @@
+Metadata-Version: 2.3
+Name: highlighter-sdk
+Version: 0.5.0
+Summary: Package to interact with the Highlighter Perception System
+Project-URL: Documentation, https://highlighter-docs.netlify.app/
+Author-email: Joshua Patterson <joshua.patterson@silverpond.com.au>, Jono Chang <jonathan.chang@silverpond.com.au>, Simon Hudson <simon.hudson@silverpond.com.au>
+License-File: LICENSE
+Keywords: enterprise perception system
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: Unix
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Requires-Python: <4.0,>=3.7
+Requires-Dist: aiohttp~=3.7
+Requires-Dist: boto3~=1.26.30
+Requires-Dist: click!=8.0.0,<9,>=7
+Requires-Dist: colorama~=0.4.4
+Requires-Dist: fastavro~=1.8
+Requires-Dist: gql~=3.4.0
+Requires-Dist: jupyterlab~=3.2
+Requires-Dist: opencv-python~=4.7
+Requires-Dist: pandas~=1.0
+Requires-Dist: pillow>=6.0
+Requires-Dist: pooch~=1.5
+Requires-Dist: pydantic<2.0,>=1.6
+Requires-Dist: python-magic~=0.4.0
+Requires-Dist: pyyaml>=5.0
+Requires-Dist: requests-toolbelt
+Requires-Dist: requests~=2.22
+Requires-Dist: shapely>2.0.1
+Requires-Dist: tables~=3.7
+Requires-Dist: tqdm~=4.0
+Requires-Dist: websockets~=10.0
+Description-Content-Type: text/markdown
+
+# Highlighter SDK
+
+The Highlighter SDK Python library provides convenient access to the [Highlighter](https://highlighter.ai) API from applications written in Python. There is also a CLI to access the Highlighter API in your shell.
+
+The library also provides other features. For example:
+
+* Easy configuration for fast setup and use across multiple Highlighter accounts.
+* Functions to help work with datasets from Highlighter
+* Helpers for pagination.
+
+**For developer docs see: [here](docs/dev.md)**
+
+# API Tokens, Environment Variables and Profiles
+
+If you have just a single set of Highlighter credentials you can simply set
+the appropriate environment variables.
+
+```
+export HL_WEB_GRAPHQL_ENDPOINT="https://<client-account>.highlighter.ai/graphql"
+export HL_WEB_GRAPHQL_API_TOKEN="###"
+
+# Only required if you have datasets stored outside Highlighter's managed
+# aws s3 storage
+export AWS_ACCESS_KEY_ID=###
+export AWS_SECRET_ACCESS_KEY=###
+export AWS_DEFAULT_REGION=###
+```
+
+If you have several Highlighter credentials we suggest you use the
+**profiles** option. You can create a `~/.highlighter-profiles.yaml` via the
+cli.
+
+```console
+hl config create --name my-profile --api-token ### --endpoint https://...
+```
+
+Other commands for managing your profiles can be seen with the `--help` flag,
+
+If you're a *Maverick Renegade* you can manage the `~/.highlighter-profiles.yaml`
+manually. Below is an example,
+
+```yaml
+# Example ~/.highlighter-profiles.yaml
+
+my_profile:
+  endpoint_url: https://<client-account>.highlighter.ai/graphql
+  api_token: ###
+
+  # Only required if you have datasets stored outside Highlighter's managed
+  # aws s3 storage
+  cloud:
+    - type: aws-s3
+      aws_access_key_id: ###
+      aws_secret_access_key: ###
+      aws_default_region: ###
+```
+
+To use as a profile in the cli simply use,
+
+```console
+hl --profile <profile-name> <command>
+```
+
+In a script you can use,
+
+```python
+# in a script
+from highlighter import HLClient
+
+client = HLClient.from_profile("profile-name")
+```
+
+Additionally `HLClient` can be initialized using environment variables or
+by passing credentials direcly
+
+```python
+from highlighter import HLClient
+
+client = HLClient.from_env()
+
+# or
+
+api_token = "###"
+endpoint_url = "https://...highligher.ai/graphql
+client = HLCient.from_credential(api_token, endpoint_url)
+```
+
+Finally, if you are in the position where you want to write a specified profile's
+credentials to an evnironment file such as `.env` or `.envrc` you can use
+the `write` command. This will create or append to the specified file.
+
+```console
+hl --profile my-profile write .envrc
+```
+
+## Python API
+
+Once you have a `HLClient` object you can use it perform queries or mutations. Here is a simple example.
+
+```python
+from highlighter import HLClient
+from pydantic import BaseModel
+
+client = HLClient.from_env()
+
+# You don't always need to define your own BaseModels
+# many common BaseModels are defined in highlighter.base_models
+# this is simply for completeness
+class ObjectClassType(BaseModel):
+  id: int
+  name: str
+
+id = 1234  # add an object class id from you account
+
+result = client.ObjectClass(
+    return_type=ObjectClassType,
+    id=id,
+    )
+
+print(result)
+```
+
+Some queries may return arbitrarily many results. These queries are
+paginated and are called `Connections` and the queries are named accordingly.
+We have provided a `paginate` function to help with these `Connections`
+
+```python
+from highlighter import HLClient, paginate
+from pydantic import BaseModel
+
+client = HLClient.from_env()
+uuids = [
+   "abc123-abc123-abc123-abc123",
+   "xyz456-xyz456-xyz456-xyz456",
+]
+
+# The following BaseModels are all defined in
+# highlighter.base_models. They are simply here
+# for completeness
+class PageInfo(BaseModel):
+    hasNextPage: bool
+    endCursor: Optional[str]
+
+class ObjectClass(BaseModel):
+    id: str
+    uuid: str
+    name: str
+
+class ObjectClassTypeConnection(BaseModel):
+    pageInfo: PageInfo
+    nodes: List[ObjectClass]
+
+generator = paginate(
+     client..objectClassConnection,
+     ObjectClassTypeConnection,
+     uuid=uuids,
+     )
+
+for object_class in generator:
+  print(object_class)
+
+```
+
+## Datasets
+
+Highlighter SDK provides a dataset representation that can populated
+from several sources `{HighlighterWeb.Assessments | Local files {.hdf, records.json, coco.json} | S3Bucket}`.
+Once populated the `Highlighter.Datasets` object contains 2 `Pandas.DataFrames`
+(`data_files_df` and `annotations_df`) that you can manipulate as required. When you're
+ready you can write to disk or upload to Highligher using one of the `Writer` classes
+to dump your data to disk in a format that can be consumed by your downstream code.
+If you need you can also roll-your-own `Writer` by implementing the `highlighter.datasets.interfaces.IWriter` interface.
+
+
+## Documentation
+
+See https://highlighter-docs.netlify.app/

highlighter_sdk-0.5.0/README.md

@@ -0,0 +1,177 @@
+# Highlighter SDK
+
+The Highlighter SDK Python library provides convenient access to the [Highlighter](https://highlighter.ai) API from applications written in Python. There is also a CLI to access the Highlighter API in your shell.
+
+The library also provides other features. For example:
+
+* Easy configuration for fast setup and use across multiple Highlighter accounts.
+* Functions to help work with datasets from Highlighter
+* Helpers for pagination.
+
+**For developer docs see: [here](docs/dev.md)**
+
+# API Tokens, Environment Variables and Profiles
+
+If you have just a single set of Highlighter credentials you can simply set
+the appropriate environment variables.
+
+```
+export HL_WEB_GRAPHQL_ENDPOINT="https://<client-account>.highlighter.ai/graphql"
+export HL_WEB_GRAPHQL_API_TOKEN="###"
+
+# Only required if you have datasets stored outside Highlighter's managed
+# aws s3 storage
+export AWS_ACCESS_KEY_ID=###
+export AWS_SECRET_ACCESS_KEY=###
+export AWS_DEFAULT_REGION=###
+```
+
+If you have several Highlighter credentials we suggest you use the
+**profiles** option. You can create a `~/.highlighter-profiles.yaml` via the
+cli.
+
+```console
+hl config create --name my-profile --api-token ### --endpoint https://...
+```
+
+Other commands for managing your profiles can be seen with the `--help` flag,
+
+If you're a *Maverick Renegade* you can manage the `~/.highlighter-profiles.yaml`
+manually. Below is an example,
+
+```yaml
+# Example ~/.highlighter-profiles.yaml
+
+my_profile:
+  endpoint_url: https://<client-account>.highlighter.ai/graphql
+  api_token: ###
+
+  # Only required if you have datasets stored outside Highlighter's managed
+  # aws s3 storage
+  cloud:
+    - type: aws-s3
+      aws_access_key_id: ###
+      aws_secret_access_key: ###
+      aws_default_region: ###
+```
+
+To use as a profile in the cli simply use,
+
+```console
+hl --profile <profile-name> <command>
+```
+
+In a script you can use,
+
+```python
+# in a script
+from highlighter import HLClient
+
+client = HLClient.from_profile("profile-name")
+```
+
+Additionally `HLClient` can be initialized using environment variables or
+by passing credentials direcly
+
+```python
+from highlighter import HLClient
+
+client = HLClient.from_env()
+
+# or
+
+api_token = "###"
+endpoint_url = "https://...highligher.ai/graphql
+client = HLCient.from_credential(api_token, endpoint_url)
+```
+
+Finally, if you are in the position where you want to write a specified profile's
+credentials to an evnironment file such as `.env` or `.envrc` you can use
+the `write` command. This will create or append to the specified file.
+
+```console
+hl --profile my-profile write .envrc
+```
+
+## Python API
+
+Once you have a `HLClient` object you can use it perform queries or mutations. Here is a simple example.
+
+```python
+from highlighter import HLClient
+from pydantic import BaseModel
+
+client = HLClient.from_env()
+
+# You don't always need to define your own BaseModels
+# many common BaseModels are defined in highlighter.base_models
+# this is simply for completeness
+class ObjectClassType(BaseModel):
+  id: int
+  name: str
+
+id = 1234  # add an object class id from you account
+
+result = client.ObjectClass(
+    return_type=ObjectClassType,
+    id=id,
+    )
+
+print(result)
+```
+
+Some queries may return arbitrarily many results. These queries are
+paginated and are called `Connections` and the queries are named accordingly.
+We have provided a `paginate` function to help with these `Connections`
+
+```python
+from highlighter import HLClient, paginate
+from pydantic import BaseModel
+
+client = HLClient.from_env()
+uuids = [
+   "abc123-abc123-abc123-abc123",
+   "xyz456-xyz456-xyz456-xyz456",
+]
+
+# The following BaseModels are all defined in
+# highlighter.base_models. They are simply here
+# for completeness
+class PageInfo(BaseModel):
+    hasNextPage: bool
+    endCursor: Optional[str]
+
+class ObjectClass(BaseModel):
+    id: str
+    uuid: str
+    name: str
+
+class ObjectClassTypeConnection(BaseModel):
+    pageInfo: PageInfo
+    nodes: List[ObjectClass]
+
+generator = paginate(
+     client..objectClassConnection,
+     ObjectClassTypeConnection,
+     uuid=uuids,
+     )
+
+for object_class in generator:
+  print(object_class)
+
+```
+
+## Datasets
+
+Highlighter SDK provides a dataset representation that can populated
+from several sources `{HighlighterWeb.Assessments | Local files {.hdf, records.json, coco.json} | S3Bucket}`.
+Once populated the `Highlighter.Datasets` object contains 2 `Pandas.DataFrames`
+(`data_files_df` and `annotations_df`) that you can manipulate as required. When you're
+ready you can write to disk or upload to Highligher using one of the `Writer` classes
+to dump your data to disk in a format that can be consumed by your downstream code.
+If you need you can also roll-your-own `Writer` by implementing the `highlighter.datasets.interfaces.IWriter` interface.
+
+
+## Documentation
+
+See https://highlighter-docs.netlify.app/

highlighter_sdk-0.5.0/highlighter/__init__.py

@@ -0,0 +1,18 @@
+# isort: skip_file
+
+from highlighter.const import *
+from highlighter.base_models import *
+from highlighter.gql_client import HLClient
+
+from highlighter.entity_avro_schema import *
+from highlighter.data_files import *
+from highlighter.labeled_uuid import *
+from highlighter.object_classes import *
+from highlighter.pagination import paginate
+from highlighter.presigned_url import *
+from highlighter.assessments import *
+from highlighter.tasks import *
+from highlighter.training_runs import *
+from highlighter import io
+from highlighter.capabilities import *
+from highlighter.workflow import *