diff --git a/.github/workflows/unit-tests.yml b/.github/workflows/unit-tests.yml index 5c97fdf..10c6c10 100644 --- a/.github/workflows/unit-tests.yml +++ b/.github/workflows/unit-tests.yml @@ -1,4 +1,4 @@ -name: Innoldb Test Coverage +name: qldb-orm Test Coverage on: push: @@ -33,19 +33,19 @@ jobs: run: | python -m pip install --upgrade pip pip install build - pip install -r ./src/innoldb/tests/requirements.txt + pip install -r ./src/qldb-orm/tests/requirements.txt curl https://deepsource.io/cli | sh - name: Build test application run: | VERSION=$(cat version.txt) python -m build cd dist - pip install innoldb-${VERSION}-py3-none-any.whl + pip install qldb-orm-${VERSION}-py3-none-any.whl cd .. shell: bash - name: Run unit tests and upload coverage run: | - coverage run --source="./src/innoldb/" \ + coverage run --source="./src/qldb-orm/" \ --omit="**/test_*.py","**/__init__.py" \ --module pytest \ --junit-xml=coverage-execution.xml diff --git a/README.md b/README.md index 8446d0d..3935a4b 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # makpar-innolab -## innoldb +## qldb-orm A simple [Object-Relation-Mapping](https://en.wikipedia.org/wiki/Object%E2%80%93relational_mapping) for a serverless [AWS Quantum Ledger Database](https://docs.aws.amazon.com/qldb/latest/developerguide/what-is.html) backend, and a command line utility for querying tables on those ledgers. @@ -14,7 +14,7 @@ The idea behind the *ORM* is to map document fields to native Python object attr **CRUD OPERATIONS** ```python -from innoldb.qldb import Document +from qldb-orm.qldb import Document # Create a document on `my_table` table. document = Document('my_table') @@ -27,7 +27,7 @@ document.save() ``` ```python -from innoldb.qldb import Document +from qldb-orm.qldb import Document # Load a document from `my_table` table. document = Document('my_table', id="123456") @@ -37,7 +37,7 @@ for val in document.field.nested_data.array: **Queries** ```python -from innoldb.qldb import Query +from qldb-orm.qldb import Query query = Query('my-table').find_by(field_name='field value') for document in query: @@ -48,20 +48,20 @@ for document in query: **CRUD Operations** ```shell -innoldb --table your-table --insert col1=val1 col2=val2 ... -innoldb --table your-table --id 123 --update col1=newval1 col2=newval2 +qldb-orm --table your-table --insert col1=val1 col2=val2 ... +qldb-orm --table your-table --id 123 --update col1=newval1 col2=newval2 ``` **Queries** ```shell -innoldb --table your-table --find column=this +qldb-orm --table your-table --find column=this ``` ### Read The Docs -- [innolqb documentation](https://makpar-innovation-laboratory.github.io/innoldb/) +- [innolqb documentation](https://makpar-innovation-laboratory.github.io/qldb-orm/) ### Code Quality -[![DeepSource](https://deepsource.io/gh/Makpar-Innovation-Laboratory/innoldb.svg/?label=active+issues&show_trend=true&token=0yUpU0SKBmqEg7qNHU2C65C6)](https://deepsource.io/gh/Makpar-Innovation-Laboratory/innoldb/?ref=repository-badge) -[![DeepSource](https://deepsource.io/gh/Makpar-Innovation-Laboratory/innoldb.svg/?label=resolved+issues&show_trend=true&token=0yUpU0SKBmqEg7qNHU2C65C6)](https://deepsource.io/gh/Makpar-Innovation-Laboratory/innoldb/?ref=repository-badge) +[![DeepSource](https://deepsource.io/gh/Makpar-Innovation-Laboratory/qldb-orm.svg/?label=active+issues&show_trend=true&token=0yUpU0SKBmqEg7qNHU2C65C6)](https://deepsource.io/gh/Makpar-Innovation-Laboratory/qldb-orm/?ref=repository-badge) +[![DeepSource](https://deepsource.io/gh/Makpar-Innovation-Laboratory/qldb-orm.svg/?label=resolved+issues&show_trend=true&token=0yUpU0SKBmqEg7qNHU2C65C6)](https://deepsource.io/gh/Makpar-Innovation-Laboratory/qldb-orm/?ref=repository-badge) diff --git a/docs/build/html/CLI.html b/docs/build/html/CLI.html index 143c9e8..19b92dc 100644 --- a/docs/build/html/CLI.html +++ b/docs/build/html/CLI.html @@ -47,7 +47,7 @@ - Command Line Usage — innoldb v1.0.10 documentation + Command Line Usage — qldb-orm v1.0.10 documentation @@ -81,7 +81,7 @@