scale-nucleus 0.1.17__tar.gz → 0.3.2__tar.gz

{scale-nucleus-0.1.17 → scale-nucleus-0.3.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: scale-nucleus
-Version: 0.1.17
+Version: 0.3.2
 Summary: The official Python client library for Nucleus, the Data Platform for AI
 Home-page: https://scale.com/nucleus
 License: MIT
@@ -12,9 +12,12 @@ Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.7
 Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
+Requires-Dist: Sphinx (>=4.2.0,<5.0.0)
 Requires-Dist: aiohttp (>=3.7.4,<4.0.0)
-Requires-Dist: dataclasses (>=0.7,<0.8); python_version >= "3.6.1" and python_version < "3.7"
+Requires-Dist: dataclasses (>=0.7,<0.8); python_full_version >= "3.6.1" and python_version < "3.7"
+Requires-Dist: isort (>=5.10.1,<6.0.0)
 Requires-Dist: nest-asyncio (>=1.5.1,<2.0.0)
+Requires-Dist: pydantic (>=1.8.2,<2.0.0)
 Requires-Dist: requests (>=2.23.0,<3.0.0)
 Requires-Dist: tqdm (>=4.41.0,<5.0.0)
 Project-URL: Documentation, https://dashboard.scale.com/nucleus/docs/api
@@ -70,6 +73,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.
 
@@ -83,3 +88,14 @@ poetry run pytest tests/test_dataset.py
 poetry run pytest -m "not integration"
 ```
 
+**Updating documentation:**
+We use [Sphinx](https://www.sphinx-doc.org/en/master/) to autogenerate our API Reference from docstrings.
+
+To test your local docstring changes, run the following commands from the repository's root directory:
+```
+poetry shell
+cd docs
+sphinx-autobuild . ./_build/html --watch ../nucleus
+```
+`sphinx-autobuild` will spin up a server on localhost (port 8000 by default) that will watch for and automatically rebuild a version of the API reference based on your local docstring changes.
+

{scale-nucleus-0.1.17 → scale-nucleus-0.3.2}/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.
 
@@ -59,3 +61,14 @@ poetry run pytest tests/test_dataset.py
 ```
 poetry run pytest -m "not integration"
 ```
+
+**Updating documentation:**
+We use [Sphinx](https://www.sphinx-doc.org/en/master/) to autogenerate our API Reference from docstrings.
+
+To test your local docstring changes, run the following commands from the repository's root directory:
+```
+poetry shell
+cd docs
+sphinx-autobuild . ./_build/html --watch ../nucleus
+```
+`sphinx-autobuild` will spin up a server on localhost (port 8000 by default) that will watch for and automatically rebuild a version of the API reference based on your local docstring changes.