Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Minor doc and comment fixes #18

Merged
merged 2 commits into from
Jun 13, 2024
Merged

Minor doc and comment fixes #18

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
156025a
Fix URLs after valkey-io adoption
aiven-sal Jun 12, 2024
136bb13
Fix remaining references to redis-py
aiven-sal Jun 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,14 @@

The Python interface to the Valkey key-value store.

[![CI](https://github.com/aiven-sal/valkey-py/workflows/CI/badge.svg?branch=main)](https://github.com/aiven-sal/valkey-py/actions?query=workflow%3ACI+branch%3Amain)
[![CI](https://github.com/valkey-io/valkey-py/workflows/CI/badge.svg)](https://github.com/valkey-io/valkey-py/actions?query=workflow%3ACI+branch%3Amain)
[![docs](https://readthedocs.org/projects/valkey-py/badge/?version=latest&style=flat)](https://valkey-py.readthedocs.io/en/latest/)
[![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](./LICENSE)
[![pypi](https://badge.fury.io/py/valkey.svg)](https://pypi.org/project/valkey/)
[![pre-release](https://img.shields.io/github/v/release/aiven-sal/valkey-py?include_prereleases&label=latest-prerelease)](https://github.com/aiven-sal/valkey-py/releases)
[![codecov](https://codecov.io/gh/aiven-sal/valkey-py/branch/main/graph/badge.svg?token=yenl5fzxxr)](https://codecov.io/gh/aiven-sal/valkey-py)
[![pre-release](https://img.shields.io/github/v/release/valkey-io/valkey-py?include_prereleases&label=latest-prerelease)](https://github.com/valkey-io/valkey-py/releases)
[![codecov](https://codecov.io/gh/valkey-io/valkey-py/branch/main/graph/badge.svg?token=yenl5fzxxr)](https://codecov.io/gh/valkey-io/valkey-py)

[Installation](#installation) | [Usage](#usage) | [Advanced Topics](#advanced-topics) | [Contributing](https://github.com/aiven-sal/valkey-py/blob/main/CONTRIBUTING.md)
[Installation](#installation) | [Usage](#usage) | [Advanced Topics](#advanced-topics) | [Contributing](https://github.com/valkey-io/valkey-py/blob/main/CONTRIBUTING.md)

---------------------------------------------

Expand Down Expand Up @@ -51,7 +51,7 @@ The above code connects to localhost on port 6379, sets a value in Redis, and re


#### RESP3 Support
To enable support for RESP3, ensure you have at least version 5.0 of the client, and change your connection object to include *protocol=3*
To enable support for RESP3 change your connection object to include *protocol=3*

``` python
>>> import valkey
Expand All @@ -71,7 +71,7 @@ Alternatively, you might want to look at [Async connections](https://valkey-py.r

### Valkey Commands

There is built-in support for all of the [out-of-the-box Valkey commands](https://valkey.io/commands). They are exposed using the raw Redis command names (`HSET`, `HGETALL`, etc.) except where a word (i.e. del) is reserved by the language. The complete set of commands can be found [here](https://github.com/aiven-sal/valkey-py/tree/main/valkey/commands), or [the documentation](https://valkey-py.readthedocs.io/en/stable/commands.html).
There is built-in support for all of the [out-of-the-box Valkey commands](https://valkey.io/commands). They are exposed using the raw Redis command names (`HSET`, `HGETALL`, etc.) except where a word (i.e. del) is reserved by the language. The complete set of commands can be found [here](https://github.com/valkey-io/valkey-py/tree/main/valkey/commands), or [the documentation](https://valkey-py.readthedocs.io/en/stable/commands.html).

## Advanced Topics

Expand Down Expand Up @@ -127,7 +127,7 @@ The following example shows how to utilize [Valkey Pub/Sub](https://redis.io/doc
### Author

valkey-py can be found [here](
https://github.com/aiven-sal/valkey-py), or downloaded from [pypi](https://pypi.org/project/valkey/).
https://github.com/valkey-io/valkey-py), or downloaded from [pypi](https://pypi.org/project/valkey/).
It was created as a fork of [redis-py](https://github.com/redis/redis-py)

Special thanks to:
Expand Down
2 changes: 1 addition & 1 deletion setup.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
"Code": "https://github.com/valkey-io/valkey-py",
"Issue tracker": "https://github.com/valkey-io/valkey-py/issues",
},
author="placeholder",
author="valkey-py authors",
author_email="[email protected]",
python_requires=">=3.8",
install_requires=[
Expand Down
2 changes: 1 addition & 1 deletion tasks.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ def tests(c, uvloop=False, protocol=2):
"""Run the valkey-py test suite against the current python,
with and without hiredis.
"""
print("Starting Redis tests")
print("Starting Valkey tests")
standalone_tests(c, uvloop=uvloop, protocol=protocol)
cluster_tests(c, uvloop=uvloop, protocol=protocol)

Expand Down
Loading