# rockset-sqlalchemy
This library implements Python's dbapi spec and provides SQLAlchemy support on top of Rockset.
## Usage
To install the latest version of this package, run:
pip3 install rockset-sqlalchemy
To connect to the database:
```python
from sqlalchemy import create_engine
engine = create_engine(
"rockset://",
connect_args={
"api_key": "{your api key}",
"api_server": "{your api server}"
"virtual_instance": "{your virtual instance ID}" # virtual_instance is optional
},
)
```
See some example queries [here](https://github.com/rockset/rockset-sqlalchemy/blob/main/example.py). See the SQLAlchemy Unified Tutorial [here](https://docs.sqlalchemy.org/en/20/tutorial/index.html).
## Development
Iterating on this library is very simple.
First, clone the source repository:
git clone https://github.com/rockset/rockset-sqlalchemy
Then, all you need to do is run `sudo python3 setup.py develop` from the cloned directory and hack away.
You can use the example script `example.py` to get started with development. Make sure you provide a `ROCKSET_API_KEY` and `ROCKSET_API_SERVER` to the script, like so
```
ROCKSET_API_KEY=xxx ROCKSET_API_SERVER=https://api.rs2.usw2.rockset.com python3 example.py
```
Raw data
{
"_id": null,
"home_page": "https://github.com/rockset/rockset-sqlalchemy",
"name": "rockset-sqlalchemy",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "Rockset,rockset-client",
"author": "Rockset",
"author_email": "support@rockset.com",
"download_url": "https://files.pythonhosted.org/packages/b4/74/c2b61d5f37754455d9318448fa32ccd650864ce3e8d3f6ea8e7ce8f82371/rockset-sqlalchemy-0.0.1.tar.gz",
"platform": null,
"description": "# rockset-sqlalchemy\nThis library implements Python's dbapi spec and provides SQLAlchemy support on top of Rockset.\n\n## Usage\nTo install the latest version of this package, run:\n\n pip3 install rockset-sqlalchemy\n\nTo connect to the database:\n\n```python\nfrom sqlalchemy import create_engine\n\nengine = create_engine(\n \"rockset://\",\n connect_args={\n \"api_key\": \"{your api key}\",\n \"api_server\": \"{your api server}\"\n \"virtual_instance\": \"{your virtual instance ID}\" # virtual_instance is optional\n },\n)\n```\n\nSee some example queries [here](https://github.com/rockset/rockset-sqlalchemy/blob/main/example.py). See the SQLAlchemy Unified Tutorial [here](https://docs.sqlalchemy.org/en/20/tutorial/index.html).\n\n## Development\nIterating on this library is very simple.\n\nFirst, clone the source repository:\n\n git clone https://github.com/rockset/rockset-sqlalchemy\n\nThen, all you need to do is run `sudo python3 setup.py develop` from the cloned directory and hack away.\n\nYou can use the example script `example.py` to get started with development. Make sure you provide a `ROCKSET_API_KEY` and `ROCKSET_API_SERVER` to the script, like so\n\n```\nROCKSET_API_KEY=xxx ROCKSET_API_SERVER=https://api.rs2.usw2.rockset.com python3 example.py\n```\n",
"bugtrack_url": null,
"license": "",
"summary": "Rockset's SQLAlchemy support and DB-API specification",
"version": "0.0.1",
"project_urls": {
"Homepage": "https://github.com/rockset/rockset-sqlalchemy"
},
"split_keywords": [
"rockset",
"rockset-client"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b94787f7f4cb9261dd6ffbbf2770fae905ada15669a8296a9112c36f56910257",
"md5": "33a3276c2baf4160587817f30f923650",
"sha256": "fc5c3f12dbb75d5fc7536d67b7c18fa3be3f8de71379746a1a734fef0070c785"
},
"downloads": -1,
"filename": "rockset_sqlalchemy-0.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "33a3276c2baf4160587817f30f923650",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 13591,
"upload_time": "2023-07-10T18:06:46",
"upload_time_iso_8601": "2023-07-10T18:06:46.825263Z",
"url": "https://files.pythonhosted.org/packages/b9/47/87f7f4cb9261dd6ffbbf2770fae905ada15669a8296a9112c36f56910257/rockset_sqlalchemy-0.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b474c2b61d5f37754455d9318448fa32ccd650864ce3e8d3f6ea8e7ce8f82371",
"md5": "4d465985524a04fa95afa4496151c5fd",
"sha256": "f84b62e5987f6c14df86dba197726bd645822abcabf5c4c32e72cbe3bac3f357"
},
"downloads": -1,
"filename": "rockset-sqlalchemy-0.0.1.tar.gz",
"has_sig": false,
"md5_digest": "4d465985524a04fa95afa4496151c5fd",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 12198,
"upload_time": "2023-07-10T18:06:48",
"upload_time_iso_8601": "2023-07-10T18:06:48.471544Z",
"url": "https://files.pythonhosted.org/packages/b4/74/c2b61d5f37754455d9318448fa32ccd650864ce3e8d3f6ea8e7ce8f82371/rockset-sqlalchemy-0.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-07-10 18:06:48",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "rockset",
"github_project": "rockset-sqlalchemy",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "rockset-sqlalchemy"
}
JSON
