# Endatabas Console and Python Client
The official console and Python client library for
[Endatabas](https://www.endatabas.com).
## Installation
```sh
pip install endb
pip install websockets # optional WebSocket support
pip install pyarrow # optional Apache Arrow support
```
`endb` is supported on Python 3.10 and above.
[WebSocket](https://docs.endatabas.com/reference/websocket_api)
support is optional.
## Documentation
* [Endb Console](https://docs.endatabas.com/reference/console)
* [Python client library](https://docs.endatabas.com/reference/clients#python)
* [Endb SQL Reference](https://docs.endatabas.com/sql/)
## Console Usage
```sh
endb_console [--url URL] [-u USERNAME] [-p PASSWORD]
```
## Python Client Library Usage
```python
from endb import Endb
e = Endb()
e.sql("INSERT INTO users {name: 'Yuvi'}")
e.sql("SELECT * FROM users;")
```
When the `websockets` dependency is installed, it is possible to
return asynchronous results to the Python interactive shell
directly if you start it with `python3 -m asyncio`:
```python
from endb import EndbWebSocket
ews = EndbWebSocket()
result = await ews.sql("SELECT * FROM users;")
print(result)
```
## Development
```sh
pip install setuptools wheel twine
make
```
## Copyright and License
This subdirectory of the main Git repository and the contents of
the `endb` PyPI package are subject to the MIT License:
Copyright 2023-2024 Håkan Råberg and Steven Deobald.
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Raw data
{
"_id": null,
"home_page": "",
"name": "endb",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": "",
"keywords": "endatabas,endb,immutable,sql,database",
"author": "",
"author_email": "Endatabas <hello@endatabas.com>",
"download_url": "https://files.pythonhosted.org/packages/32/80/c75dbb3b333b43fc14ae0879f16c2c55358304d507b9e86ebad7e697d634/endb-0.2.0b1.tar.gz",
"platform": null,
"description": "# Endatabas Console and Python Client\n\nThe official console and Python client library for\n[Endatabas](https://www.endatabas.com).\n\n## Installation\n\n```sh\npip install endb\npip install websockets # optional WebSocket support\npip install pyarrow # optional Apache Arrow support\n```\n\n`endb` is supported on Python 3.10 and above.\n[WebSocket](https://docs.endatabas.com/reference/websocket_api)\nsupport is optional.\n\n## Documentation\n\n* [Endb Console](https://docs.endatabas.com/reference/console)\n* [Python client library](https://docs.endatabas.com/reference/clients#python)\n* [Endb SQL Reference](https://docs.endatabas.com/sql/)\n\n## Console Usage\n\n```sh\nendb_console [--url URL] [-u USERNAME] [-p PASSWORD]\n```\n\n## Python Client Library Usage\n\n```python\nfrom endb import Endb\ne = Endb()\ne.sql(\"INSERT INTO users {name: 'Yuvi'}\")\ne.sql(\"SELECT * FROM users;\")\n```\n\nWhen the `websockets` dependency is installed, it is possible to\nreturn asynchronous results to the Python interactive shell\ndirectly if you start it with `python3 -m asyncio`:\n\n```python\nfrom endb import EndbWebSocket\news = EndbWebSocket()\nresult = await ews.sql(\"SELECT * FROM users;\")\nprint(result)\n```\n\n## Development\n\n```sh\npip install setuptools wheel twine\nmake\n```\n\n## Copyright and License\n\nThis subdirectory of the main Git repository and the contents of\nthe `endb` PyPI package are subject to the MIT License:\n\nCopyright 2023-2024 H\u00e5kan R\u00e5berg and Steven Deobald.\n\nPermission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \u201cSoftware\u201d), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \u201cAS IS\u201d, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\n",
"bugtrack_url": null,
"license": "MIT License",
"summary": "Endatabas Python Client",
"version": "0.2.0b1",
"project_urls": {
"Documentation": "https://docs.endatabas.com/reference/clients",
"Homepage": "https://www.endatabas.com/",
"Repository": "https://github.com/endatabas/endb.git"
},
"split_keywords": [
"endatabas",
"endb",
"immutable",
"sql",
"database"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "1e5fa3da79d726ca178895754d6749114cb335e38a7e29ab75295ef94efe97c5",
"md5": "9ce2061a847eb3db51d15f833072b36e",
"sha256": "db66da8aca7e9f22722a1a13725642922b9437c8f63f703d660a0c8bc3f95a38"
},
"downloads": -1,
"filename": "endb-0.2.0b1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9ce2061a847eb3db51d15f833072b36e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 8047,
"upload_time": "2024-02-28T09:08:48",
"upload_time_iso_8601": "2024-02-28T09:08:48.193183Z",
"url": "https://files.pythonhosted.org/packages/1e/5f/a3da79d726ca178895754d6749114cb335e38a7e29ab75295ef94efe97c5/endb-0.2.0b1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3280c75dbb3b333b43fc14ae0879f16c2c55358304d507b9e86ebad7e697d634",
"md5": "faff6c83af8521f96f4262d548e19def",
"sha256": "e2ab4e3c331007cda76bb4fb8232e519695da73458c9733d3c150a0473d4dc7d"
},
"downloads": -1,
"filename": "endb-0.2.0b1.tar.gz",
"has_sig": false,
"md5_digest": "faff6c83af8521f96f4262d548e19def",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 6544,
"upload_time": "2024-02-28T09:08:49",
"upload_time_iso_8601": "2024-02-28T09:08:49.208623Z",
"url": "https://files.pythonhosted.org/packages/32/80/c75dbb3b333b43fc14ae0879f16c2c55358304d507b9e86ebad7e697d634/endb-0.2.0b1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-28 09:08:49",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "endatabas",
"github_project": "endb",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "endb"
}
JSON
