Metadata-Version: 2.4
Name: translator_testing_model
Version: 0.4.0
Summary: This is the project description.
License: MIT
License-File: LICENSE
Author: Sierra Moxon
Author-email: sierra.taylor@gmail.com
Requires-Python: >=3.9,<3.13
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Provides-Extra: docs
Requires-Dist: bioregistry (>=0.11.1,<0.12.0)
Requires-Dist: bmt (>=1.4.0,<2.0.0)
Requires-Dist: linkml (>=1.7.8,<2.0.0) ; extra == "docs"
Requires-Dist: linkml-runtime (>=1.7.5,<2.0.0)
Requires-Dist: pandas (>=2.1.2,<3.0.0)
Requires-Dist: pydantic (>=2,<3)
Description-Content-Type: text/markdown

# Translator Testing Model

This is a preliminary schema repo for defining test cases in Translator that can be reused in different test suites.  e.g. a test case in plain language might be something like _"what drugs may treat MS? I expect fingolimod to return in the top 10 results in less than 5 mins."_  

Capturing these details in metadata that is parsable and usable by test runners is the objective of this schema.  We also want to harmonize our language and nomenclature for the metadata we need (which of these data are required and which are optional for each kind of test case, etc.) so that downstream testing code can utilize a common framework for understanding.

## Website

[https://TranslatorSRI.github.io/TranslatorTestingModel](https://TranslatorSRI.github.io/TranslatorTestingModel)

## Repository Structure

* [examples/](examples/) - example data
* [project/](project/) - project files (do not edit these)
* [src/](src/translator_testing_model/README.md) - source files (edit these)
  * [translator testing model specification](src/translator_testing_model/README.md)
    * [schema](src/translator_testing_model/schema/translator_testing_model.yaml) -- LinkML schema
      (edit this)
    * [datamodel](src/translator_testing_model/datamodel/README.md) -- generated
      Python datamodels
      * [Pydantic](src/translator_testing_model/datamodel/pydanticmodel.py) - this is a version 2 model.
      * [Python Dataclasses](src/translator_testing_model/datamodel/translator_testing_model.py)
* [tests/](tests/test_data.py) - Python tests

## Developer Documentation

<details>
The project uses [Poetry](https://python-poetry.org/) to manage its dependencies. Install Poetry then:

* `poetry shell`: start up a poetry shell virtual environment
* `poetry install`: to install required dependencies

Then use the `make` command to generate project artifacts:

* `make gen-project`: regenerates core project artifacts
* `make all`: make everything
* `make deploy`: deploys site

</details>

## Credits

This project was made with
[linkml-project-cookiecutter](https://github.com/linkml/linkml-project-cookiecutter).

