https://github.com/un4gt/dicedb
A simple DiceDB client for Python
https://github.com/un4gt/dicedb
dicedb dicedb-sdk
Last synced: about 1 month ago
JSON representation
A simple DiceDB client for Python
- Host: GitHub
- URL: https://github.com/un4gt/dicedb
- Owner: un4gt
- Created: 2025-04-11T17:06:15.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2025-04-23T01:19:00.000Z (2 months ago)
- Last Synced: 2025-04-23T02:25:33.778Z (2 months ago)
- Topics: dicedb, dicedb-sdk
- Language: Python
- Homepage: https://pypi.org/project/dicedb/
- Size: 30.3 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# DiceDB for Python
⚠️ This is not an official sdk for python and still in development.
## Installation and Usage
### From PyPI
```bash
pip install dicedb
```
### From Source
Clone the repository and install the package:
```bash
$ git clone https://github.com/un4gt/dicedb.git --depth 1 --branch main
$ uv sync
$ uv buid
```
## Supported Commands
| command | description |
|:-------------:|:------------:|
| `decr` | `DECRBY` |
| `decrby` | `DECRBY` |
| `delete` | `DEL` |
| `echo` | `ECHO` |
| `exists` | `EXISTS` |
| `expire` | `EXPIRE` |
| `expire_at` | `EXPIREAT` |
| `expire_time` | `EXPIRETIME` |
| `flushdb` | `FLUSHDB` |
| `get` | `GET` |
| `get_del` | `GET_DEL` |
| `get_ex` | `GET_EX` |
| `hget` | `HGET` |
| `hget_all` | `HGETALL` |
| `hset` | `HSET` |
| `incr_by` | `INCRBY` |
| `incr` | `INCRBY` |
| `ping` | `PING` |
| `ttl` | `TTL` |
| `typeof` | `TYPE` |
| `set` | `SET` |
## Roadmap
- [ ] More documentation/tests/examples
- [ ] Support for all commands
- [ ] Connection pool
- [ ] Support for async
## Contributing
PRs and issues are welcome!
## About Developing
### Generate Python Proto Files
*cmd.proto and res.proto comes from https://github.com/DiceDB/dicedb-protos*
On Windows:
```bash
protoc -I=protos\ --python_out=src\dicedb\proto\ --pyi_out=src\dicedb\proto cmd.proto res.proto
```