Metadata-Version: 2.1
Name: hyperdb_py
Version: 0.1.1
Summary: HyperDB Python Client
Project-URL: Homepage, https://github.com/AfaanBilal/hyperdb-py
Project-URL: Bug Tracker, https://github.com/AfaanBilal/hyperdb-py/issues
Project-URL: Source, https://github.com/AfaanBilal/hyperdb-py
Author-email: Afaan Bilal <afaanbilal@gmail.com>
License-File: LICENSE
Keywords: client,hyperdb,in-memory
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.7
Description-Content-Type: text/markdown

HyperDB Python Client
=====================

Author: **[Afaan Bilal](https://afaan.dev)**

## Introduction
**HyperDB Python** is a Python client package for the [HyperDB server](https://github.com/AfaanBilal/hyperdb).

## Installation
````
pip install hyperdb_py
````

## Example usage
````py
from hyperdb_py.HyperDB import HyperDB

# Setup with address (default: http:#localhost:8765)
hyperdb = HyperDB("http://localhost:8765")

# OR
# Setup with address and authentication
# hyperdb = new HyperDB("http://localhost:8765", "username", "password")

# Ping the server
r = hyperdb.ping()
print(str(r)) # True

# Get the version number
r = hyperdb.version()
print(str(r)) # "[HyperDB v0.1.0 (https:#afaan.dev)]"

# Set a value
r = hyperdb.set("test", "value")
print(str(r)) # value

# Check if a key is present
r = hyperdb.has("test")
print(str(r)) # True

# Get a value
r = hyperdb.get("test")
print(str(r)) # value

# Get all stored data
r = hyperdb.all()
print(str(r)) # {test: "value"}

# Remove a key
r = hyperdb.delete("test")
print(str(r)) # True

# Delete all stored data
r = hyperdb.clear()
print(str(r)) # True

# Check if the store is empty
r = hyperdb.empty()
print(str(r)) # True

# Persist the store to disk
r = hyperdb.save()
print(str(r)) # True

# Reload the store from disk
r = hyperdb.reload()
print(str(r)) # True

# Delete all store data from memory and disk
r = hyperdb.reset()
print(str(r)) # True
````

## Contributing
All contributions are welcome. Please create an issue first for any feature request
or bug. Then fork the repository, create a branch and make any changes to fix the bug
or add the feature and create a pull request. That's it!
Thanks!

## License
**HyperDB Python** is released under the MIT License.
Check out the full license [here](LICENSE).
