Clean up NucleusClient interface and strengthen object model (#153)

See `CHANGELOG.md` for additions and deprecations

Author: gatli

.flake8

@@ -3,4 +3,36 @@ ignore = E203, E266, E501, W503, F403, F401
 max-line-length = 79
 max-complexity = 18
 select = B,C,E,F,W,T4,B9
-
+exclude =
+    # All of these excludes should mirror something in .gitignore
+    .git,
+    __pychache__,
+    # Virtual env stuff
+    ./venv,
+    .env,
+    .venv,
+    env/,
+    venv/,
+    ENV/,
+    env.bak/,
+    venv.bak/,
+    # Distribution / packaging
+    .Python,
+    build/,
+    develop-eggs/,
+    dist/,
+    downloads/,
+    eggs/,
+    .eggs/,
+    lib/,
+    lib64/,
+    parts/,
+    sdist/,
+    var/,
+    wheels/,
+    pip-wheel-metadata/,
+    share/python-wheels/,
+    *.egg-info/,
+    .installed.cfg,
+    *.egg,
+    MANIFEST

.gitignore

@@ -138,3 +138,6 @@ poetry.lock
 
 # vscode
 .vscode/
+
+# JetBrains
+.idea/

.pre-commit-config.yaml

@@ -12,7 +12,7 @@ repos:
     hooks:
     - id: system
       name: flake8
-      entry: poetry run flake8 .
+      entry: poetry run flake8 nucleus tests
       pass_filenames: false
       language: system
 

CHANGELOG.md

@@ -0,0 +1,51 @@
+# Changelog
+All notable changes to the [Nucleus Python Client](https://github.com/scaleapi/nucleus-python-client) will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.3.0](https://github.com/scaleapi/nucleus-python-client/releases/tag/v0.3.0) - 2021-11-23
+
+### Added
+- `NucleusClient.datasets` property that lists Datasets in a human friendlier manner than `NucleusClient.list_datasets()`
+- `NucleusClient.models` property, this is preferred over the deprecated `list_models`
+- `NucleusClient.jobs` property. `NucleusClient.list_jobs` is still the preferred method to use if you filter jobs on access.
+- Deprecated method access now produces a deprecation warning in the logs.
+
+### Deprecated
+- Model runs have been deprecated and will be removed in the near future. Use a Model directly instead. The following
+  functions have all been deprecated as a part of that.
+  - `NucleusClient.get_model_run(..)`
+  - `NucleusClient.delete_model_run(..)`
+  - `NucleusClient.create_model_run(..)`
+  - `NucleusClient.commit_model_run(..)`
+  - `NucleusClient.model_run_info(..)`
+  - `NucleusClient.predictions_ref_id(..)`
+  - `NucleusClient.predictions_iloc(..)`
+  - `NucleusClient.predictions_loc(..)`
+  - `Dataset.create_model_run(..)`
+  - `Dataset.model_runs(..)`
+- `NucleusClient.list_datasets` is deprecated in favor of `NucleusClient.datasets`. The latter allows for direct usage of `Dataset` objects.
+- `NucleusClient.list_models` is deprecated in favor of `NucleusClient.models`.
+- `NucleusClient.get_dataset_items` is deprecated in favor of `Dataset.items` to make the object model more consistent.
+- `NucleusClient.delete_dataset_item` is deprecated in favor of `Dataset.delete_item` to make the object model more consistent.
+- `NucleusClient.populate_dataset` is deprecated in favor of `Dataset.append` to make the object model more consistent.
+- `NucleusClient.ingest_tasks` is deprecated in favor of `Dataset.ingest_tasks` to make the object model more consistent.
+- `NucleusClient.add_model` is deprecated in favor of `NucleusClient.create_model` for consistent terminology.
+- `NucleusClient.dataset_info` is deprecated in favor of `Dataset.info` to make the object model more consistent.
+- `NucleusClient.delete_annotations` is deprecated in favor of `Dataset.delete_annotations` to make the object model more consistent.
+- `NucleusClient.predict` is deprecated in favor of `Dataset.upload_predictions` to make the object model more consistent.
+- `NucleusClient.dataitem_ref_id` is deprecated in favor of `Dataset.refloc` to make the object model more consistent.
+- `NucleusClient.dataitem_iloc` is deprecated in favor of `Dataset.iloc` to make the object model more consistent.
+- `NucleusClient.dataitem_loc` is deprecated in favor of `Dataset.loc` to make the object model more consistent.
+- `NucleusClient.create_slice` is deprecated in favor of `Dataset.create_slice` to make the object model more consistent.
+- `NucleusClient.create_custom_index` is deprecated in favor of `Dataset.create_custom_index` to make the object model more consistent.
+- `NucleusClient.delete_custom_index` is deprecated in favor of `Dataset.delete_custom_index` to make the object model more consistent.
+- `NucleusClient.set_continuous_indexing` is deprecated in favor of `Dataset.set_continuous_indexing` to make the object model more consistent.
+- `NucleusClient.create_image_index` is deprecated in favor of `Dataset.create_image_index` to make the object model more consistent.
+- `NucleusClient.create_object_index` is deprecated in favor of `Dataset.create_object_index` to make the object model more consistent.
+- `Dataset.append_scenes` is deprecated in favor of `Dataset.append` for a simpler interface.
+
+## [0.0.1 - 0.2.1](https://github.com/scaleapi/nucleus-python-client/releases)
+
+[Refer to GitHub release notes for older releases.](https://github.com/scaleapi/nucleus-python-client/releases)

README.md

@@ -47,6 +47,8 @@ Please install the pre-commit hooks by running the following command:
 poetry run pre-commit install
 ```
 
+When releasing a new version please add release notes to the changelog in `CHANGELOG.md`.
+
 **Best practices for testing:**
 (1). Please run pytest from the root directory of the repo, i.e.
 

conftest.py

@@ -1,12 +1,8 @@
-import logging
 import os
 
-import requests
 import pytest
 
 import nucleus
-from nucleus.constants import SUCCESS_STATUS_CODES
-
 from tests.helpers import TEST_DATASET_NAME, TEST_DATASET_ITEMS
 
 assert "NUCLEUS_PYTEST_API_KEY" in os.environ, (