Update README with extra information
This commit is contained in:
41
README.rst
41
README.rst
@@ -4,6 +4,18 @@ rfc3986
|
||||
A Python implementation of `RFC 3986`_ including validation and authority
|
||||
parsing. Coming soon: `Reference Resolution <http://tools.ietf.org/html/rfc3986#section-5>`_.
|
||||
|
||||
Installation
|
||||
------------
|
||||
|
||||
Simply use pip to install ``rfc3986`` like so::
|
||||
|
||||
pip install rfc3986
|
||||
|
||||
License
|
||||
-------
|
||||
|
||||
`Apache License Version 2.0`_
|
||||
|
||||
Example Usage
|
||||
-------------
|
||||
|
||||
@@ -70,4 +82,33 @@ You can also very simply validate a URI::
|
||||
|
||||
assert is_valid_uri('hTTp://exAMPLe.COM/Some/reallY/biZZare/pAth')
|
||||
|
||||
|
||||
Alternatives
|
||||
------------
|
||||
|
||||
- `rfc3987 <https://pypi.python.org/pypi/rfc3987/1.3.4>`_
|
||||
|
||||
This is a direct competitor to this library, with extra features,
|
||||
licensed under the GPL.
|
||||
|
||||
- `uritools <https://pypi.python.org/pypi/uritools/0.5.1>`_
|
||||
|
||||
This can parse URIs in the manner of RFC 3986 but provides no validation and
|
||||
only recently added Python 3 support.
|
||||
|
||||
- Standard library's `urlparse`/`urllib.parse`
|
||||
|
||||
The functions in these libraries can only split a URI (valid or not) and
|
||||
provide no validation.
|
||||
|
||||
Contributing
|
||||
------------
|
||||
|
||||
This project follows and enforces the Python Software Foundation's `Code of
|
||||
Conduct <https://www.python.org/psf/codeofconduct/>`_.
|
||||
|
||||
If you would like to contribute but do not have a bug or feature in mind, feel
|
||||
free to email Ian and find out how you can help.
|
||||
|
||||
.. _RFC 3986: http://tools.ietf.org/html/rfc3986
|
||||
.. _Apache License Version 2.0: https://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Reference in New Issue
Block a user