Skip to content

Commit

Permalink
update readme links
Browse files Browse the repository at this point in the history
  • Loading branch information
Grant Moore committed Mar 20, 2022
1 parent 23a3b36 commit 0b4dc2f
Show file tree
Hide file tree
Showing 7 changed files with 97 additions and 11 deletions.
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# makpar-innolab
# makpar-innovation-laboratory

## qldb-orm
## innoldb

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.

Expand All @@ -14,7 +14,7 @@ The idea behind the *ORM* is to map document fields to native Python object attr
**CRUD OPERATIONS**

```python
from qldb-orm.qldb import Document
from innoldb.qldb import Document

# Create a document on `my_table` table.
document = Document('my_table')
Expand All @@ -27,7 +27,7 @@ document.save()
```

```python
from qldb-orm.qldb import Document
from innoldb.qldb import Document

# Load a document from `my_table` table.
document = Document('my_table', id="123456")
Expand All @@ -37,7 +37,7 @@ for val in document.field.nested_data.array:

**Queries**
```python
from qldb-orm.qldb import Query
from innoldb.qldb import Query

query = Query('my-table').find_by(field_name='field value')
for document in query:
Expand All @@ -48,18 +48,18 @@ for document in query:

**CRUD Operations**
```shell
qldb-orm --table your-table --insert col1=val1 col2=val2 ...
qldb-orm --table your-table --id 123 --update col1=newval1 col2=newval2
innoldb --table your-table --insert col1=val1 col2=val2 ...
innoldb --table your-table --id 123 --update col1=newval1 col2=newval2
```

**Queries**
```shell
qldb-orm --table your-table --find column=this
innoldb --table your-table --find column=this
```

### Read The Docs

- [innolqb documentation](https://makpar-innovation-laboratory.github.io/qldb-orm/)
- [innoldb documentation](https://makpar-innovation-laboratory.github.io/innoldb/)

### Code Quality

Expand Down
Empty file modified scripts/distribute
100644 → 100755
Empty file.
Empty file modified scripts/install
100644 → 100755
Empty file.
Empty file modified scripts/test
100644 → 100755
Empty file.
4 changes: 2 additions & 2 deletions setup.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ include_package_data = True

[options.entry_points]
console_scripts =
qldb-orm = qldb-orm.main:entrypoint
innoldb = innoldb.main:entrypoint

[options.packages.find]
where=src
where=src
85 changes: 85 additions & 0 deletions src/qldb_orm.egg-info/PKG-INFO
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
Metadata-Version: 2.1
Name: qldb-orm
Version: 1.0.14
Summary: a ORM model for AWS QLDB
Home-page: https://innolab-coverage.makpar-innovation.net
Author: Makpar Innovation Lab
Author-email: [email protected]
License: GNU GPL v3
Project-URL: Documentation, https://makpar-innovation-laboratory.github.io/qldb-orm/
Project-URL: Source, https://github.com/Makpar-Innovation-Laboratory/qldb-orm
Keywords: aws,qldb,quantum-ledger-database,orm
Platform: any
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE

# makpar-innolab

## 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.

**NOTE**: The user or process using this library must have an [IAM policy that allows access to QLDB](https://docs.aws.amazon.com/qldb/latest/developerguide/security-iam.html).


### ORM

The idea behind the *ORM* is to map document fields to native Python object attributes, so that document values can be accessed by traversing the object property tree.

**CRUD OPERATIONS**

```python
from qldb-orm.qldb import Document

# Create a document on `my_table` table.
document = Document('my_table')
document.field = {
'nested_data': {
'array': ['colllection', 'of', 'things']
}
}
document.save()
```

```python
from qldb-orm.qldb import Document

# Load a document from `my_table` table.
document = Document('my_table', id="123456")
for val in document.field.nested_data.array:
print(val)
```

**Queries**
```python
from qldb-orm.qldb import Query

query = Query('my-table').find_by(field_name='field value')
for document in query:
print(f'Document({document.id}).field_name = {document.field_name}')
```

### CLI

**CRUD Operations**
```shell
qldb-orm --table your-table --insert col1=val1 col2=val2 ...
qldb-orm --table your-table --id 123 --update col1=newval1 col2=newval2
```

**Queries**
```shell
qldb-orm --table your-table --find column=this
```

### Read The Docs

- [innolqb documentation](https://makpar-innovation-laboratory.github.io/qldb-orm/)

### Code Quality

[![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)


1 change: 1 addition & 0 deletions src/qldb_orm.egg-info/dependency_links.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@

0 comments on commit 0b4dc2f

Please sign in to comment.