Skip to content

Commit fa92e69

Browse files
committed
Add draft readme
1 parent 4cb5308 commit fa92e69

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# ODM2DataModels
2+
3+
## What is this?
4+
odm2datamodels is a Python package that provides a set of object-relational mapping (ORM) data models for the [Observations Data Model Version 2.1](http://www.odm2.org/). This data models are built of the [SQLAlchemy](https://www.sqlalchemy.org/) and provide a convenient way of interfacing with an ODM2.1 database.
5+
6+
## Core Features
7+
The primary is the `ODM2DataModels` class, which once instantiated, provides access to the set of ORM ODM2.1 data models and an instance of an ODM2Engine which provide utility function to perform basic Create, Read, Update, Delete operations as well are read execution of custom SQLQueries constructed using a SQLAlchemy [Select object](https://docs.sqlalchemy.org/en/14/orm/queryguide.html#select-statements) or [Query Object](https://docs.sqlalchemy.org/en/14/orm/query.html#sqlalchemy.orm.Query)
8+
9+
## How to install?
10+
Presently the build files are only available on our [github repository](https://github.com/ODM2/ODM2DataModels)
11+
12+
Though we are aiming to release to the [Python Package Index (PyPI)](https://pypi.org/) and [Conda](https://docs.conda.io/en/latest/) in the near future.
13+
14+
## Testing and Database Dialect Support
15+
### Testing Method
16+
Presently very limited testing has been conducted and has primarily been through an implementation of a REST API with limited coverage of selected data models. Further expanding and automating testing is an area for future updates.
17+
### Database Dialect Support
18+
These data models have only been validated for a PostgreSQL database running a deployment of the ODM2.1 schema.
19+
20+
21+

0 commit comments

Comments
 (0)