tortoise-database-url


Nametortoise-database-url JSON
Version 0.5.0 PyPI version JSON
download
home_pageNone
SummaryMake it easy to generate database url.
upload_time2025-08-16 03:30:44
maintainerNone
docs_urlNone
authorNone
requires_python>=3.9
licenseNone
keywords database_url tortoise-orm
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            # database-url
![Python Versions](https://img.shields.io/pypi/pyversions/tortoise-database-url)
[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
[![LatestVersionInPypi](https://img.shields.io/pypi/v/tortoise-database-url.svg?style=flat)](https://pypi.org/project/tortoise-database-url/)
[![GithubActionResult](https://github.com/waketzheng/database-url/workflows/ci/badge.svg)](https://github.com/waketzheng/database-url/actions?query=workflow:ci)
[![Coverage Status](https://coveralls.io/repos/github/waketzheng/database-url/badge.svg?branch=main)](https://coveralls.io/github/waketzheng/database-url?branch=main)
![Mypy coverage](https://img.shields.io/badge/mypy-100%25-green.svg)

Toolkit for TortoiseORM to generate database url from Django DATABASES item format.

## Installation

```bash
pip install tortoise-database-url
```
Or by uv/pdm:
```bash
uv add tortoise-database-url
pdm add tortoise-database-url
```

## Usage

- DbUrl
```py
from tortoise_database_url import DbUrl

db_url = DbUrl.mysql('my_db', user='root', password='Me@example.com')
print(db_url)
# mysql://root:Me%40example.com@127.0.0.1:3306/my_db
```

- generate

```py
import tortoise_database_url

db_url = tortoise_database_url.generate('my_db', engine='mysql', user='root', password='Me@example.com')
print(db_url)
# mysql://root:Me%40example.com@127.0.0.1:3306/my_db

db_url = tortoise_database_url.generate('db_name', engine='postgres')
print(db_url)
# postgres://postgres:postgres@127.0.0.1:5432/db_name
```

- from_django_item
```py
import pathlib
import tortoise_database_url

DATABASES = {
    "default": {
        "ENGINE": "django.db.backends.sqlite3",
        "NAME": pathlib.Path("/tmp") / "db.sqlite3"
    },
}

db_url = tortoise_database_url.from_django_item(DATABASES["default"])
print(db_url)
# sqlte:///tmp/db.sqlite3
```
See more at:
https://github.com/waketzheng/database-url/blob/main/tests/test_main.py
https://tortoise.github.io/databases.html?h=database

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "tortoise-database-url",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": null,
    "keywords": "database_url, tortoise-orm",
    "author": null,
    "author_email": "Waket Zheng <waketzheng@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/c5/ee/1f15d2e6f65f2281f44109dff79e5e3ed7c506951157953748da0a63e2de/tortoise_database_url-0.5.0.tar.gz",
    "platform": null,
    "description": "# database-url\n![Python Versions](https://img.shields.io/pypi/pyversions/tortoise-database-url)\n[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)\n[![LatestVersionInPypi](https://img.shields.io/pypi/v/tortoise-database-url.svg?style=flat)](https://pypi.org/project/tortoise-database-url/)\n[![GithubActionResult](https://github.com/waketzheng/database-url/workflows/ci/badge.svg)](https://github.com/waketzheng/database-url/actions?query=workflow:ci)\n[![Coverage Status](https://coveralls.io/repos/github/waketzheng/database-url/badge.svg?branch=main)](https://coveralls.io/github/waketzheng/database-url?branch=main)\n![Mypy coverage](https://img.shields.io/badge/mypy-100%25-green.svg)\n\nToolkit for TortoiseORM to generate database url from Django DATABASES item format.\n\n## Installation\n\n```bash\npip install tortoise-database-url\n```\nOr by uv/pdm:\n```bash\nuv add tortoise-database-url\npdm add tortoise-database-url\n```\n\n## Usage\n\n- DbUrl\n```py\nfrom tortoise_database_url import DbUrl\n\ndb_url = DbUrl.mysql('my_db', user='root', password='Me@example.com')\nprint(db_url)\n# mysql://root:Me%40example.com@127.0.0.1:3306/my_db\n```\n\n- generate\n\n```py\nimport tortoise_database_url\n\ndb_url = tortoise_database_url.generate('my_db', engine='mysql', user='root', password='Me@example.com')\nprint(db_url)\n# mysql://root:Me%40example.com@127.0.0.1:3306/my_db\n\ndb_url = tortoise_database_url.generate('db_name', engine='postgres')\nprint(db_url)\n# postgres://postgres:postgres@127.0.0.1:5432/db_name\n```\n\n- from_django_item\n```py\nimport pathlib\nimport tortoise_database_url\n\nDATABASES = {\n    \"default\": {\n        \"ENGINE\": \"django.db.backends.sqlite3\",\n        \"NAME\": pathlib.Path(\"/tmp\") / \"db.sqlite3\"\n    },\n}\n\ndb_url = tortoise_database_url.from_django_item(DATABASES[\"default\"])\nprint(db_url)\n# sqlte:///tmp/db.sqlite3\n```\nSee more at:\nhttps://github.com/waketzheng/database-url/blob/main/tests/test_main.py\nhttps://tortoise.github.io/databases.html?h=database\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "Make it easy to generate database url.",
    "version": "0.5.0",
    "project_urls": {
        "homepage": "https://github.com/waketzheng/database-url",
        "repository": "https://github.com/waketzheng/database-url.git"
    },
    "split_keywords": [
        "database_url",
        " tortoise-orm"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "37f3ef7987386d25a4e3859b938b0727278678f94d95622b0adb66fd01bc95fa",
                "md5": "4e42d1ac4a06b22ab3ff6f35047b2083",
                "sha256": "993c88f891a9f6bf872026ad2d1c6392891e586cc0effd34230a280951fa8dcd"
            },
            "downloads": -1,
            "filename": "tortoise_database_url-0.5.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "4e42d1ac4a06b22ab3ff6f35047b2083",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 4456,
            "upload_time": "2025-08-16T03:30:42",
            "upload_time_iso_8601": "2025-08-16T03:30:42.522556Z",
            "url": "https://files.pythonhosted.org/packages/37/f3/ef7987386d25a4e3859b938b0727278678f94d95622b0adb66fd01bc95fa/tortoise_database_url-0.5.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "c5ee1f15d2e6f65f2281f44109dff79e5e3ed7c506951157953748da0a63e2de",
                "md5": "5f430f2ae6839fedb78cd43445f708e7",
                "sha256": "f31d1536c726acc57e513e3c853091bde74cbcacb771f75ac26107240b6123da"
            },
            "downloads": -1,
            "filename": "tortoise_database_url-0.5.0.tar.gz",
            "has_sig": false,
            "md5_digest": "5f430f2ae6839fedb78cd43445f708e7",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 5356,
            "upload_time": "2025-08-16T03:30:44",
            "upload_time_iso_8601": "2025-08-16T03:30:44.094337Z",
            "url": "https://files.pythonhosted.org/packages/c5/ee/1f15d2e6f65f2281f44109dff79e5e3ed7c506951157953748da0a63e2de/tortoise_database_url-0.5.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-08-16 03:30:44",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "waketzheng",
    "github_project": "database-url",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "tortoise-database-url"
}
None
Elapsed time: 4.69148s