Metadata-Version: 2.1
Name: sqlalchemy-yugabytedb
Version: 1.0.0.1
Summary: YugabyteDB dialect for SQLAlchemy
Home-page: https://github.com/yugabyte/sqlalchemy-yugabytedb
Author: Yugabyte
Author-email: 
License: http://www.apache.org/licenses/LICENSE-2.0
Project-URL: Documentation, https://docs.yugabyte.com/
Project-URL: Source, https://github.com/yugabyte/sqlalchemy-yugabytedb
Keywords: SQLAlchemy YugabyteDB
Platform: UNKNOWN
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Description-Content-Type: text/markdown
Requires-Dist: SQLAlchemy
Requires-Dist: psycopg2-yugabytedb

# YugabyteDB dialect for SQLAlchemy

## Prerequisites

For psycopg2 support you must install either:

* [psycopg2-yugabytedb](https://pypi.org/project/psycopg2-yugabytedb/), which has some
  [prerequisites](https://www.psycopg.org/docs/install.html#prerequisites) of
  its own. Or,

* [psycopg2-binary](https://pypi.org/project/psycopg2-binary/)

(The binary package is a practical choice for development and testing but in
production it is advised to use the package built from sources.)


## Install and usage

Use `pip` to install the latest version. Clone the repository and run the following command:

`pip install .`

Use a `Yugabytedb` connection string when creating the `Engine`. For example,
to connect to a local YugabyteDB cluster using psycopg2:

```
from sqlalchemy import create_engine
engine = create_engine('yugabytedb://yugabyte@localhost:5433/yugabyte')
```

or

```
from sqlalchemy import create_engine
engine = create_engine('yugabytedb+psycopg2://yugabyte@localhost:5433/yugabyte')
```



