1URLObject 2
2===========
3
4|PyPI| |Build Status| |Coverage Report| |Python Versions|
5
6``URLObject`` is a utility class for manipulating URLs. The latest
7incarnation of this library builds upon the ideas of its predecessor,
8but aims for a clearer API, focusing on proper method names over
9operator overrides. It's also being developed from the ground up in a
10test-driven manner, and has full Sphinx documentation.
11
12Installation
13------------
14
15URLObject is hosted on PyPI_. Install it using ``pip``:
16
17.. code:: sh
18
19 pip install URLObject
20
21Quickstart
22----------
23
24Check out the
25`quickstart <https://urlobject.readthedocs.org/en/latest/quickstart.html>`__
26on ReadTheDocs to get started.
27
28(Un)license
29-----------
30
31This is free and unencumbered software released into the public domain.
32
33Anyone is free to copy, modify, publish, use, compile, sell, or
34distribute this software, either in source code form or as a compiled
35binary, for any purpose, commercial or non-commercial, and by any means.
36
37In jurisdictions that recognize copyright laws, the author or authors of
38this software dedicate any and all copyright interest in the software to
39the public domain. We make this dedication for the benefit of the public
40at large and to the detriment of our heirs and successors. We intend
41this dedication to be an overt act of relinquishment in perpetuity of
42all present and future rights to this software under copyright law.
43
44THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
45OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
46MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
47IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
48LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
49FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
50DEALINGS IN THE SOFTWARE.
51
52For more information, please refer to http://unlicense.org/
53
54Credits
55~~~~~~~
56
57This library bundles `six <http://packages.python.org/six/>`__, which is
58licensed as follows:
59
60 Copyright (c) 2010-2012 Benjamin Peterson
61
62 Permission is hereby granted, free of charge, to any person
63 obtaining a copy of this software and associated documentation files
64 (the "Software"), to deal in the Software without restriction,
65 including without limitation the rights to use, copy, modify, merge,
66 publish, distribute, sublicense, and/or sell copies of the Software,
67 and to permit persons to whom the Software is furnished to do so,
68 subject to the following conditions:
69
70 The above copyright notice and this permission notice shall be
71 included in all copies or substantial portions of the Software.
72
73 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
74 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
75 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
76 NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
77 BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
78 ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
79 CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
80 SOFTWARE.
81
82Many thanks go to `Aron Griffis <http://arongriffis.com/>`__ for porting
83this library to Python 3, and to
84`vmalloc <https://github.com/vmalloc>`__ for work on the comprehensive
85API documentation and Sphinx setup.
86
87.. |PyPI| image:: https://img.shields.io/pypi/v/URLObject.svg?style=plastic
88 :target: PyPI_
89
90.. |Build Status| image:: https://img.shields.io/travis/zacharyvoase/urlobject/master.svg?style=plastic
91 :target: Travis_
92
93.. |Coverage Report| image:: https://img.shields.io/codecov/c/github/zacharyvoase/urlobject/master.svg?style=plastic
94 :target: CodeCov_
95
96.. |Python Versions| image:: https://img.shields.io/pypi/pyversions/urlobject.svg?style=plastic
97 :target: PyPI_
98
99.. _PyPI: https://pypi.python.org/pypi/URLObject
100
101.. _Travis: http://travis-ci.org/zacharyvoase/urlobject?branch=master
102
103.. _CodeCov: https://codecov.io/gh/zacharyvoase/urlobject/branch/master
104