Metadata-Version: 2.1
Name: cranky
Version: 0.1.0b2
Summary: CrankDB python database driver.
Home-page: https://github.com/shreybatra/cranky
Author: Shrey Batra
Author-email: shreybatra97@gmail.com
License: UNKNOWN
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENCE
Requires-Dist: grpcio
Requires-Dist: google
Requires-Dist: protobuf

# Cranky (CrankDB Python Driver)

Cranky is the database driver for CrankDB for python applications.

# Pre requisites
Setup [CrankDB](https://github.com/shreybatra/crankdb) and get it started.


# Documentation

```python
from cranky import Cranky

# setup a new connection

conn = Cranky(host="localhost", port="9876") # default values

# Cranky follows almost similar API methods as Crank CLI.

# You can set any type of JSON seriable value at any key.
conn.set(key, value)

# Get a key
conn.get(key)
# Returns a DataPacket object with `dataType` attribute and corresponding value field `jsonVal`, `stringVal`, etc.


# Find multiple JSON documents using Find
conn.find({key: value}) #Applies a search and returns every key having JSON obj with key=value.
# Returns a list of DataPackets with dataType and jsonVal attributes.

conn.find({}) # returns all JSON (dict) type key values.
```

