Metadata-Version: 2.4
Name: microdbx
Version: 0.1.1
Summary: Lightweight key-value database for microcontrollers with Flash and RAM storage backends.
Author: netcorelink
License: MIT
Project-URL: Homepage, https://github.com/netcorelink/microdbx
Project-URL: Repository, https://github.com/netcorelink/microdbx
Project-URL: Documentation, https://github.com/netcorelink/microdbx#readme
Keywords: db,flash,ram,microcontroller,micropython,iot
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Intended Audience :: Developers
Classifier: Typing :: Typed
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Dynamic: license-file

<p align="center">
  <img alt="golangci-lint logo" src="https://avatars.githubusercontent.com/u/252895549?s=400&u=6c747c431c2844620af7772fcd716ef423a6ab1d&v=4" height="150" />
  <h3 align="center">netcorelink/microdbx</h3>
  <p align="center">Lightweight key-value database for microcontrollers with Flash and RAM storage backends.</p>
</p>

---

`netcorelink/microdbx` is a Lightweight key-value database for microcontrollers with Flash and RAM storage backends.

## Install by `pip` `microdbx`

```bash
pip install microdbx
```

## Install by `MicroPython` `microdbx`

For MicroPython, installation is performed by copying `microdbx/*` the library files to the device's file system.

example: `microdbx/*` - `:lib/*`

## A quick example

### Flash

```python
from microdbx import FlashDB

db = FlashDB(max_size=5)

db.set("wifi.ssid", "WiFi-DOM.ru")
db.set("wifi.password", "password")

print(db.get("wifi.password"))
```

### Ram

```python
from microdbx.ram import RAMDB

db = RAMDB(max_size=5)

db.set("wifi.ssid", "WiFi-DOM.ru")
db.set("wifi.password", "password")

print(db.get("wifi.ssid"))
```
