# A generalised and simple database interface library
[](https://pypi.org/project/dbilib)
[](https://pypi.org/project/dbilib)
[](https://pypi.org/project/dbilib)
[](https://pypi.org/project/dbilib)
[](https://pypi.org/project/dbilib)
[](https://pypi.org/project/dbilib)
[](https://pypi.org/project/dbilib)
[](https://dbilib.readthedocs.io/en/latest/)
[](https://opensource.org/licenses/MIT)
[](https://pypi.org/project/dbilib)
The ``dbilib`` project is a mid-level CPython database interface library which is designed to fit between ``sqlalchemy`` and *your* database interface library.
The interface exposes methods for easily accessing the database engine, executing SQL statements and calling stored procedures - with minimal setup.
As of this release, the following database engines are supported:
- MySQL / MariaDB
- Oracle
- SQLite3
- SQL Server (coming soon)
## Installation
Installing the library is as easy as:
```
pip install dbilib
```
This will install the library's required dependencies (e.g. `sqlalchemy`, etc.). However, it will *not* install the database-specific libraries, (e.g. `cx_Oracle`, `mysql-connector-python`, etc). This design feature helps to not bloat your environment with unneeded packages and keeps cross-platform capability and flexibility.
## Using the Library
The [documentation suite](https://dbilib.readthedocs.io/en/latest/index.html) contains usage examples and detailed explanation for each of the library's importable modules. Please refer to the [Library API Documentation](https://dbilib.readthedocs.io/en/latest/library.html) section of the documentation.
## Database Support
Our currently supported databases are listed in the overview section on this page. However, for further detail regarding the databases supported by the [SQLAlchemy](https://www.sqlalchemy.org/) library, please refer to *their* documentation, specifically their [Included Dialects](https://docs.sqlalchemy.org/en/20/dialects/index.html#included-dialects) page, which lists the supported database dialects and their version(s).
### Connection Strings
For convenience, we have provided a link to the [connection string](https://docs.sqlalchemy.org/en/20/core/engines.html#backend-specific-urls) (or database URL) templates for each database dialect supported by `sqlalchemy`. Generally, the [database URLs](https://docs.sqlalchemy.org/en/20/core/engines.html#database-urls) follow this convention:
```
dialect+driver://username:password@host:port/database
```
For example, the MySQL / MariaDB specific database URL using the ``mysql-connector-python`` driver, is:
```
mysql+mysqlconnector://<user>:<pwd>@<host>:<port>/<database>
```
Raw data
{
"_id": null,
"home_page": null,
"name": "dbilib",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "database, interface, utilities",
"author": null,
"author_email": "The Developers <development@s3dev.uk>",
"download_url": "https://files.pythonhosted.org/packages/a7/3e/520de13efe3937e9fec2624df12bb8c977b50d279d7f81eb82565911b85b/dbilib-0.4.1.tar.gz",
"platform": null,
"description": "\n# A generalised and simple database interface library\n\n[](https://pypi.org/project/dbilib)\n[](https://pypi.org/project/dbilib)\n[](https://pypi.org/project/dbilib)\n[](https://pypi.org/project/dbilib)\n[](https://pypi.org/project/dbilib)\n[](https://pypi.org/project/dbilib)\n[](https://pypi.org/project/dbilib)\n[](https://dbilib.readthedocs.io/en/latest/)\n[](https://opensource.org/licenses/MIT)\n[](https://pypi.org/project/dbilib)\n\nThe ``dbilib`` project is a mid-level CPython database interface library which is designed to fit between ``sqlalchemy`` and *your* database interface library.\n\nThe interface exposes methods for easily accessing the database engine, executing SQL statements and calling stored procedures - with minimal setup.\n\nAs of this release, the following database engines are supported:\n\n- MySQL / MariaDB\n- Oracle\n- SQLite3\n- SQL Server (coming soon)\n\n\n## Installation\nInstalling the library is as easy as:\n\n```\npip install dbilib\n```\nThis will install the library's required dependencies (e.g. `sqlalchemy`, etc.). However, it will *not* install the database-specific libraries, (e.g. `cx_Oracle`, `mysql-connector-python`, etc). This design feature helps to not bloat your environment with unneeded packages and keeps cross-platform capability and flexibility.\n\n\n## Using the Library\nThe [documentation suite](https://dbilib.readthedocs.io/en/latest/index.html) contains usage examples and detailed explanation for each of the library's importable modules. Please refer to the [Library API Documentation](https://dbilib.readthedocs.io/en/latest/library.html) section of the documentation.\n\n\n## Database Support\nOur currently supported databases are listed in the overview section on this page. However, for further detail regarding the databases supported by the [SQLAlchemy](https://www.sqlalchemy.org/) library, please refer to *their* documentation, specifically their [Included Dialects](https://docs.sqlalchemy.org/en/20/dialects/index.html#included-dialects) page, which lists the supported database dialects and their version(s).\n\n### Connection Strings\nFor convenience, we have provided a link to the [connection string](https://docs.sqlalchemy.org/en/20/core/engines.html#backend-specific-urls) (or database URL) templates for each database dialect supported by `sqlalchemy`. Generally, the [database URLs](https://docs.sqlalchemy.org/en/20/core/engines.html#database-urls) follow this convention:\n\n```\ndialect+driver://username:password@host:port/database\n```\n\nFor example, the MySQL / MariaDB specific database URL using the ``mysql-connector-python`` driver, is:\n\n```\nmysql+mysqlconnector://<user>:<pwd>@<host>:<port>/<database>\n```\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A generalised and simple database interface library.",
"version": "0.4.1",
"project_urls": {
"Documentation": "https://dbilib.readthedocs.io/en/latest/",
"Homepage": "https://github.com/s3dev/dbilib",
"Repository": "https://github.com/s3dev/dbilib"
},
"split_keywords": [
"database",
" interface",
" utilities"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c4e5a05de83203085bc8d73378deee7e754c0580f1ac4669e40851dd01192c4d",
"md5": "2b4ff0f52bbb084d26a074a13bd74d14",
"sha256": "41bd4dc7abab93634bddf37d3117bf6b52c3c800233d92bb18cde4dcde4bd866"
},
"downloads": -1,
"filename": "dbilib-0.4.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "2b4ff0f52bbb084d26a074a13bd74d14",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 17917,
"upload_time": "2024-09-27T20:46:43",
"upload_time_iso_8601": "2024-09-27T20:46:43.508690Z",
"url": "https://files.pythonhosted.org/packages/c4/e5/a05de83203085bc8d73378deee7e754c0580f1ac4669e40851dd01192c4d/dbilib-0.4.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a73e520de13efe3937e9fec2624df12bb8c977b50d279d7f81eb82565911b85b",
"md5": "d6242b6551260ef5380968e4c99e1106",
"sha256": "ebaf9df40ca7170a1a63ea53aa9708fb1edfc848af9bfd6552646f019f54f2a8"
},
"downloads": -1,
"filename": "dbilib-0.4.1.tar.gz",
"has_sig": false,
"md5_digest": "d6242b6551260ef5380968e4c99e1106",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 3171470,
"upload_time": "2024-09-27T20:46:48",
"upload_time_iso_8601": "2024-09-27T20:46:48.526204Z",
"url": "https://files.pythonhosted.org/packages/a7/3e/520de13efe3937e9fec2624df12bb8c977b50d279d7f81eb82565911b85b/dbilib-0.4.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-27 20:46:48",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "s3dev",
"github_project": "dbilib",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "cx_Oracle",
"specs": [
[
"==",
"8.3.0"
]
]
},
{
"name": "pandas",
"specs": [
[
"==",
"2.2.2"
]
]
},
{
"name": "sqlalchemy",
"specs": [
[
"==",
"2.0.32"
]
]
},
{
"name": "utils4",
"specs": [
[
"==",
"1.5.0.dev1"
]
]
}
],
"lcname": "dbilib"
}
JSON
