Skip to content

updated setup.cfg fields #51

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

Merged
psharma-1909 merged 2 commits into from
Dec 11, 2025
Merged

updated setup.cfg fields #51

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
d91ef30
updated setup.cfg fields
psharma-1909 Nov 27, 2025
353ad61
update readme
psharma-1909 Nov 27, 2025
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
6 changes: 4 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# SingleStore backend for Django

**Attention**: The code in this repository is intended for experimental use only and is not yet fully tested, documented, or supported by SingleStore. Visit the [SingleStore Forums](https://www.singlestore.com/forum/) to ask questions about this repository.
**Note**: This is a SingleStore-maintained Django backend for SingleStore. For questions and support, visit the [SingleStore Forums](https://www.singlestore.com/forum/).

The current version of `django-singlestore` is being tested with Django 4.2.
The project follows semantic versioning. Each `django-singlestore` release is aligned with the corresponding django version it is tested against—for example, `django-singlestore 5.0.X` with `Django 5.0`.

## Installation

Expand Down Expand Up @@ -35,6 +35,8 @@ DEFAULT_AUTO_FIELD = "django.db.models.BigAutoField"

Django provides a [tutorial](https://docs.djangoproject.com/en/dev/intro/tutorial01/) to get started.

For a comprehensive guide on integrating Django with SingleStore, see the [Django-SingleStore Integration Guide](https://www.singlestore.com/blog/django-singlestore-integration-guide/).

## Features and Limitations

There is a number of limitations when using SingleStore with Django, notably the lack of Foreign Keys on the database level. In addition, a unique key on distributed table must be a superset of the shard key. To learn more about the indexes in SingleStore, visit the [docs](https://docs.singlestore.com/cloud/create-a-database/understanding-keys-and-indexes-in-singlestore/) or [troubleshooting guide](https://docs.singlestore.com/cloud/reference/troubleshooting-reference/query-errors/why-do-i-get-errors-about-unique-keys/).
Expand Down
9 changes: 4 additions & 5 deletions setup.cfg
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,28 +4,27 @@ version = attr: django_singlestore.__version__
description = Django backend for SingleStore
long_description = file: README.md
long_description_content_type = text/markdown
url = https://github.com/memsql/django-singlestore
url = https://github.com/singlestore-labs/django-singlestore
maintainer = SingleStore Inc.
maintainer_email = support@singlestore.com
license = BSD-3-Clause
license_files = LICENSE
classifiers =
Development Status :: 4 - Beta
Framework :: Django
Framework :: Django :: 4.2
License :: OSI Approved :: BSD License
Operating System :: OS Independent
Programming Language :: Python
Programming Language :: Python :: 3
Programming Language :: Python :: 3 :: Only
project_urls =
Source = https://github.com/memsql/django-singlestore
Tracker = https://github.com/memsql/django-singlestore/issues
Source = https://github.com/singlestore-labs/django-singlestore
Tracker = https://github.com/singlestore-labs/django-singlestore/issues

[options]
packages = find:
install_requires =
django>=4.2
django>=5.0
Copy link
Contributor Author

@psharma-1909 psharma-1909 Nov 27, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I still think it should be something like django>=4.2 and <=5.0.

Copy link
Collaborator

@pmishchenko-ua pmishchenko-ua Dec 10, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it's more likely that newer versions of django will work with the current version of connector that older, so I'd keeo >=5.0 here

singlestoredb>=1.12.4
python_requires = >=3.9

Expand Down