@opentrons/shared-data 0.1.7-alpha.1 → 0.2.1-alpha.0

package/.coveragerc

@@ -0,0 +1,4 @@
+[report]
+exclude_lines =
+    @overload
+    if TYPE_CHECKING:

package/.flake8

@@ -0,0 +1,31 @@
+[flake8]
+
+extend-exclude = venv .venv
+
+# max cyclomatic complexity
+max-complexity = 9
+
+extend-ignore =
+    # defer formatting concerns to black
+    # E203: space around `:` operator
+    # E501: maximum line length
+    E203,
+    E501,
+    # do not require type annotations for self nor cls
+    ANN101,
+    ANN102
+
+# configure flake8-docstrings
+# https://pypi.org/project/flake8-docstrings/
+docstring-convention = google
+
+noqa-require-code = true
+
+per-file-ignores =
+    python/opentrons_shared_data/load.py:D
+    python/opentrons_shared_data/deck/*:D
+    python/opentrons_shared_data/labware/*:D
+    python/opentrons_shared_data/module/*:D
+    python/opentrons_shared_data/pipette/*:D
+    python/opentrons_shared_data/protocol/*:D
+    python_tests/*:ANN,D

package/Config.in

@@ -0,0 +1,11 @@
+config BR2_PACKAGE_PYTHON_OPENTRONS_SHARED_DATA
+  bool "python-opentrons-shared-data"
+  depends on BR2_PACKAGE_PYTHON3
+  select BR2_PACKAGE_PYTHON_JSONSCHEMA # runtime
+  select BR2_PACKAGE_PYTHON_TYPING_EXTENSIONS # runtime
+  select BR2_PACKAGE_PYTHON_NUMPY # runtime
+
+  help
+    Opentrons data sources. Used on an OT-2 robot.
+
+    https://opentrons.com

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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.

package/Makefile

@@ -45,6 +45,44 @@ lib-js:
 build-ts:
 	yarn tsc --build --emitDeclarationOnly
 
+.PHONY: publish-npm-local
+publish-npm-local: build-ts lib-js
+	@echo "Setting up local npm publish test..."
+	@echo "Installing json utility globally..."
+	npm install -g json
+	@echo "Current package.json version:"
+	@cat package.json | json version
+	@echo ""
+	@echo "Simulating version update (would use: json -I -f ./package.json -e \"this.version=\\\"VERSION_STRING\\\"\")"
+	@echo "Building and preparing package for publish..."
+	@echo "Package contents that would be published:"
+	@npm pack --dry-run
+	@echo ""
+	@echo "To actually publish, you would run:"
+	@echo "  npm publish --access public"
+	@echo ""
+	@echo "Note: This target builds and prepares but does NOT actually publish."
+	@echo "To test actual publishing, add your version and run 'npm publish --access public' manually."
+
+.PHONY: publish-npm-with-version
+publish-npm-with-version: build-ts lib-js
+	@if [ -z "$(VERSION)" ]; then \
+		echo "Error: VERSION is required. Usage: make publish-npm-with-version VERSION=0.2.1-alpha.0"; \
+		exit 1; \
+	fi
+	@echo "Installing json utility globally..."
+	npm install -g json
+	@echo "Setting version to $(VERSION)..."
+	json -I -f ./package.json -e "this.version=\"$(VERSION)\""
+	@echo "Updated package.json version:"
+	@cat package.json | json version
+	@echo ""
+	@echo "Package contents that would be published:"
+	@npm pack --dry-run
+	@echo ""
+	@echo "To publish, run: npm publish --access public"
+	@echo "To revert version, run: git checkout -- package.json"
+
 .PHONY: format-js
 format-js:
 	yarn prettier --ignore-path ../.eslintignore --write $(FORMAT_FILE_GLOB)
@@ -65,51 +103,51 @@ lint-js-prettier:
 
 .PHONY: setup-py
 setup-py:
-	$(MAKE) -C python setup-py
+	$(MAKE) -f Makefile-python.mk setup-py
 
 .PHONY: dist-py
 dist-py:
-	$(MAKE) -C python sdist wheel
+	$(MAKE) -f Makefile-python.mk sdist wheel
 
 .PHONY: clean-py
 clean-py:
-	$(MAKE) -C python clean
+	$(MAKE) -f Makefile-python.mk clean
 
 .PHONY: teardown-py
 teardown-py:
-	$(MAKE) -C python teardown
+	$(MAKE) -f Makefile-python.mk teardown
 
 .PHONY: lint-py
 lint-py:
-	$(MAKE) -C python lint
+	$(MAKE) -f Makefile-python.mk lint
 
 .PHONY: format-py
 format-py:
-	$(MAKE) -C python format
+	$(MAKE) -f Makefile-python.mk format
 
 .PHONY: push-no-restart
 push-no-restart:
-	$(MAKE) -C python push-no-restart
+	$(MAKE) -f Makefile-python.mk push-no-restart
 
 .PHONY: push
 push:
-	$(MAKE) -C python push
+	$(MAKE) -f Makefile-python.mk push
 
 .PHONY: push-no-restart-ot3
 push-no-restart-ot3:
-	$(MAKE) -C python push-no-restart-ot3
+	$(MAKE) -f Makefile-python.mk push-no-restart-ot3
 
 .PHONY: push-ot3
 push-ot3:
-	$(MAKE) -C python push-ot3
+	$(MAKE) -f Makefile-python.mk push-ot3
 
 .PHONY: deploy-py
 deploy-py:
-	$(MAKE) -C python deploy
+	$(MAKE) -f Makefile-python.mk deploy
 
 .PHONY: test-py
 test-py:
-	$(MAKE) -C python test
+	$(MAKE) -f Makefile-python.mk test
 
 .PHONY: test
 test:
@@ -117,5 +155,4 @@ test:
 
 .PHONY: test-cov
 test-cov:
-	make -C .. test-js-shared-data tests=$(tests) test_opts="$(test_opts)" cov_opts="$(cov_opts)"
-
+	$(MAKE) -C .. test-js-shared-data tests=$(tests) test_opts="$(test_opts)" cov_opts="$(cov_opts)"

package/Makefile-python.mk

@@ -0,0 +1,134 @@
+# shared-data python code makefile
+
+include ../scripts/python.mk
+include ../scripts/push.mk
+
+# Host key location for robot
+ssh_key ?= $(default_ssh_key)
+# Other SSH args for robot
+ssh_opts ?= $(default_ssh_opts)
+
+# using bash instead of /bin/bash in SHELL prevents macOS optimizing away our PATH update
+SHELL := bash
+
+# add node_modules/.bin to PATH
+PATH := $(shell cd ../ && yarn bin):$(PATH)
+
+# This may be set as an environment variable (and is by CI tasks that upload
+# to test pypi) to add a .dev extension to the python package versions. If
+# empty, no .dev extension is appended, so this definition is here only as
+# documentation
+BUILD_NUMBER ?=
+
+# this may be set as an environment variable to select the version of
+# python to run if pyenv is not available. it should always be set to
+# point to a python3.6.
+OT_PYTHON ?= python
+
+BUILD_DIR := dist
+
+
+wheel_file = $(BUILD_DIR)/$(call python_get_wheelname,shared-data,$(PROJECT),opentrons_shared_data,$(BUILD_NUMBER),../scripts/python_build_utils.py)
+sdist_file = $(BUILD_DIR)/$(call python_get_sdistname,shared-data,$(PROJECT),opentrons_shared_data,,../scripts/python_build_utils.py)
+
+py_sources = $(filter %.py,$(shell $(SHX) find python/opentrons_shared_data)) python/opentrons_shared_data/py.typed
+deck_sources = $(wildcard deck/definitions/*/*.json) $(wildcard deck/schemas/*.json)
+labware_sources = $(wildcard labware/definitions/*/*.json) $(wildcard labware/schemas/*.json)
+module_sources = $(wildcard module/definitions/*.json) $(wildcard module/definitions/*/*.json) $(wildcard module/schemas/*.json)
+pipette_sources = $(wildcard pipette/definitions/*.json) $(wildcard pipette/schemas/*.json)
+protocol_sources = $(wildcard protocol/schemas/*.json)
+gripper_sources = $(wildcard gripper/definitions/*.json) $(wildcard gripper/schemas/*.json)
+
+json_sources = $(deck_sources) $(labware_sources) $(module_sources) $(pipette_sources) $(protocol_sources) $(gripper_sources)
+
+tests ?= python_tests
+
+twine_auth_args := --username $(pypi_username) --password $(pypi_password)
+twine_repository_url ?= $(pypi_test_upload_url)
+
+clean_cmd = $(SHX) rm -rf build $(BUILD_DIR) .coverage coverage.xml '*.egg-info'
+clean_cache_cmd	 = $(SHX) rm -rf '**/__pycache__' '**/*.pyc' '**/.mypy_cache'
+
+.PHONY: all
+all: clean sdist wheel
+
+.PHONY: setup
+setup: setup-py
+
+.PHONY: setup-py
+setup-py:
+	$(pipenv) sync $(pipenv_opts)
+	$(pipenv) run pip freeze
+
+.PHONY: teardown
+teardown: teardown-py
+
+.PHONY: teardown-py
+teardown-py:
+	-$(pipenv) --rm
+
+
+.PHONY: clean
+clean:
+	$(clean_cmd)
+	$(clean_cache_cmd)
+
+.PHONY: wheel
+wheel: export OPENTRONS_PROJECT=$(PROJECT)
+wheel: export HATCH_VCS_TUNABLE_TAG_PATTERN=$(call git_tag_regex_for_project,$(PROJECT))
+wheel: export HATCH_VCS_TUNABLE_RAW_OPTIONS=$(call hatch_raw_options_for_project,$(PROJECT))
+wheel: $(py_sources) $(json_sources)
+	$(python) -m build --wheel $(build_wheel_opts) .
+	$(SHX) ls $(BUILD_DIR)
+
+
+.PHONY: sdist
+sdist: export OPENTRONS_PROJECT=$(PROJECT)
+sdist: export HATCH_VCS_TUNABLE_TAG_PATTERN=$(call git_tag_regex_for_project,$(PROJECT))
+sdist: export HATCH_VCS_TUNABLE_RAW_OPTIONS=$(call hatch_raw_options_for_project,$(PROJECT))
+sdist: $(py_sources) $(json_sources)
+	$(python) -m build --sdist .
+	$(SHX) ls $(BUILD_DIR)
+
+
+.PHONY: lint
+lint: $(py_sources)
+	$(python) -m mypy python/opentrons_shared_data python_tests
+	$(python) -m black --check python/opentrons_shared_data python_tests
+	$(python) -m flake8 python/opentrons_shared_data python_tests
+
+.PHONY: format
+format:
+	$(python) -m black python/opentrons_shared_data python_tests
+
+.PHONY: push-no-restart
+push-no-restart: wheel
+	$(call push-python,$(host),$(ssh_key),$(ssh_opts),$(wheel_file),/usr/lib/python3.10/site-packages/)
+
+.PHONY: push
+push: push-no-restart
+	$(call restart-service,$(host),$(ssh_key),$(ssh_opts),opentrons-robot-server)
+
+.PHONY: push-no-restart-ot3
+push-no-restart-ot3: wheel
+	$(call push-python,$(host),$(ssh_key),$(ssh_opts),$(wheel_file),/opt/opentrons-robot-server/)
+
+.PHONY: push-ot3
+push-ot3: push-no-restart-ot3
+	$(call restart-service,$(host),$(ssh_key),$(ssh_opts),"opentrons-robot-server")
+
+.PHONY: deploy
+deploy: wheel sdist
+	$(call python_upload_package,$(twine_auth_args),$(twine_repository_url),$(wheel_file),$(sdist_file))
+
+.PHONY: test
+test:
+	$(python) -m pytest --cov=opentrons_shared_data --cov-report xml:coverage.xml $(tests) $(test_opts)
+
+
+.PHONY: generate-schema
+generate-schema:
+	$(python) -c "from opentrons_shared_data.$(target) import generate_schema; print(generate_schema())" > ./${target}/schemas/${version}.json
+
+%-schema:
+	$(MAKE) generate-schema target=$*

package/buildroot.mk

@@ -0,0 +1,35 @@
+################################################################################
+#
+# python-opentrons-shared-data
+#
+################################################################################
+include $(BR2_EXTERNAL_OPENTRONS_MONOREPO_PATH)/scripts/python.mk
+
+define OTSHAREDDATA_CALL_PBU
+	$(shell python $(BR2_EXTERNAL_OPENTRONS_MONOREPO_PATH)/scripts/python_build_utils.py shared-data $(or $(OPENTRONS_PROJECT),robot-stack) $(1))
+endef
+
+PYTHON_OPENTRONS_SHARED_DATA_VERSION = $(call OTSHAREDDATA_CALL_PBU,get_version)
+PYTHON_OPENTRONS_SHARED_DATA_LICENSE = Apache-2
+PYTHON_OPENTRONS_SHARED_DATA_LICENSE_FILES = $(BR2_EXTERNAL_OPENTRONS_MONOREPO_PATH)/LICENSE
+PYTHON_OPENTRONS_SHARED_DATA_SETUP_TYPE = hatch
+PYTHON_OPENTRONS_SHARED_DATA_SITE_METHOD = local
+PYTHON_OPENTRONS_SHARED_DATA_SITE = $(BR2_EXTERNAL_OPENTRONS_MONOREPO_PATH)
+PYTHON_OPENTRONS_SHARED_DATA_DEPENDENCIES = host-python-hatch-vcs host-python-hatch-vcs-tunable
+PYTHON_OPENTRONS_SHARED_DATA_SUBDIR = shared-data
+PYTHON_OPENTRONS_SHARED_DATA_ENV = \
+  HATCH_VCS_TUNABLE_TAG_PATTERN="$(call git_tag_regex_for_project,$(PROJECT))" \
+  HATCH_VCS_TUNABLE_RAW_OPTIONS="$(call hatch_raw_options_for_project,$(PROJECT));root=$(shell realpath --relative-to=$(PYTHON_OPENTRONS_SHARED_DATA_BUILDDIR) $(BR2_EXTERNAL_OPENTRONS_MONOREPO_PATH))"
+
+define PYTHON_OPENTRONS_SHARED_DATA_INSTALL_VERSION
+	echo '$(call OTSHAREDDATA_CALL_PBU,dump_br_version)' > $(BINARIES_DIR)/opentrons-shared-data-version.json
+endef
+
+ot_sd_name := python-opentrons-shared-data
+
+export OPENTRONS_GIT_DIR=$(BR2_EXTERNAL_OPENTRONS_MONOREPO_PATH)
+
+# Calling inner-python-package directly instead of using python-package macro
+# because our directory layout doesn’t conform to buildroot’s expectation of
+# having the directory name be the package name
+$(eval $(call inner-python-package,$(ot_sd_name),$(call UPPERCASE,$(ot_sd_name)),$(call UPPERCASE,$(ot_sd_name)),target))

package/command/index.ts

@@ -5,9 +5,10 @@ import commandSchemaV10 from './schemas/10.json'
 import commandSchemaV11 from './schemas/11.json'
 import commandSchemaV12 from './schemas/12.json'
 import commandSchemaV13 from './schemas/13.json'
+import commandSchemaV14 from './schemas/14.json'
 
 export * from './types/index'
-export const commandSchemaLatest = commandSchemaV13
+export const commandSchemaLatest = commandSchemaV14
 
 export {
   commandSchemaV7,
@@ -17,4 +18,5 @@ export {
   commandSchemaV11,
   commandSchemaV12,
   commandSchemaV13,
+  commandSchemaV14,
 }