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.

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

s/redis/valkey/ single commit with fixes #2

Merged
merged 8 commits into from
May 27, 2024
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
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
2 changes: 1 addition & 1 deletion .coveragerc
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
[run]
source = redis
source = valkey
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Thanks for wanting to report an issue you've found in redis-py. Please delete this text and fill in the template below.
Thanks for wanting to report an issue you've found in valkey-py. Please delete this text and fill in the template below.
It is of course not always possible to reduce your code to a small test case, but it's highly appreciated to have as much data as possible. Thank you!

**Version**: What redis-py and what redis version is the issue happening on?
**Version**: What valkey-py and what valkey version is the issue happening on?

**Platform**: What platform / version? (For example Python 3.5.1 on Windows 7 / Ubuntu 15.10 / Azure)

Expand Down
24 changes: 19 additions & 5 deletions .github/wordlist.txt
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ Jaeger
Ludovico
Magnocavallo
McCurdy
Mesoraca
NOSCRIPT
NUMPAT
NUMPT
Expand All @@ -34,12 +35,7 @@ PubSub
READONLY
RediSearch
RedisBloom
RedisCluster
RedisClusterCommands
RedisClusterException
RedisClusters
RedisGraph
RedisInstrumentor
RedisJSON
RedisTimeSeries
SHA
Expand All @@ -55,9 +51,16 @@ TCP
TOPKCommands
TimeSeriesCommands
Uptrace
Valkey's
ValkeyCluster
ValkeyClusterCommands
ValkeyClusterException
ValkeyClusters
ValkeyInstrumentor
ValueError
WATCHed
WatchError
aiven
api
args
async
Expand All @@ -78,15 +81,19 @@ docstring
docstrings
eg
exc
faq
firsttimersonly
fo
genindex
gmail
hiredis
html
http
https
idx
iff
ini
io
json
keyslot
keyspace
Expand All @@ -96,6 +103,7 @@ localhost
lua
makeapullrequest
maxdepth
mesoraca
mget
microservice
microservices
Expand All @@ -107,6 +115,7 @@ observability
opentelemetry
oss
performant
placeholderkv
pmessage
png
pre
Expand All @@ -124,8 +133,11 @@ reinitialization
replicaof
repo
runtime
salvatore
sedrik
sexualized
aiven-sal marked this conversation as resolved.
Show resolved Hide resolved
sharded
socio
ssl
str
stunnel
Expand All @@ -139,5 +151,7 @@ txt
un
unicode
url
valkey
valkeymodules
virtualenv
www
2 changes: 1 addition & 1 deletion .github/workflows/docs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,6 @@ jobs:
- name: upload docs
uses: actions/upload-artifact@v4
with:
name: redis-py-docs
name: valkey-py-docs
path: |
docs/_build/html
8 changes: 4 additions & 4 deletions .github/workflows/install_and_test.sh
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,8 @@ cd ${TESTDIR}

