moved miniuri.py our of src and added README

This commit is contained in:
RussellBallestrini 2012-06-29 20:19:48 -04:00
parent dd9171d3f0
commit 707324959d
3 changed files with 68 additions and 30 deletions

53
README Normal file
View file

@ -0,0 +1,53 @@
How to install
===================
easy_install miniuri
What does it do?
====================
miniuri is a universal URI parser class.
The parser grants access to the following attributes::
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
How to use
====================
This example shows how you can set and get any of the URI attributes::
>>> 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
How do I thank you?
=======================
You should follow me on http://twitter.com/russellbal
License
=======================
Public Domain

View file

@ -1,7 +1,7 @@
class Uri( object ): class Uri( object ):
""" """
This is a universal URI parser class. miniuri is a universal URI parser class.
Pass a URI string in for access to the following attributes: The parser grants access to the following attributes:
foo://username:password@test.com:808/go/to/index.php?pet=cat&name=bam#eye foo://username:password@test.com:808/go/to/index.php?pet=cat&name=bam#eye
\_/ \_______________/ \______/ \_/ \___/ \_/ \_______________/\_/ \_/ \_______________/ \______/ \_/ \___/ \_/ \_______________/\_/
@ -13,23 +13,17 @@ class Uri( object ):
| | | |
port filename port filename
This example shows how you can set and get any of the URI attributes: How to use:
.. code-block:: python .. code-block:: python
>>> from miniuri import Uri >>> 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")
>>> 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 >>> print u.hostname
www.foxhop.net www.foxhop.net
>>> print u.scheme
https
>>> u.username = 'max' >>> u.username = 'max'
>>> print u >>> print u.uri
https://max:pass@www.foxhop.net:81/path/filename.jpg?p=2#5 https://max:pass@www.foxhop.net:81/path/filename.jpg?p=2#5
""" """
def __init__( self, uri = None ): def __init__( self, uri = None ):
if uri: self.uri = uri # invoke uri.setter if uri: self.uri = uri # invoke uri.setter
@ -42,7 +36,7 @@ class Uri( object ):
if self.filename: filename = '/' + self.filename if self.filename: filename = '/' + self.filename
if self.query: query = '?' + self.query if self.query: query = '?' + self.query
if self.fragment: fragment = '#' + self.fragment if self.fragment: fragment = '#' + self.fragment
return ''.join( [scheme, self.authority, path, filename, query, fragment] ) return ''.join([scheme,self.authority,path,filename,query,fragment])
@uri.setter @uri.setter
def uri( self, uri ): def uri( self, uri ):

View file

@ -1,35 +1,26 @@
from setuptools import setup, find_packages # installation: easy_install miniuri
""" from setuptools import setup
Installation
===============
easy_install miniuri
"""
#requires = []
setup( setup(
name='miniuri', name='miniuri',
version='0.0.1', version='0.0.2',
description='Universal URI parser', long_description = open('README').read(),
description='miniuri: The Universal URI Parser',
keywords = 'miniuri uri url parser',
author = 'Russell Ballestrini', author = 'Russell Ballestrini',
author_email = 'russell@ballestrini.net', author_email = 'russell@ballestrini.net',
keywords = 'uri url parser', url = 'https://bitbucket.org/russellballestrini/miniuri/src',
url = 'https://bitbucket.org/russellballestrini/miniuri/src/tip/miniuri/miniuri.py',
platforms=['All'], platforms=['All'],
license='Public Domain', license='Public Domain',
#install_requires = requires,
#packages=find_packages(),
package_dir = {'': 'src'},
py_modules = ['miniuri'], py_modules = ['miniuri'],
include_package_data=True, include_package_data=True,
#zip_safe=False
) )
# setup keyword args: # setup keyword args: http://peak.telecommunity.com/DevCenter/setuptools
# http://peak.telecommunity.com/DevCenter/setuptools
# build and upload to pypi with this: # built and uploaded to pypi with this:
#python setup.py sdist bdist_egg register upload #python setup.py sdist bdist_egg register upload