Merge branch 'ms/test-fixes' of https://github.com/Labelbox/labelbox-python into jtso/list_bir

Author: jtsodapop

CHANGELOG.md

@@ -1,5 +1,76 @@
 # Changelog
 
+# Version 3.1.0 (2021-08-18)
+## Added
+* Support for new HTML attachment type
+* Delete Bulk Import Requests with `BulkImportRequest.delete()`
+
+## Misc
+* Updated MEAPredictionImport class to use latest grapqhql endpoints
+
+
+# Version 3.0.1 (2021-08-12)
+## Fix
+* Issue with inferring text type from export
+
+# Version 3.0.0 (2021-08-12)
+## Added
+* Annotation types
+    - A set of python objects for working with labelbox data
+    - Creates a standard interface for both exports and imports
+    - See example notebooks on how to use under examples/annotation_types
+    - Note that these types are not yet supported for tiled imagery
+* MEA Support
+    - Beta MEA users can now just use the latest SDK release
+* Metadata support
+    - New metadata features are now fully supported by the SDK
+* Easier export
+    - `project.export_labels()` accepts a boolean indicating whether or not to download the result
+    - Create annotation objects directly from exports with `project.label_generator()` or `project.video_label_generator()`
+    - `project.video_label_generator()` asynchronously fetches video annotations
+* Retry logic on data uploads
+    - Bulk creation of data rows will be more reliable
+* Datasets
+    - Determine the number of data rows just by calling `dataset.row_count`.
+    - Updated threading logic in create_data_rows() to make it compatible with aws lambdas
+* Ontology
+    - `OntologyBuilder`, `Classification`, `Option`, and `Tool` can now be imported from `labelbox` instead of `labelbox.schema.ontology`
+
+## Removed
+* Deprecated:
+    - `project.reviews()`
+    - `project.create_prediction()`
+    - `project.create_prediction_model()`
+    - `project.create_label()`
+    - `Project.predictions()`
+    - `Project.active_prediction_model`
+    - `data_row.predictions`
+    - `PredictionModel`
+    - `Prediction`
+* Replaced:
+    - `data_row.metadata()` use `data_row.attachments()` instead
+    - `data_row.create_metadata()` use `data_row.create_attachments()` instead
+    - `AssetMetadata` use `AssetAttachment` instead
+
+## Fixes
+* Support derived classes of ontology objects when using `from_dict`
+* Notebooks:
+    - Video export bug where the code would fail if the exported projects had tools other than bounding boxes
+    - MAL demos were broken due to an image download failing.
+
+## Misc
+* Data processing dependencies are not installed by default to for users that only want client functionality.
+* To install all dependencies required for the data modules (annotation types and mea metric calculation) use `pip install labelbox[data]`
+* Decrease wait time between updates for `BulkImportRequest.wait_until_done()`.
+* Organization is no longer used to create the LFO in `Project.setup()`
+
+
+# Version 3.0.0-rc3 (2021-08-11)
+## Updates
+* Geometry.raster now has a consistent interface and improved functionality
+* renamed schema_id to feature_schema_id in the `FeatureSchema` class
+* `Mask` objects now use `MaskData` to represent segmentation masks instead of `ImageData`
+
 # Version 3.0.0-rc2 (2021-08-09)
 ## Updates
 * Rename `data` property of TextData, ImageData, and VideoData types to `value`.

Makefile

@@ -2,6 +2,13 @@
 build:
 	docker build -t local/labelbox-python:test .
 
+
+test-local: build
+	docker run -it -v ${PWD}:/usr/src -w /usr/src \
+		-e LABELBOX_TEST_ENVIRON="local" \
+		-e LABELBOX_TEST_API_KEY_LOCAL=${LABELBOX_TEST_API_KEY_LOCAL} \
+		local/labelbox-python:test pytest $(PATH_TO_TEST) -svvx
+
 test-staging: build
 	docker run -it -v ${PWD}:/usr/src -w /usr/src \
 		-e LABELBOX_TEST_ENVIRON="staging" \

README.md

@@ -35,9 +35,14 @@ If the installation completes with a warning re: pip not being in your path, you
 export PATH=/Users/<your-macOS-username>/Library/Python/3.8/bin:$PATH
 ```
 
-Install using Python's Pip manager.
+Install SDK locally, using Python's Pip manager
 ```
-pip install labelbox
+pip3 install -e .
+```
+
+Install dependencies
+```
+pip3 install -r requirements.txt
 ```
 To install dependencies required for data processing modules use:
 ```
@@ -55,29 +60,48 @@ pip install labelbox[data]
 Labelbox uses API keys to validate requests. You can create and manage API keys on [Labelbox](https://app.labelbox.com/account/api-keys). Pass your API key as an environment variable. Then, import and initialize the API Client.
 
 ```
-user@machine:~$ export LABELBOX_API_KEY="<your api key here>"
+user@machine:~$ export LABELBOX_API_KEY="<your local api key here>"
 user@machine:~$ python3
 
 from labelbox import Client
 client = Client()
 ```
+* Update api_key and endpoint if not using the production cloud deployment
+```
+# On prem
+client = Client( endpoint = "<local deployment>")
+
+# Local
+client = Client(api_key=os.environ['LABELBOX_TEST_API_KEY_LOCAL'], endpoint="http://localhost:8080/graphql")
+
+# Staging
+client = Client(api_key=os.environ['LABELBOX_TEST_API_KEY_LOCAL'], endpoint="https://staging-api.labelbox.com/graphql")
+```
 
 ## Contribution
 Please consult `CONTRIB.md`
 
 ## Testing
-1. Update the `Makefile` with your `staging` or `prod` API key. Ensure that docker has been installed on your system. Make sure the key is not from a free tier account.
-2. To test on `staging`:
+1. Update the `Makefile` with your `local`, `staging`, `prod` API key. Ensure that docker has been installed on your system. Make sure the key is not from a free tier account.
+2. To test on `local`:
+```
+user@machine:~$ export LABELBOX_TEST_API_KEY_LOCAL="<your local api key here>"
+make test-local  # with an optional flag: PATH_TO_TEST=tests/integration/...etc LABELBOX_TEST_API_KEY_LOCAL=specify_here_or_export_me
+```
+
+3. To test on `staging`:
 ```
-make test-staging
+user@machine:~$ export LABELBOX_TEST_API_KEY_STAGING="<your staging api key here>"
+make test-staging # with an optional flag: PATH_TO_TEST=tests/integration/...etc LABELBOX_TEST_API_KEY_STAGING=specify_here_or_export_me
 ```
 
-3. To test on `prod`:
+4. To test on `prod`:
 ```
-make test-prod
+user@machine:~$ export LABELBOX_TEST_API_KEY_PROD="<your prod api key here>"
+make test-prod # with an optional flag: PATH_TO_TEST=tests/integration/...etc LABELBOX_TEST_API_KEY_PROD=specify_here_or_export_me
 ```
 
-4. If you make any changes and need to rebuild the image used for testing, force a rebuild with the `-B` flag
+5. If you make any changes and need to rebuild the image used for testing, force a rebuild with the `-B` flag
 ```
-make -B {build|test-staging|test_prod}
+make -B {build|test-staging|test-prod}
 ```