Skip to content
Merged
Show file tree
Hide file tree
Changes from all 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
58 changes: 58 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
# Contributing to sql-redis

Thanks for your interest in contributing! `sql-redis` is an early-stage,
proof-of-concept SQL-to-Redis translator and we welcome bug reports, feature
ideas, and pull requests from the community.

## Reporting bugs and requesting features

- Open a [GitHub issue](https://github.com/redis-developer/sql-redis/issues)
describing the problem or idea.
- For bug reports, include:
- The SQL input that misbehaved.
- The translated Redis command (`SQLQuery.redis_query_string()` output) or
the actual results, plus what you expected.
- The `sql-redis` and `redis` versions you're running.
- For security-sensitive reports, follow [SECURITY.md](./SECURITY.md) instead
of opening a public issue.

## Development setup

`sql-redis` uses [uv](https://docs.astral.sh/uv/) for dependency management
and [hatchling](https://hatch.pypa.io/latest/) as the build backend.

```bash
# Clone and install
git clone https://github.com/redis-developer/sql-redis.git
cd sql-redis
uv sync

# Common tasks (see the Makefile for the full list)
make format # black + isort
make lint # format + mypy
make test # pytest
make test-cov # pytest with coverage
make build # wheel + sdist
```

Tests use [`testcontainers`](https://testcontainers.com/) to spin up an
ephemeral Redis instance, so a local Docker daemon is required to run the
full suite.

## Pull requests

1. Fork and create a branch off `main`.
2. Make your change, including tests for any new behavior.
3. Run `make lint test` and confirm everything passes.
4. Open a pull request against `main`. Apply one of the
[`auto:` labels](./.autorc) to indicate the intended version bump
(`auto:major`, `auto:minor`, `auto:patch`, or `auto:skip-release`).
Maintainers add `auto:release` when the change is ready to ship; the
release workflow handles the version bump, tag, GitHub release, and
PyPI publish automatically.

## Code style

- Black and isort are enforced via `make format` and pre-commit hooks.
- Type hints required on new public APIs; `mypy` runs in CI.
- Keep new modules focused and add tests in the corresponding `tests/test_*.py`.
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2025-2026 Redis, Inc.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
124 changes: 0 additions & 124 deletions PR_NOTES.md

This file was deleted.

29 changes: 29 additions & 0 deletions SECURITY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Security Policy

## Reporting a Vulnerability

If you believe you have discovered a security vulnerability in `sql-redis`,
please report it **privately** through GitHub's private vulnerability
reporting:

1. Go to the [Security tab](https://github.com/redis-developer/sql-redis/security)
of the repository.
2. Click **Report a vulnerability**.
3. Fill in the form with a description of the issue, reproduction steps,
affected versions, and any suggested mitigations.

This sends the report directly to maintainers without making it public, and
gives us a place to coordinate the fix and disclosure timeline with you.

**Please do not open a public GitHub issue or pull request** for security
reports — that would disclose the vulnerability before a fix is available.

For non-security bugs and feature requests, regular
[GitHub issues](https://github.com/redis-developer/sql-redis/issues) are the
right place.

## Supported Versions

Security fixes are applied to the latest minor release on PyPI. Older minor
releases are not patched; please upgrade to the latest version to receive
fixes.
File renamed without changes.
6 changes: 3 additions & 3 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ name = "sql-redis"
# NOTE: The version below is automatically incremented by the release workflow - do not manually adjust it.
version = "0.5.0"
description = "SQL to Redis command translation utility"
authors = [{ name = "Redis Inc.", email = "applied.ai@redis.com" }]
authors = [{ name = "Redis Inc." }]
requires-python = ">=3.9,<3.14"
readme = "README.md"
license = "MIT"
Expand All @@ -27,8 +27,8 @@ dependencies = [
]

[project.urls]
Homepage = "https://github.com/redis/sql-redis"
Repository = "https://github.com/redis/sql-redis"
Homepage = "https://github.com/redis-developer/sql-redis"
Repository = "https://github.com/redis-developer/sql-redis"

[build-system]
requires = ["hatchling"]
Expand Down
4 changes: 2 additions & 2 deletions uv.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading