miniuri/README.rst
russellballestrini 1261b26990 Add more tests and make most attrs default to None
changed .hgignore
changed README.rst
changed miniuri/miniuri.py
changed setup.py
changed test_miniuri.py
2019-03-02 08:49:45 -05:00

73 lines
1.7 KiB
ReStructuredText

miniuri
#######
miniuri is a universal URI parser class.
Only 145 lines of Python (400 lines if you count unit tests).
Installation
============
.. code-block:: bash
pip install miniuri
What does it do?
================
The parser grants access to the following attributes:
.. code-block:: text
foo://username:password@test.com:808/go/to/index.php?pet=cat&name=bam#eye
\_/ \_______________/ \______/ \_/ \___/ \_/ \_______________/\_/
| | | | | | | |
| userinfo hostname | | | query fragment
| \___________________________|/\________|____|_/
| | | | | |
scheme authority | path | extension
| |
port filename
Tutorial
========
This example shows how you can set and get any of the URI attributes:
.. code-block:: python
>>> from miniuri import Uri
>>> u = Uri( "http://www.foxhop.net/samsung/HL-T5087SA/red-LED-failure" )
>>> u.uri = "https://fox:pass@www.foxhop.net:81/path/filename.jpg?p=2#5"
>>> print(u.uri)
'https://fox:pass@www.foxhop.net:81/path/filename.jpg?p=2#5'
>>> print(u.hostname)
'www.foxhop.net'
>>> print(u.scheme)
'https'
>>> u.username = 'max'
>>> print(u)
'https://max:pass@www.foxhop.net:81/path/filename.jpg?p=2#5'
>>> print(u.relative_uri)
'/path/filename.jpg?p=2#5'
How do I thank you?
===================
You should follow me on http://twitter.com/russellbal
License
===================
Public Domain
Public Revision Control
=======================
https://bitbucket.org/russellballestrini/miniuri/overview