urlx


Nameurlx JSON
Version 1.0.1 PyPI version JSON
download
home_pagehttps://volodymyrbor.github.io/urlx/
SummaryThe purpose of this package is to standardize URL declaration in the codebase
upload_time2022-12-02 17:10:02
maintainer
docs_urlNone
authorvolodymyrb
requires_python>=3.10,<4.0
licenseMIT
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            <p align="center">
    <a href="https://volodymyrbor.github.io/urlx">
        <img src="https://volodymyrbor.github.io/urlx/img/icon.png" alt="urlx" width="300">
    </a>
</p>

# UrlX

<a href="https://pypi.org/project/urlx" target="_blank">
    <img src="https://img.shields.io/pypi/pyversions/urlx.svg?color=%2334D058" alt="Supported Python versions">
</a>
<a href="https://pypi.org/project/urlx" target="_blank">
    <img src="https://img.shields.io/pypi/v/urlx?color=%2334D058&label=pypi%20package" alt="Package version">
</a>
<img src="https://github.com/VolodymyrBor/urlx/actions/workflows/build.yml/badge.svg?event=push&branch=master" alt="Build">
<img src="https://github.com/VolodymyrBor/urlx/actions/workflows/deploy-docs.yml/badge.svg" alt="Docs">

[![Supported Versions](https://img.shields.io/badge/coverage-100%25-green)](https://shields.io/)
[![Supported Versions](https://img.shields.io/badge/poetry-✅-grey)](https://shields.io/)
[![Supported Versions](https://img.shields.io/badge/async-✅-grey)](https://shields.io/)
[![Supported Versions](https://img.shields.io/badge/mypy-✅-grey)](https://shields.io/)

---

**urlx** - provide new data type - `Url`.
The purpose of this package is to standardize URL declaration in the codebase.
This approach should reduce the number of errors and speed up code writing.

---

## Example

```python
from pathlib import Path

from urlx import Url, Protocol, Port

url = Url(
    protocol=Protocol.HTTPS,
    host='localhost',
    port=Port.HTTPS_443,
    path=Path('api/user-list'),
    query={
        'limit': '100',
        'skip': '20',
    },
)
print(url)
```
Output: 

> https://localhost:443/api/user-list?limit=100&skip=20

---

## Links

**Source code**: [github.com/VolodymyrBor/urlx](https://github.com/VolodymyrBor/urlx)

**Documentation**: [urlx](https://volodymyrbor.github.io/urlx/)

**Changelog**: [changelog](https://volodymyrbor.github.io/urlx/changelog)

            

Raw data

            {
    "_id": null,
    "home_page": "https://volodymyrbor.github.io/urlx/",
    "name": "urlx",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.10,<4.0",
    "maintainer_email": "",
    "keywords": "",
    "author": "volodymyrb",
    "author_email": "volodymyr.borysiuk0@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/22/53/85d0708bdc4e19e2f94865dcc7464b22b8f544ef99c7c77fac61a5e4ebb0/urlx-1.0.1.tar.gz",
    "platform": null,
    "description": "<p align=\"center\">\n    <a href=\"https://volodymyrbor.github.io/urlx\">\n        <img src=\"https://volodymyrbor.github.io/urlx/img/icon.png\" alt=\"urlx\" width=\"300\">\n    </a>\n</p>\n\n# UrlX\n\n<a href=\"https://pypi.org/project/urlx\" target=\"_blank\">\n    <img src=\"https://img.shields.io/pypi/pyversions/urlx.svg?color=%2334D058\" alt=\"Supported Python versions\">\n</a>\n<a href=\"https://pypi.org/project/urlx\" target=\"_blank\">\n    <img src=\"https://img.shields.io/pypi/v/urlx?color=%2334D058&label=pypi%20package\" alt=\"Package version\">\n</a>\n<img src=\"https://github.com/VolodymyrBor/urlx/actions/workflows/build.yml/badge.svg?event=push&branch=master\" alt=\"Build\">\n<img src=\"https://github.com/VolodymyrBor/urlx/actions/workflows/deploy-docs.yml/badge.svg\" alt=\"Docs\">\n\n[![Supported Versions](https://img.shields.io/badge/coverage-100%25-green)](https://shields.io/)\n[![Supported Versions](https://img.shields.io/badge/poetry-\u2705-grey)](https://shields.io/)\n[![Supported Versions](https://img.shields.io/badge/async-\u2705-grey)](https://shields.io/)\n[![Supported Versions](https://img.shields.io/badge/mypy-\u2705-grey)](https://shields.io/)\n\n---\n\n**urlx** - provide new data type - `Url`.\nThe purpose of this package is to standardize URL declaration in the codebase.\nThis approach should reduce the number of errors and speed up code writing.\n\n---\n\n## Example\n\n```python\nfrom pathlib import Path\n\nfrom urlx import Url, Protocol, Port\n\nurl = Url(\n    protocol=Protocol.HTTPS,\n    host='localhost',\n    port=Port.HTTPS_443,\n    path=Path('api/user-list'),\n    query={\n        'limit': '100',\n        'skip': '20',\n    },\n)\nprint(url)\n```\nOutput: \n\n> https://localhost:443/api/user-list?limit=100&skip=20\n\n---\n\n## Links\n\n**Source code**: [github.com/VolodymyrBor/urlx](https://github.com/VolodymyrBor/urlx)\n\n**Documentation**: [urlx](https://volodymyrbor.github.io/urlx/)\n\n**Changelog**: [changelog](https://volodymyrbor.github.io/urlx/changelog)\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "The purpose of this package is to standardize URL declaration in the codebase",
    "version": "1.0.1",
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "29f0a7b484dc9ff718cca8bae7098a08",
                "sha256": "d4bae4cc635e93194b1af857cf5652027529120b275421899ecf5dd84f546a03"
            },
            "downloads": -1,
            "filename": "urlx-1.0.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "29f0a7b484dc9ff718cca8bae7098a08",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10,<4.0",
            "size": 6241,
            "upload_time": "2022-12-02T17:10:01",
            "upload_time_iso_8601": "2022-12-02T17:10:01.032057Z",
            "url": "https://files.pythonhosted.org/packages/56/3b/36524717d1d14a25080b7aafc00b1d7ab34e8e782313e9c58f87839d01b7/urlx-1.0.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "bd0485ca727ca0fd1c25b27159e9c5cd",
                "sha256": "c1e7b92f207a7f968eded182f0070e4859e02e1c000e1772ee22f62c1f730925"
            },
            "downloads": -1,
            "filename": "urlx-1.0.1.tar.gz",
            "has_sig": false,
            "md5_digest": "bd0485ca727ca0fd1c25b27159e9c5cd",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10,<4.0",
            "size": 5474,
            "upload_time": "2022-12-02T17:10:02",
            "upload_time_iso_8601": "2022-12-02T17:10:02.196657Z",
            "url": "https://files.pythonhosted.org/packages/22/53/85d0708bdc4e19e2f94865dcc7464b22b8f544ef99c7c77fac61a5e4ebb0/urlx-1.0.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2022-12-02 17:10:02",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "lcname": "urlx"
}
        
Elapsed time: 0.16528s