Metadata-Version: 2.1
Name: django_psdb_engine
Version: 1.0.4
Summary: Django PlanetScale database engine.
Home-page: https://github.com/lnxpy/django-psdb-engine
Author: Sadra Yahyapour
Author-email: lnxpylnxpy@gmail.com
License: MIT license
Keywords: django_psdb_engine
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Requires-Python: >=3.6
License-File: LICENSE

==================
django-psdb-engine
==================

.. image:: https://img.shields.io/pypi/v/django_psdb_engine.svg
        :target: https://pypi.python.org/pypi/django_psdb_engine

.. image:: https://img.shields.io/travis/lnxpy/django_psdb_engine.svg
        :target: https://travis-ci.com/lnxpy/django_psdb_engine

.. image:: https://readthedocs.org/projects/django-psdb-engine/badge/?version=latest
        :target: https://django-psdb-engine.readthedocs.io/en/latest/?version=latest
        :alt: Documentation Status

Django `PlanetScale <https://planetscale.com>`_ database engine. This package is a better solution for `planetscale/django_psdb_engine <https://github.com/planetscale/django_psdb_engine>`_.

* Free software: MIT license

Usage
-----
Make this database engine ready in two simple steps. First thing first, install the package.

.. code:: sh

   $ pip install django-psdb-engine


And finally, update your databases configuration by changing the ``ENGINE`` field.

.. code:: python

   DATABASES = {
     'default': {
       'ENGINE': 'django_psdb_engine',
       ...
       'OPTIONS': {'ssl': {'ca': ...}}
     }
   }

**Note**: Since Django uses the default utf8bm3 charset for your tables and it's not supported by PlanetScale's engine yet, you may need to add ``{"charset": "utf8bm4"}`` in order to migrate your changes and get it work.

Requirements
------------
- django>=2.2
- mysqlclient>=2.1.0


=======
History
=======

1.0.0 (2022-08-12)
------------------

* First release on PyPI.


