Immutable, Pythonic, correct URLs. (LADI project)
Go to file
Mahmoud Hashemi 20c45e16c7 bumping docs version to 17.3.0 2017-07-18 23:25:22 -07:00
docs bumping docs version to 17.3.0 2017-07-18 23:25:22 -07:00
hyperlink add an invalid authority for a bit more coverage 2017-07-17 19:58:46 -07:00
.gitignore gitignore .coverage files 2017-06-17 11:13:40 -07:00
.tox-coveragerc coverage run's "source" can be a path or a module. 2017-04-22 12:55:19 -07:00
.travis.yml add packaging test to travis 2017-07-18 01:23:45 -07:00
CHANGELOG.md add version 17.2.1 changelog 2017-06-18 12:34:26 -07:00
LICENSE MIT 2017-04-15 15:23:48 -07:00
MANIFEST.in add more files to the sdist, plus a check-manifest-based tox test that everything is included 2017-07-17 19:39:29 -07:00
README.md Various fixes to the README 2017-07-08 13:51:22 +01:00
TODO.md feature idea: path rebase 2017-07-16 15:00:27 -07:00
appveyor.yml Call coverage xml manually before codecov 2017-04-22 13:15:30 -07: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
requirements-test.txt WIP: trying to get tox toxing 2017-03-13 20:19:49 -07:00
setup.cfg add setup.cfg for universal wheels 2017-05-06 17:21:52 -07:00
setup.py bump version for 17.3.0 release 2017-07-18 23:24:08 -07:00
tox.ini add more files to the sdist, plus a check-manifest-based tox test that everything is included 2017-07-17 19:39:29 -07:00

README.md

Hyperlink

Cool URLs that don't change.

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, 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('http://github.com/mahmoud/hyperlink?utm_source=README')
utm_source = url.get('utm_source')
better_url = url.replace(scheme='https')
user_url = better_url.click('..')

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.