tortoise-database-url


Nametortoise-database-url JSON
Version 0.1.4 PyPI version JSON
download
home_pagehttps://github.com/waketzheng/database-url
SummaryMake it easy to generate database url.
upload_time2024-12-31 09:32:21
maintainerNone
docs_urlNone
authorWaket Zheng
requires_python<4.0,>=3.9
licenseNone
keywords database-url 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
```

## Usage

- generate

```py
import database_url

db_url = 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 = 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 database_url

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

db_url = 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": "https://github.com/waketzheng/database-url",
    "name": "tortoise-database-url",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<4.0,>=3.9",
    "maintainer_email": null,
    "keywords": "database-url, database_url, tortoise-orm",
    "author": "Waket Zheng",
    "author_email": "waketzheng@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/45/eb/dc86f7af8c3de81574d89c0592b093baf5bad00b6a3b69f0fe72e8b56e3e/tortoise_database_url-0.1.4.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```\n\n## Usage\n\n- generate\n\n```py\nimport database_url\n\ndb_url = 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 = 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 database_url\n\nDATABASES = {\n    \"default\": {\n        \"ENGINE\": \"django.db.backends.sqlite3\",\n        \"NAME\": pathlib.Path(\"/tmp\") / \"db.sqlite3\"\n    },\n}\n\ndb_url = 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.1.4",
    "project_urls": {
        "Homepage": "https://github.com/waketzheng/database-url",
        "Repository": "https://github.com/waketzheng/database-url.git"
    },
    "split_keywords": [
        "database-url",
        " database_url",
        " tortoise-orm"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "3f6d01d4a278b94477f60f433bcb48943a5ce195806ac0886620731ee776a4a5",
                "md5": "2b13f8ce8c4b86af5bb0c57a5815cd5f",
                "sha256": "8bb1da396a6ee2d00df58f9328ca1ec1722cfd3ff3ea898e696a8bdf313c2605"
            },
            "downloads": -1,
            "filename": "tortoise_database_url-0.1.4-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "2b13f8ce8c4b86af5bb0c57a5815cd5f",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4.0,>=3.9",
            "size": 3611,
            "upload_time": "2024-12-31T09:32:18",
            "upload_time_iso_8601": "2024-12-31T09:32:18.934508Z",
            "url": "https://files.pythonhosted.org/packages/3f/6d/01d4a278b94477f60f433bcb48943a5ce195806ac0886620731ee776a4a5/tortoise_database_url-0.1.4-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "45ebdc86f7af8c3de81574d89c0592b093baf5bad00b6a3b69f0fe72e8b56e3e",
                "md5": "4f24243a0cea0d48264222de7305d944",
                "sha256": "073d8f4d79026afb3ce4547125c6771b4d17673c547f745f973a40681288ac3b"
            },
            "downloads": -1,
            "filename": "tortoise_database_url-0.1.4.tar.gz",
            "has_sig": false,
            "md5_digest": "4f24243a0cea0d48264222de7305d944",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4.0,>=3.9",
            "size": 2928,
            "upload_time": "2024-12-31T09:32:21",
            "upload_time_iso_8601": "2024-12-31T09:32:21.188241Z",
            "url": "https://files.pythonhosted.org/packages/45/eb/dc86f7af8c3de81574d89c0592b093baf5bad00b6a3b69f0fe72e8b56e3e/tortoise_database_url-0.1.4.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-12-31 09:32:21",
    "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"
}
Waket Zheng
Elapsed time: 0.82741s