liminal-orm 1.0.0__tar.gz

liminal_orm-1.0.0/LICENSE.md

@@ -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 2024 The liminal-orm Authors
+
+   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.

liminal_orm-1.0.0/PKG-INFO

@@ -0,0 +1,200 @@
+Metadata-Version: 2.1
+Name: liminal-orm
+Version: 1.0.0
+Summary: An ORM and toolkit that builds on top of Benchling's platform to keep your schemas and downstream code dependencies in sync.
+Author: ndamania00
+Author-email: ndamania00@gmail.com
+Requires-Python: >=3.9,<4
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Requires-Dist: benchling-sdk (>=1.8.0)
+Requires-Dist: bs4 (>=0.0.2,<0.0.3)
+Requires-Dist: pandas (>=2.2.3,<3.0.0)
+Requires-Dist: pydantic (>=2.9.2,<3.0.0)
+Requires-Dist: requests (>=2.32.3,<3.0.0)
+Requires-Dist: rich (>=13.9.2,<14.0.0)
+Requires-Dist: sqlalchemy (==1.4.49)
+Requires-Dist: tenacity (>=9.0.0,<10.0.0)
+Requires-Dist: typer (>=0.12.5,<0.13.0)
+Description-Content-Type: text/markdown
+
+# [Liminal ORM](#liminal-orm)
+
+Liminal ORM<sup>1</sup> is a Python package that builds on top of [Benchling](https://www.benchling.com/)'s LIMS<sup>2</sup> platform to keep your Benchling schemas and downstream code dependencies in sync. Liminal provides an ORM framework using [SQLAlchemy](https://github.com/sqlalchemy/sqlalchemy) that allows you to define all your Benchling schemas in code. This creates a single source of truth that Benchling managers can use to keep multiple tenants in sync. This enables a code-first approach for managing Benchling tenants and accessing Benchling data. With the schemas defined in code, you can now take advantage of the additional capabilities that the Liminal toolkit provides. This includes:
+
+- The ability to run migrations to your Benchling tenant(s) through an easy to use CLI<sup>3</sup>.
+- One source of truth defined in code for your Benchling schema model that your many Benchling tenants can stay in sync with.
+- Easy to implement validation rules to reflect business logic for all of your Benchling entities.
+- Strongly typed queries for all your Benchling entities.
+- CI/CD integration with GitHub Actions to ensure that your Benchling schemas and code are always in sync.
+- And more!
+
+Benchling is an industry standard cloud platform for life sciences R&D. Liminal builds on top of Benchling's platform and assumes that you already have a Benchling tenant set up and have (or have access to) an admin user account. If not, learn more about getting started with Benchling [here](https://www.benchling.com/explore-benchling)!
+
+For a full and in-depth overview of Liminal, please refer to our [full documentation](coming soon). Below is a [quickstart guide](#getting-started) to get you Liminal set up in your project.
+
+Reach out in the [Discussions](https://github.com/dynotx/liminal-orm/discussions) forum with any questions or to simply introduce yourself! If you run into any issues, during setup or usage, don't hesitate to post in [Issues](https://github.com/dynotx/liminal-orm/issues) or reach out directly at <opensource@dynotx.com>. You can expect responses within 48 hours :)
+
+<img width="793" alt="liminal_simple_graph" src="https://github.com/user-attachments/assets/52e32cd0-3407-49f5-b100-5763bee3830c">
+
+## Table of Contents
+
+- [Overview](#liminal-orm)
+- [Getting Started](#getting-started)
+  - [Installation](#installation)
+  - [Setup](#setup)
+  - [Migration](#migration)
+  - [Toolkit](#toolkit)
+- [Community](#community)
+- [Contributing](#contributing)
+- [License](#license)
+- [Acknowledgements](#acknowledgements)
+- [Footnotes](#footnotes)
+
+## [Getting Started](#getting-started)
+
+Note: Liminal requires you to have (or have access to) an admin user account for your Benchling tenant. If you run into any issues, please reach out to us on the [Discussions](https://github.com/dynotx/liminal-orm/discussions/categories/q-a) forum and we'll be happy to help!
+
+### [Installation](#installation)
+
+via pip: `pip install liminal-orm`
+
+via github: `python -m pip install git+https://github.com/dynotx/liminal-orm.git --ignore-installed`
+
+### [Setup](#setup)
+
+1. `cd` into the directory where you want to instantiate your *Liminal environment*. This will be the root directory where your schemas will live. Note: the Liminal CLI must always be run from within this root directory.
+
+2. Run `liminal init` to initialize your Liminal project. This will create a liminal/ directory with an env.py file and a versions/ directory with an empty first revision file.
+
+3. Populate the env.py file with your Benchling connection information, following the instructions in the file. For example:
+
+    ```python
+    from liminal.connection import BenchlingConnection
+
+    PROD_CURRENT_REVISION_ID = "12b31776a755b"
+
+    # It is highly recommended to use a secrets manager to store your credentials.
+    connection = BenchlingConnection(
+        tenant_name="pizzahouse-prod",
+        tenant_alias="prod",
+        current_revision_id_var_name="PROD_CURRENT_REVISION_ID",
+        api_client_id="my-secret-api-client-id",
+        api_client_secret="my-secret-api-client-secret",
+        warehouse_connection_string="my-warehouse-connection-string",
+        internal_api_admin_email="my-secret-internal-api-admin-email",
+        internal_api_admin_password="my-secret-internal-api-admin-password",
+    )
+    ```
+
+4. If your Benchling tenant has pre-existing schemas, run `liminal generate-files` to populate the root directory with the schema files. Your file structure should now look like this:
+
+    ```text
+    benchling/
+        liminal/
+            env.py
+            versions/
+                <revision_id>_initial_init_revision.py
+        dropdowns/
+            ...
+        entity_schemas/
+            ...
+    ```
+
+5. Add your schema imports to the env.py file. For example:
+
+    ```python
+    from pizzahouse.dropdowns import *
+    from pizzahouse.entity_schemas import *
+    ...
+    ```
+
+6. Set up is complete! You're now ready to start using your schemas defined in code as the single source of truth for your Benchling tenant(s). Refer to the [Migration](#migration) section to learn about how you make a change to your Benchling schema model. Refer to the [Toolkit](#toolkit) section to learn about the additional features the Liminal toolkit provides.
+
+## [Migration](#migration)
+
+This section will walk you through the process of making a change to your Benchling schema model and syncing it to your Benchling tenant(s).
+
+1. Make a change to your Benchling schema model!
+
+2. Run `liminal autogenerate <benchling_tenant_name> <description_of_changes>` to generate a new revision file. For example: `liminal autogenerate prod "new oven schema"`. This will create a new revision file in the `versions/` directory. This revision file defines the set of steps (or "operations") that will be needed to make the targeted Benchling tenant up to date with the changes made in the schema model.
+
+    If I have multiple Benchling tenants, do I have to run `autogenerate` for each tenant?
+
+    No, Liminal only keeps a single thread of revision history that are linked together for easy upgrade/downgrade. In the case of multiple tenants that need to stay in sync together, we recommend pointing `autogenerate` at your production tenant, or the tenant that acts as the production environment. When ready, you can then apply the revision to all your tenants.
+
+3. Review the generated revision file and set of operations to ensure that it is accurate.
+
+4. Run `liminal upgrade <benchling_tenant_name> <upgrade_descriptor>` to migrate your Benchling tenant(s) to the new schema. For example: `liminal upgrade prod head`. This will apply the revision to the targeted Benchling tenant. For example: `liminal upgrade prod head` will apply the revision to the production tenant.
+
+5. Check out your changes on your Benchling tenant(s)!
+
+## [Toolkit](#toolkit)
+
+With your schemas defined in code, you can now take advantage of the additional capabilities that the Liminal toolkit provides.
+
+1. Entity validation: Easily create custom validation rules for your Benchling entities.
+
+    ```python
+    from dyno.liminal.orm.base_model import BaseModel
+    from dyno.liminal.orm.mixins import CustomEntityMixin
+
+    class Pizza(BaseModel, CustomEntityMixin):
+        ...
+
+        @validator(BenchlingReportLevel.HIGH)
+        def cook_temp_time(self):
+            if self.cook_time is not None and self.cook_temp is None:
+                raise ValueError("Cook temp is required if cook time is set")
+            if self.cook_time is None and self.cook_temp is not None:
+                raise ValueError("Cook time is required if cook temp is set")
+    ```
+
+2. Strongly typed queries: Write type-safe queries using SQLAlchemy to access your Benchling entities.
+
+    ```python
+    with BenchlingSession(benchling_connection, with_db=True) as session:
+        pizza = session.query(Pizza).filter(Pizza.name == "Margherita").first()
+        print(pizza)
+    ```
+
+3. CI/CD integration: Use Liminal to automatically generate and apply your revision files to your Benchling tenant(s) as part of your CI/CD pipeline.
+
+4. And more to come!
+
+## [Community](#community)
+
+We're excited to hear from you! Feel free to introduce yourself on the [Liminal GitHub Discussions page](https://github.com/dynotx/liminal-orm/discussions/categories/intros)
+
+Please refer to [CODE_OF_CONDUCT.md](./CODE_OF_CONDUCT.md) to learn more about how to interact with the community.
+
+Please refer to [GOVERNANCE.md](./GOVERNANCE.md) to learn more about the project's governance structure.
+
+## [Contributing](#contributing)
+
+Contributions of any kind are welcome and encouraged! This ranges from feedback and feature requests all the way to code contributions.
+Please refer to [CONTRIBUTING.md](./CONTRIBUTING.md) to learn how to contribute to Liminal!
+
+## [License](#license)
+
+Liminal ORM is distributed under the [Apache License, Version 2.0](./LICENSE.md).
+
+## [Acknowledgements](#acknowledgements)
+
+This project could not have been started without the support of Dyno Therapeutics and the help of the following people.
+
+- [Steve Northup](https://github.com/steve-dyno): For being an incredibly supportive manager and mentor, making key technical contributions, and providing guidance on the project's direction.
+- [Joyce Samson](https://github.com/samsonjoyce): For being Liminal's first power user at Dyno Therapeutics, providing valuable feedback that informed the project's direction, and coming up with Liminal's name.
+- [David Levy-Booth](https://github.com/davidlevybooth): For providing leadership and guidance on releasing this as an open source software.
+- The rest of the Dyno team...
+
+## [Footnotes](#footnotes)
+
+ORM<sup>1</sup>: Object-Relational Mapper. An ORM is a piece of software designed to translate between the data representations used by databases and those used in object-oriented programming. In this case, Liminal provides an ORM layer built specifically for Benchling that allows for users to quickly and easily define Benchling entities in code. [SQLAlchemy](https://github.com/sqlalchemy/sqlalchemy) is the underlying ORM that Liminal uses to interact with your Benchling tenant(s) and is an open-source software that is an industry standard software.
+
+LIMS<sup>2</sup>: Laboratory Information Management System. A LIMS is a piece of software that allows you to effectively manage samples and associated data. [Benchling](https://www.benchling.com/) is an industry-leading LIMS software.
+
+CLI<sup>3</sup>: Command Line Interface. A CLI is a piece of software that allows you to interact with a software program via the command line. Liminal provides a CLI that allows you to interact with your Liminal environment. This project uses [Typer](https://github.com/fastapi/typer) to construct the CLI
+

liminal_orm-1.0.0/README.md

@@ -0,0 +1,177 @@
+# [Liminal ORM](#liminal-orm)
+
+Liminal ORM<sup>1</sup> is a Python package that builds on top of [Benchling](https://www.benchling.com/)'s LIMS<sup>2</sup> platform to keep your Benchling schemas and downstream code dependencies in sync. Liminal provides an ORM framework using [SQLAlchemy](https://github.com/sqlalchemy/sqlalchemy) that allows you to define all your Benchling schemas in code. This creates a single source of truth that Benchling managers can use to keep multiple tenants in sync. This enables a code-first approach for managing Benchling tenants and accessing Benchling data. With the schemas defined in code, you can now take advantage of the additional capabilities that the Liminal toolkit provides. This includes:
+
+- The ability to run migrations to your Benchling tenant(s) through an easy to use CLI<sup>3</sup>.
+- One source of truth defined in code for your Benchling schema model that your many Benchling tenants can stay in sync with.
+- Easy to implement validation rules to reflect business logic for all of your Benchling entities.
+- Strongly typed queries for all your Benchling entities.
+- CI/CD integration with GitHub Actions to ensure that your Benchling schemas and code are always in sync.
+- And more!
+
+Benchling is an industry standard cloud platform for life sciences R&D. Liminal builds on top of Benchling's platform and assumes that you already have a Benchling tenant set up and have (or have access to) an admin user account. If not, learn more about getting started with Benchling [here](https://www.benchling.com/explore-benchling)!
+
+For a full and in-depth overview of Liminal, please refer to our [full documentation](coming soon). Below is a [quickstart guide](#getting-started) to get you Liminal set up in your project.
+
+Reach out in the [Discussions](https://github.com/dynotx/liminal-orm/discussions) forum with any questions or to simply introduce yourself! If you run into any issues, during setup or usage, don't hesitate to post in [Issues](https://github.com/dynotx/liminal-orm/issues) or reach out directly at <opensource@dynotx.com>. You can expect responses within 48 hours :)
+
+<img width="793" alt="liminal_simple_graph" src="https://github.com/user-attachments/assets/52e32cd0-3407-49f5-b100-5763bee3830c">
+
+## Table of Contents
+
+- [Overview](#liminal-orm)
+- [Getting Started](#getting-started)
+  - [Installation](#installation)
+  - [Setup](#setup)
+  - [Migration](#migration)
+  - [Toolkit](#toolkit)
+- [Community](#community)
+- [Contributing](#contributing)
+- [License](#license)
+- [Acknowledgements](#acknowledgements)
+- [Footnotes](#footnotes)
+
+## [Getting Started](#getting-started)
+
+Note: Liminal requires you to have (or have access to) an admin user account for your Benchling tenant. If you run into any issues, please reach out to us on the [Discussions](https://github.com/dynotx/liminal-orm/discussions/categories/q-a) forum and we'll be happy to help!
+
+### [Installation](#installation)
+
+via pip: `pip install liminal-orm`
+
+via github: `python -m pip install git+https://github.com/dynotx/liminal-orm.git --ignore-installed`
+
+### [Setup](#setup)
+
+1. `cd` into the directory where you want to instantiate your *Liminal environment*. This will be the root directory where your schemas will live. Note: the Liminal CLI must always be run from within this root directory.
+
+2. Run `liminal init` to initialize your Liminal project. This will create a liminal/ directory with an env.py file and a versions/ directory with an empty first revision file.
+
+3. Populate the env.py file with your Benchling connection information, following the instructions in the file. For example:
+
+    ```python
+    from liminal.connection import BenchlingConnection
+
+    PROD_CURRENT_REVISION_ID = "12b31776a755b"
+
+    # It is highly recommended to use a secrets manager to store your credentials.
+    connection = BenchlingConnection(
+        tenant_name="pizzahouse-prod",
+        tenant_alias="prod",
+        current_revision_id_var_name="PROD_CURRENT_REVISION_ID",
+        api_client_id="my-secret-api-client-id",
+        api_client_secret="my-secret-api-client-secret",
+        warehouse_connection_string="my-warehouse-connection-string",
+        internal_api_admin_email="my-secret-internal-api-admin-email",
+        internal_api_admin_password="my-secret-internal-api-admin-password",
+    )
+    ```
+
+4. If your Benchling tenant has pre-existing schemas, run `liminal generate-files` to populate the root directory with the schema files. Your file structure should now look like this:
+
+    ```text
+    benchling/
+        liminal/
+            env.py
+            versions/
+                <revision_id>_initial_init_revision.py
+        dropdowns/
+            ...
+        entity_schemas/
+            ...
+    ```
+
+5. Add your schema imports to the env.py file. For example:
+
+    ```python
+    from pizzahouse.dropdowns import *
+    from pizzahouse.entity_schemas import *
+    ...
+    ```
+
+6. Set up is complete! You're now ready to start using your schemas defined in code as the single source of truth for your Benchling tenant(s). Refer to the [Migration](#migration) section to learn about how you make a change to your Benchling schema model. Refer to the [Toolkit](#toolkit) section to learn about the additional features the Liminal toolkit provides.
+
+## [Migration](#migration)
+
+This section will walk you through the process of making a change to your Benchling schema model and syncing it to your Benchling tenant(s).
+
+1. Make a change to your Benchling schema model!
+
+2. Run `liminal autogenerate <benchling_tenant_name> <description_of_changes>` to generate a new revision file. For example: `liminal autogenerate prod "new oven schema"`. This will create a new revision file in the `versions/` directory. This revision file defines the set of steps (or "operations") that will be needed to make the targeted Benchling tenant up to date with the changes made in the schema model.
+
+    If I have multiple Benchling tenants, do I have to run `autogenerate` for each tenant?
+
+    No, Liminal only keeps a single thread of revision history that are linked together for easy upgrade/downgrade. In the case of multiple tenants that need to stay in sync together, we recommend pointing `autogenerate` at your production tenant, or the tenant that acts as the production environment. When ready, you can then apply the revision to all your tenants.
+
+3. Review the generated revision file and set of operations to ensure that it is accurate.
+
+4. Run `liminal upgrade <benchling_tenant_name> <upgrade_descriptor>` to migrate your Benchling tenant(s) to the new schema. For example: `liminal upgrade prod head`. This will apply the revision to the targeted Benchling tenant. For example: `liminal upgrade prod head` will apply the revision to the production tenant.
+
+5. Check out your changes on your Benchling tenant(s)!
+
+## [Toolkit](#toolkit)
+
+With your schemas defined in code, you can now take advantage of the additional capabilities that the Liminal toolkit provides.
+
+1. Entity validation: Easily create custom validation rules for your Benchling entities.
+
+    ```python
+    from dyno.liminal.orm.base_model import BaseModel
+    from dyno.liminal.orm.mixins import CustomEntityMixin
+
+    class Pizza(BaseModel, CustomEntityMixin):
+        ...
+
+        @validator(BenchlingReportLevel.HIGH)
+        def cook_temp_time(self):
+            if self.cook_time is not None and self.cook_temp is None:
+                raise ValueError("Cook temp is required if cook time is set")
+            if self.cook_time is None and self.cook_temp is not None:
+                raise ValueError("Cook time is required if cook temp is set")
+    ```
+
+2. Strongly typed queries: Write type-safe queries using SQLAlchemy to access your Benchling entities.
+
+    ```python
+    with BenchlingSession(benchling_connection, with_db=True) as session:
+        pizza = session.query(Pizza).filter(Pizza.name == "Margherita").first()
+        print(pizza)
+    ```
+
+3. CI/CD integration: Use Liminal to automatically generate and apply your revision files to your Benchling tenant(s) as part of your CI/CD pipeline.
+
+4. And more to come!
+
+## [Community](#community)
+
+We're excited to hear from you! Feel free to introduce yourself on the [Liminal GitHub Discussions page](https://github.com/dynotx/liminal-orm/discussions/categories/intros)
+
+Please refer to [CODE_OF_CONDUCT.md](./CODE_OF_CONDUCT.md) to learn more about how to interact with the community.
+
+Please refer to [GOVERNANCE.md](./GOVERNANCE.md) to learn more about the project's governance structure.
+
+## [Contributing](#contributing)
+
+Contributions of any kind are welcome and encouraged! This ranges from feedback and feature requests all the way to code contributions.
+Please refer to [CONTRIBUTING.md](./CONTRIBUTING.md) to learn how to contribute to Liminal!
+
+## [License](#license)
+
+Liminal ORM is distributed under the [Apache License, Version 2.0](./LICENSE.md).
+
+## [Acknowledgements](#acknowledgements)
+
+This project could not have been started without the support of Dyno Therapeutics and the help of the following people.
+
+- [Steve Northup](https://github.com/steve-dyno): For being an incredibly supportive manager and mentor, making key technical contributions, and providing guidance on the project's direction.
+- [Joyce Samson](https://github.com/samsonjoyce): For being Liminal's first power user at Dyno Therapeutics, providing valuable feedback that informed the project's direction, and coming up with Liminal's name.
+- [David Levy-Booth](https://github.com/davidlevybooth): For providing leadership and guidance on releasing this as an open source software.
+- The rest of the Dyno team...
+
+## [Footnotes](#footnotes)
+
+ORM<sup>1</sup>: Object-Relational Mapper. An ORM is a piece of software designed to translate between the data representations used by databases and those used in object-oriented programming. In this case, Liminal provides an ORM layer built specifically for Benchling that allows for users to quickly and easily define Benchling entities in code. [SQLAlchemy](https://github.com/sqlalchemy/sqlalchemy) is the underlying ORM that Liminal uses to interact with your Benchling tenant(s) and is an open-source software that is an industry standard software.
+
+LIMS<sup>2</sup>: Laboratory Information Management System. A LIMS is a piece of software that allows you to effectively manage samples and associated data. [Benchling](https://www.benchling.com/) is an industry-leading LIMS software.
+
+CLI<sup>3</sup>: Command Line Interface. A CLI is a piece of software that allows you to interact with a software program via the command line. Liminal provides a CLI that allows you to interact with your Liminal environment. This project uses [Typer](https://github.com/fastapi/typer) to construct the CLI

liminal_orm-1.0.0/liminal/base/base_dropdown.py

@@ -0,0 +1,56 @@
+from abc import ABC
+from typing import Any
+
+
+class BaseDropdown(ABC):
+    __benchling_name__: str
+    __allowed_values__: list[str]
+
+    _existing_benchling_names: set[str] = set()
+
+    def __new__(cls, **kwargs: Any) -> "BaseDropdown":
+        if not hasattr(cls, "__allowed_values__"):
+            raise ValueError(f"{cls.__name__} must define __allowed_values__")
+        if not hasattr(cls, "__benchling_name__") or not cls.__benchling_name__:
+            raise ValueError(f"{cls.__name__} must define __benchling_name__")
+        if len(cls.__allowed_values__) != len(set(cls.__allowed_values__)):
+            raise ValueError(
+                f"{cls.__name__} must have unique values in __allowed_values__"
+            )
+
+        if cls.__benchling_name__ in cls._existing_benchling_names:
+            raise ValueError(
+                f"{cls.__benchling_name__} is already used as a benchling name."
+            )
+        cls._existing_benchling_names.add(cls.__benchling_name__)
+        return super().__new__(cls, **kwargs)
+
+    @classmethod
+    def validate(cls, *values: str | None) -> None:
+        err_values = []
+        for value in values:
+            if value and value not in cls.__allowed_values__:
+                err_values.append(value)
+        if len(err_values) > 0:
+            raise ValueError(
+                f"{', '.join(err_values)} are not valid {cls.__benchling_name__} dropdown values."
+            )
+
+    @classmethod
+    def get_all_subclasses(
+        cls, names: set[str] | None = None
+    ) -> list[type["BaseDropdown"]]:
+        if names is None:
+            return cls.__subclasses__()
+        dropdowns = {
+            name: subclass
+            for subclass in cls.__subclasses__()
+            for name in names
+            if name in (subclass.__name__, subclass.__benchling_name__)
+        }
+        if len(dropdowns.keys()) != len(set(names)):
+            missing_dropdowns = set(names) - set(dropdowns.keys())
+            raise ValueError(
+                f"No dropdown subclass found for the following class names or warehouse names: {', '.join(missing_dropdowns)}"
+            )
+        return list(dropdowns.values())