Skip to content

Commit

Permalink
Improve README
Browse files Browse the repository at this point in the history
  • Loading branch information
aamalev committed Oct 14, 2023
1 parent 38e90c8 commit 069bec9
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 2 deletions.
15 changes: 14 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# redis-rs

Python wrapper for redis-rs and redis_cluster_async
Python wrapper for redis-rs, bb8, bb8-redis, bb8-redis-cluster, deadpool-redis-cluster, redis_cluster_async

# Install

Expand All @@ -18,6 +18,7 @@ async def main():
"redis://redis-node001",
"redis://redis-node002",
max_size=1,
cluster=True,
) as x:
print(await x.execute(b"HSET", "fooh", "a", b"asdfg"))
print(await x.fetch_int("HSET", "fooh", "b", 11234567890))
Expand Down Expand Up @@ -46,3 +47,15 @@ async def main():

asyncio.run(main())
```

# Development

cargo fmt
cargo clippy
maturin develop

or use hatch envs:

hatch run fmt
hatch run check
hatch run build
19 changes: 18 additions & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ build-backend = "maturin"
[project]
name = "redis-rs"
requires-python = ">=3.7"
description = "Python wrapper for redis-rs and redis_cluster_async"
description = "Python wrapper for redis-rs"
authors = [
{ name = "Alexander Malev", email = "[email protected]" },
]
Expand Down Expand Up @@ -33,3 +33,20 @@ classifiers = [
Issues = "https://github.com/aamalev/redis-rs-py/issues"
Documentation = "https://github.com/aamalev/redis-rs-py#using"
Changelog = "https://github.com/aamalev/redis-rs-py/releases"

[tool.hatch.envs.default]
dependencies = [
"maturin",
]

[tool.hatch.envs.default.scripts]
build = [
"maturin develop",
]
check = [
"cargo clippy",
"build",
]
fmt = [
"cargo fmt",
]

0 comments on commit 069bec9

Please sign in to comment.