From c22de9684db2ae0a76fb56eb2f19ea80222882df Mon Sep 17 00:00:00 2001 From: collerek Date: Sun, 2 Aug 2020 08:56:53 +0200 Subject: [PATCH] add travis and codecov --- .codecov.yml | 11 +++++++++++ .travis.yml | 19 +++++++++++++++++++ LICENSE => LICENSE.md | 0 README.md | 6 +++++- requirements.txt | 7 +++++++ 5 files changed, 42 insertions(+), 1 deletion(-) create mode 100644 .codecov.yml create mode 100644 .travis.yml rename LICENSE => LICENSE.md (100%) create mode 100644 requirements.txt diff --git a/.codecov.yml b/.codecov.yml new file mode 100644 index 0000000..033aafd --- /dev/null +++ b/.codecov.yml @@ -0,0 +1,11 @@ +coverage: + precision: 2 + round: down + range: "80...100" + + status: + project: yes + patch: yes + changes: yes + +comment: off \ No newline at end of file diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 0000000..c313696 --- /dev/null +++ b/.travis.yml @@ -0,0 +1,19 @@ +language: python + +dist: xenial + +cache: pip + +python: + - "3.6" + - "3.7" + - "3.8" + +install: + - pip install -U -r requirements.txt + +script: + - scripts/test + +after_script: + - codecov \ No newline at end of file diff --git a/LICENSE b/LICENSE.md similarity index 100% rename from LICENSE rename to LICENSE.md diff --git a/README.md b/README.md index 80f90a8..b3ebffa 100644 --- a/README.md +++ b/README.md @@ -22,6 +22,9 @@ MySQL, and SQLite. ORM is built with: Because ORM is built on SQLAlchemy core, you can use Alembic to provide database migrations. +The goal was to create a simple orm that can be used directly with FastApi that bases it's data validation on pydantic. +Initial work was inspired by [`encode/orm`][encode/orm] + **ORM is still under development: We recommend pinning any dependencies with `orm~=0.1`** **Note**: Use `ipython` to try this from the console, since it supports `await`. @@ -175,4 +178,5 @@ All fields are required unless one of the following is set: [sqlalchemy-core]: https://docs.sqlalchemy.org/en/latest/core/ [databases]: https://github.com/encode/databases -[pydantic]: https://pydantic-docs.helpmanual.io/ \ No newline at end of file +[pydantic]: https://pydantic-docs.helpmanual.io/ +[encode/orm]: \ No newline at end of file diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..7a4f7a2 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,7 @@ +databases[sqlite] +pydantic +sqlalchemy + +# Testing +pytest +pytest-cov \ No newline at end of file