Skip to content

Commit

Permalink
fix: Replace repo name with pkg name (#508)
Browse files Browse the repository at this point in the history
Use "django-google-spanner" instead of "python-spanner-django" where
appropriate in README and docs.

Co-authored-by: MF2199 <38331387+mf2199@users.noreply.github.com>
  • Loading branch information
c24t and mf2199 committed Sep 29, 2020
1 parent bd306a7 commit fbba900
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 15 deletions.
14 changes: 7 additions & 7 deletions README.rst
Expand Up @@ -13,12 +13,12 @@ To use this library you'll need a Google Cloud Platform project with the Cloud
Spanner API enabled. See the `Cloud Spanner Python client docs
<https://github.com/googleapis/python-spanner/#quick-start>`__ for details.

Use the version of ``python-spanner-django`` that corresponds to your version
of Django. For example, ``python-spanner-django`` 2.2.x works with Django
Use the version of ``django-google-spanner`` that corresponds to your version
of Django. For example, ``django-google-spanner`` 2.2.x works with Django
2.2.y. (This is the only supported version at this time.)

The minor release number of Django doesn't correspond to the minor release
number of ``python-spanner-django``. Use the latest minor release of each.
number of ``django-google-spanner``. Use the latest minor release of each.

To install from PyPI:

Expand Down Expand Up @@ -96,7 +96,7 @@ Limitations
Transaction management isn't supported
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

``python-spanner-django`` always works in ``autocommit`` mode, which is
``django-google-spanner`` always works in ``autocommit`` mode, which is
Django's default behavior even for backends that support manual transaction
management. Transactions cannot be controlled manually with calls like
``django.db.transaction.atomic()``.
Expand All @@ -105,7 +105,7 @@ management. Transactions cannot be controlled manually with calls like
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Spanner doesn't have support for auto-generating primary key values.
Therefore, ``python-spanner-django`` monkey-patches ``AutoField`` to generate a
Therefore, ``django-google-spanner`` monkey-patches ``AutoField`` to generate a
random UUID4. It generates a default using ``Field``'s ``default`` option which
means ``AutoField``\ s will have a value when a model instance is created. For
example:
Expand All @@ -126,7 +126,7 @@ were created.
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Spanner doesn't support ``ON DELETE CASCADE`` when creating foreign-key
constraints so ``python-spanner-django`` `doesn't support foreign key
constraints so ``django-google-spanner`` `doesn't support foreign key
constraints
<https://github.com/googleapis/python-spanner-django/issues/313>`__.

Expand Down Expand Up @@ -177,7 +177,7 @@ Spanner has some limitations on schema changes which you must respect:
- Renaming tables and columns isn't supported.
- A column's type can't be changed.
- A table's primary key can't be altered.
- Migrations aren't atomic since ``python-spanner-django`` doesn't support
- Migrations aren't atomic since ``django-google-spanner`` doesn't support
transactions.

``DurationField`` arithmetic doesn't work with ``DateField`` values (`#253 <https://github.com/googleapis/python-spanner-django/issues/253>`__)
Expand Down
16 changes: 8 additions & 8 deletions docs/conf.py
Expand Up @@ -6,7 +6,7 @@
# license that can be found in the LICENSE file or at
# https://developers.google.com/open-source/licenses/bsd

# python-spanner-django documentation build configuration file
# django-google-spanner documentation build configuration file
#
# This file is executedd with the current directory set to its containing dir.
#
Expand Down Expand Up @@ -270,7 +270,7 @@
# latex_documents = [
# (
# master_doc,
# "python-spanner-django.tex",
# "django-google-spanner.tex",
# u"Spanner Django Documentation",
# author,
# "manual",
Expand Down Expand Up @@ -305,8 +305,8 @@
man_pages = [
(
master_doc,
"python-spanner-django",
u"python-spanner-django Documentation",
"django-google-spanner",
u"django-google-spanner Documentation",
[author],
1,
)
Expand All @@ -324,11 +324,11 @@
texinfo_documents = [
(
master_doc,
"python-spanner-django",
u"python-spanner-django Documentation",
"django-google-spanner",
u"django-google-spanner Documentation",
author,
"python-spanner-django",
"python-spanner-django Library",
"django-google-spanner",
"django-google-spanner Library",
"APIs",
)
]
Expand Down

0 comments on commit fbba900

Please sign in to comment.