From d91ef300fd4c293326fc54669c58d25325a01b76 Mon Sep 17 00:00:00 2001 From: Parth Sharma Date: Thu, 27 Nov 2025 15:10:54 +0530 Subject: [PATCH 1/2] updated setup.cfg fields --- README.md | 2 +- setup.cfg | 9 ++++----- 2 files changed, 5 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 0be335c..8694c5b 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ **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. -The current version of `django-singlestore` is being tested with Django 4.2. +The current version of `django-singlestore` is being tested with Django 5.0. ## Installation diff --git a/setup.cfg b/setup.cfg index d07f22f..466e5c1 100644 --- a/setup.cfg +++ b/setup.cfg @@ -4,7 +4,7 @@ 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 @@ -12,20 +12,19 @@ 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 singlestoredb>=1.12.4 python_requires = >=3.9 From 353ad6169268281b1bd2cadb8ba41464b0bc8a99 Mon Sep 17 00:00:00 2001 From: Parth Sharma Date: Thu, 27 Nov 2025 15:43:32 +0530 Subject: [PATCH 2/2] update readme --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 8694c5b..9b52edd 100644 --- a/README.md +++ b/README.md @@ -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 5.0. +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 @@ -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/).