Metadata-Version: 2.1
Name: datastore-client
Version: 0.0.3
Summary: A simple Google DataStore client
Home-page: https://github.com/Flickswitch/datastore-client
Author: Jethro Muller
Author-email: git@jethromuller.co.za
Requires-Python: >=3.6,<4.0
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Requires-Dist: google-cloud-datastore (>=1.7,<2.0)
Project-URL: Repository, https://github.com/Flickswitch/datastore-client
Description-Content-Type: text/markdown

# Simple DataStore Client

A simple Google DataStore client that exposes 3 functions.

```python
def set_key(entity_name: str, key_name: str, **properties: Any) -> None:
    ...
```

```python
def get_key(entity_name: str, key_name: str) -> Optional[Entity]:
    ...
```

```python
def query_entity(
    entity_name: str,
    *query_filters: Tuple[str, str, Any],
    projection: List[str]=None,
    limit: Optional[int]=None,
) -> Iterator:
    ...
```

## Examples

### Changing the `namespace`
The following will change the namespace for all function calls following it.

```python
from datastore_client.client import client


client.namespace = 'specific_namespace'
```

### `set_key`

```python
set_key(
    entity_name=RECHARGE_NOTES_ENTITY, 
    key_name=note_key, 
    username=username, 
    reference=reference, 
    note=notes,
)
```

### `get_key`

```python
get_key(LOGIN_ENTITY, username)
```

### `query_entity`

```python
product_list = list(query_entity(
    PRODUCT_ENTITY,
    ('network', '=', network_name),
    ('product_type', '=', product_code),
    ('bundle_size', '=', denomination),
    projection=['id'],
    limit=1,
))

print(product_list[0]['id'])
```

