# 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')
```
Raw data
{
"_id": null,
"home_page": "https://github.com/yugabyte/sqlalchemy-yugabytedb",
"name": "sqlalchemy-yugabytedb",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "SQLAlchemy YugabyteDB",
"author": "Yugabyte",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/75/21/b4ca42f0e23d14e8e9e02640f5960a1faf8f35e13c060df000b1f84e014d/sqlalchemy-yugabytedb-1.0.0.1.tar.gz",
"platform": null,
"description": "# YugabyteDB dialect for SQLAlchemy\n\n## Prerequisites\n\nFor psycopg2 support you must install either:\n\n* [psycopg2-yugabytedb](https://pypi.org/project/psycopg2-yugabytedb/), which has some\n [prerequisites](https://www.psycopg.org/docs/install.html#prerequisites) of\n its own. Or,\n\n* [psycopg2-binary](https://pypi.org/project/psycopg2-binary/)\n\n(The binary package is a practical choice for development and testing but in\nproduction it is advised to use the package built from sources.)\n\n\n## Install and usage\n\nUse `pip` to install the latest version. Clone the repository and run the following command:\n\n`pip install .`\n\nUse a `Yugabytedb` connection string when creating the `Engine`. For example,\nto connect to a local YugabyteDB cluster using psycopg2:\n\n```\nfrom sqlalchemy import create_engine\nengine = create_engine('yugabytedb://yugabyte@localhost:5433/yugabyte')\n```\n\nor\n\n```\nfrom sqlalchemy import create_engine\nengine = create_engine('yugabytedb+psycopg2://yugabyte@localhost:5433/yugabyte')\n```\n\n\n\n",
"bugtrack_url": null,
"license": "http://www.apache.org/licenses/LICENSE-2.0",
"summary": "YugabyteDB dialect for SQLAlchemy",
"version": "1.0.0.1",
"project_urls": {
"Documentation": "https://docs.yugabyte.com/",
"Homepage": "https://github.com/yugabyte/sqlalchemy-yugabytedb",
"Source": "https://github.com/yugabyte/sqlalchemy-yugabytedb"
},
"split_keywords": [
"sqlalchemy",
"yugabytedb"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "358367a6208e5627efce289d32286a79c2cf517702af95e655bb0c2d7165760c",
"md5": "38d5611cd920866cd9504c9400a8ecf7",
"sha256": "947ec3049b35887a0f413a1b41aaddfa62592c9ca3ebffc98edc0646d40d5010"
},
"downloads": -1,
"filename": "sqlalchemy_yugabytedb-1.0.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "38d5611cd920866cd9504c9400a8ecf7",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 4191,
"upload_time": "2024-02-22T04:28:33",
"upload_time_iso_8601": "2024-02-22T04:28:33.934725Z",
"url": "https://files.pythonhosted.org/packages/35/83/67a6208e5627efce289d32286a79c2cf517702af95e655bb0c2d7165760c/sqlalchemy_yugabytedb-1.0.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "7521b4ca42f0e23d14e8e9e02640f5960a1faf8f35e13c060df000b1f84e014d",
"md5": "44774a6cc1cf2949f0adfa28737196ce",
"sha256": "f7a694391bcaecdebbb7debf6831af60057a7299933915cc2db29550bd35bad2"
},
"downloads": -1,
"filename": "sqlalchemy-yugabytedb-1.0.0.1.tar.gz",
"has_sig": false,
"md5_digest": "44774a6cc1cf2949f0adfa28737196ce",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 3300,
"upload_time": "2024-02-22T04:28:35",
"upload_time_iso_8601": "2024-02-22T04:28:35.794525Z",
"url": "https://files.pythonhosted.org/packages/75/21/b4ca42f0e23d14e8e9e02640f5960a1faf8f35e13c060df000b1f84e014d/sqlalchemy-yugabytedb-1.0.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-22 04:28:35",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "yugabyte",
"github_project": "sqlalchemy-yugabytedb",
"github_not_found": true,
"lcname": "sqlalchemy-yugabytedb"
}
JSON
