Immutable, Pythonic, correct URLs. (LADI project)
Go to file
Mahmoud Hashemi a451f3dcad bump version for v21.0.1dev 2021-01-07 22:01:07 -08:00
docs bump docs version, write v21.0.0 changelog 2021-01-07 21:59:56 -08:00
src/hyperlink Don't force encode + 2020-12-28 21:43:47 -08:00
.appveyor.yml Test Python 3.8 on Windows 2019-12-29 19:52:07 +02:00
.coveragerc Omit flycheck files. 2019-10-19 18:19:49 -07:00
.gitignore Merge branch 'master' into strategies 2020-04-14 17:18:58 -07:00
.travis.yml Spiff up the tox config a bit more 2020-04-01 19:34:40 -07:00
CHANGELOG.md bump docs version, write v21.0.0 changelog 2021-01-07 21:59:56 -08:00
LICENSE Disable HealthCheck.too_slow in CI. 2019-11-06 16:42:28 -08:00
MANIFEST.in There is no requirements-test.txt file in the source tree. 2020-04-01 19:34:16 -07:00
README.md fix pypi badge typo 2020-08-03 23:35:40 -07:00
TODO.md Fix a typo in the docs 2019-10-21 18:27:19 +01:00
pyproject.toml Check in black config 2020-01-25 15:25:47 -08:00
pytest.ini add pytest.ini to enable doctest ALLOW_UNICODE (to get rid of errors on u'') 2017-03-13 23:09:25 -07:00
setup.cfg add setup.cfg for universal wheels 2017-05-06 17:21:52 -07:00
setup.py bump version for v21.0.1dev 2021-01-07 22:01:07 -08:00
tox.ini [requires.io] dependency update 2021-01-07 09:14:23 -08:00

README.md

Hyperlink

Cool URLs that don't change.

Documentation PyPI Calendar Versioning Python Version Compatibility Code Coverage Requirements Status

Hyperlink provides a pure-Python implementation of immutable URLs. Based on RFC 3986 and 3987, the Hyperlink URL makes working with both URIs and IRIs easy.

Hyperlink is tested against Python 2.7, 3.4, 3.5, 3.6, 3.7, 3.8, and PyPy.

Full documentation is available on Read the Docs.

Installation

Hyperlink is a pure-Python package and requires nothing but Python. The easiest way to install is with pip:

pip install hyperlink

Then, hyperlink away!

from hyperlink import URL

url = URL.from_text(u'http://github.com/python-hyper/hyperlink?utm_source=README')
utm_source = url.get(u'utm_source')
better_url = url.replace(scheme=u'https', port=443)
org_url = better_url.click(u'.')

See the full API docs on Read the Docs.

More information

Hyperlink would not have been possible without the help of Glyph Lefkowitz and many other community members, especially considering that it started as an extract from the Twisted networking library. Thanks to them, Hyperlink's URL has been production-grade for well over a decade.

Still, should you encounter any issues, do file an issue, or submit a pull request.