# install, run tests
pip install ${PKG}
# Redis tests
# Valkey tests
pytest -m 'not onlycluster'
# RedisCluster tests
CLUSTER_URL="redis://localhost:16379/0"
pytest -m 'not onlynoncluster and not redismod and not ssl' --redis-url=${CLUSTER_URL}
# ValkeyCluster tests
CLUSTER_URL="valkey://localhost:16379/0"
pytest -m 'not onlynoncluster and not valkeymod and not ssl' --valkey-url=${CLUSTER_URL}
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
*.pyc
redis.egg-info
valkey.egg-info
build/
dist/
dump.rdb
Expand Down
4 changes: 2 additions & 2 deletions .isort.cfg
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[settings]
profile=black
multi_line_output=3
src_paths = ["redis", "tests"]
skip_glob=benchmarks/*
src_paths = ["valkey", "tests"]
skip_glob=benchmarks/*
4 changes: 2 additions & 2 deletions .mypy.ini
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[mypy]
#, docs/examples, tests
files = redis
files = valkey
check_untyped_defs = True
follow_imports_for_stubs asyncio.= True
#disallow_any_decorated = True
Expand All @@ -19,6 +19,6 @@ warn_unused_ignores = True
disallow_any_unimported = True
#warn_return_any = True

[mypy-redis.asyncio.lock]
[mypy-valkey.asyncio.lock]
# TODO: Remove once locks has been rewritten
ignore_errors = True
96 changes: 96 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,96 @@
Contributor Covenant Code of Conduct
Our Pledge
We as members, contributors, and leaders pledge to make participation in our
community a harassment-free experience for everyone, regardless of age, body
size, visible or invisible disability, ethnicity, sex characteristics, gender
identity and expression, level of experience, education, socio-economic status,
nationality, personal appearance, race, religion, or sexual identity
and orientation.
We pledge to act and interact in ways that contribute to an open, welcoming,
diverse, inclusive, and healthy community.
Our Standards
Examples of behavior that contributes to a positive environment for our
community include:

* Demonstrating empathy and kindness toward other people
* Being respectful of differing opinions, viewpoints, and experiences
* Giving and gracefully accepting constructive feedback
* Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
* Focusing on what is best not just for us as individuals, but for the
overall community

Examples of unacceptable behavior include:

* The use of sexualized language or imagery, and sexual attention or
advances of any kind
* Trolling, insulting or derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or email
address, without their explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting

Enforcement Responsibilities
Community leaders are responsible for clarifying and enforcing our standards of
acceptable behavior and will take appropriate and fair corrective action in
response to any behavior that they deem inappropriate, threatening, offensive,
or harmful.
Community leaders have the right and responsibility to remove, edit, or reject
comments, commits, code, wiki edits, issues, and other contributions that are
not aligned to this Code of Conduct, and will communicate reasons for moderation
decisions when appropriate.
Scope
This Code of Conduct applies within all community spaces, and also applies when
an individual is officially representing the community in public spaces.
Examples of representing our community include using an official e-mail address,
posting via an official social media account, or acting as an appointed
representative at an online or offline event.
Enforcement
Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement at
this email address: [email protected].
All complaints will be reviewed and investigated promptly and fairly.
All community leaders are obligated to respect the privacy and security of the
reporter of any incident.
Enforcement Guidelines
Community leaders will follow these Community Impact Guidelines in determining
the consequences for any action they deem in violation of this Code of Conduct:
1. Correction
Community Impact: Use of inappropriate language or other behavior deemed
unprofessional or unwelcome in the community.
Consequence: A private, written warning from community leaders, providing
clarity around the nature of the violation and an explanation of why the
behavior was inappropriate. A public apology may be requested.
2. Warning
Community Impact: A violation through a single incident or series
of actions.
Consequence: A warning with consequences for continued behavior. No
interaction with the people involved, including unsolicited interaction with
those enforcing the Code of Conduct, for a specified period of time. This
includes avoiding interactions in community spaces as well as external channels
like social media. Violating these terms may lead to a temporary or
permanent ban.
3. Temporary Ban
Community Impact: A serious violation of community standards, including
sustained inappropriate behavior.
Consequence: A temporary ban from any sort of interaction or public
communication with the community for a specified period of time. No public or
private interaction with the people involved, including unsolicited interaction
with those enforcing the Code of Conduct, is allowed during this period.
Violating these terms may lead to a permanent ban.
4. Permanent Ban
Community Impact: Demonstrating a pattern of violation of community
standards, including sustained inappropriate behavior, harassment of an
individual, or aggression toward or disparagement of classes of individuals.
Consequence: A permanent ban from any sort of public interaction within
the community.
Attribution
This Code of Conduct is adapted from the Contributor Covenant,
version 2.0, available at
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
Community Impact Guidelines were inspired by Mozilla's code of conduct
enforcement ladder.
For answers to common questions about this code of conduct, see the FAQ at
https://www.contributor-covenant.org/faq. Translations are available at
https://www.contributor-covenant.org/translations.
32 changes: 16 additions & 16 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Introduction

We appreciate your interest in considering contributing to redis-py.
We appreciate your interest in considering contributing to valkey-py.
Community contributions mean a lot to us.

## Contributions we need
Expand All @@ -18,7 +18,7 @@ helpful contributions that mean less work for you.

Unsure where to begin contributing? You can start by looking through
[help-wanted
issues](https://github.com/andymccurdy/redis-py/issues?q=is%3Aopen+is%3Aissue+label%3ahelp-wanted).
issues](https://github.com/valkey-io/valkey-py/issues?q=is%3Aopen+is%3Aissue+label%3ahelp-wanted).

Never contributed to open source before? Here are a couple of friendly
tutorials:
Expand All @@ -30,7 +30,7 @@ tutorials:

Here's how to get started with your code contribution:

1. Create your own fork of redis-py
1. Create your own fork of valkey-py
2. Do the changes in your fork
3.
*Create a virtualenv and install the development dependencies from the dev_requirements.txt file:*
Expand All @@ -55,11 +55,11 @@ project, and leaves them running. These can be easily cleaned up with
`invoke clean`. NOTE: it is assumed that the user running these tests,
can execute docker and its various commands.

- A master Redis node
- A Redis replica node
- Three sentinel Redis nodes
- A redis cluster
- An stunnel docker, fronting the master Redis node
- A master Valkey node
- A Valkey replica node
- Three sentinel Valkey nodes
- A valkey cluster
- An stunnel docker, fronting the master Valkey node

The replica node, is a replica of the master node, using the
[leader-follower replication](https://redis.io/topics/replication)
Expand All @@ -71,11 +71,11 @@ configuration](https://redis.io/topics/sentinel).
## Testing

Call `invoke tests` to run all tests, or `invoke all-tests` to run linters
tests as well. With the 'tests' and 'all-tests' targets, all Redis and
RedisCluster tests will be run.
tests as well. With the 'tests' and 'all-tests' targets, all Valkey and
ValkeyCluster tests will be run.

It is possible to run only Redis client tests (with cluster mode disabled) by
using `invoke standalone-tests`; similarly, RedisCluster tests can be run by using
It is possible to run only Valkey client tests (with cluster mode disabled) by
using `invoke standalone-tests`; similarly, ValkeyCluster tests can be run by using
`invoke cluster-tests`.

Each run of tests starts and stops the various dockers required. Sometimes
Expand Down Expand Up @@ -127,7 +127,7 @@ Please try at least versions of Docker.
### Security Vulnerabilities

**NOTE**: If you find a security vulnerability, do NOT open an issue.
Email [Redis Open Source (<[email protected]>)](mailto:[email protected]) instead.
Email [Salvatore Mesoraca (<[email protected]>)](mailto:[email protected]) instead.

In order to determine whether you are dealing with a security issue, ask
yourself these two questions:
Expand All @@ -139,14 +139,14 @@ yourself these two questions:
If the answer to either of those two questions are *yes*, then you're
probably dealing with a security issue. Note that even if you answer
*no* to both questions, you may still be dealing with a security
issue, so if you're unsure, just email [us](mailto:[email protected]).
issue, so if you're unsure, just email [us](mailto:[email protected]).

### Everything Else

When filing an issue, make sure to answer these five questions:

1. What version of redis-py are you using?
2. What version of redis are you using?
1. What version of valkey-py are you using?
2. What version of valkey are you using?
3. What did you do?
4. What did you expect to see?
5. What did you see instead?
Expand Down
2 changes: 1 addition & 1 deletion INSTALL
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@
Please use
python setup.py install

and report errors to Andy McCurdy ([email protected])
and report errors to Salvatore Mesoraca ([email protected])

Loading