File: README.rst

package info (click to toggle)
python-urlobject 2.4.3-3
  • links: PTS, VCS
  • area: main
  • in suites: bullseye, sid
  • size: 284 kB
  • sloc: python: 1,332; makefile: 134
file content (103 lines) | stat: -rw-r--r-- 4,047 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
URLObject 2
===========

|PyPI| |Build Status| |Coverage Report| |Python Versions|

``URLObject`` is a utility class for manipulating URLs. The latest
incarnation of this library builds upon the ideas of its predecessor,
but aims for a clearer API, focusing on proper method names over
operator overrides. It's also being developed from the ground up in a
test-driven manner, and has full Sphinx documentation.

Installation
------------

URLObject is hosted on PyPI_. Install it using ``pip``:

.. code:: sh

    pip install URLObject

Quickstart
----------

Check out the
`quickstart <https://urlobject.readthedocs.org/en/latest/quickstart.html>`__
on ReadTheDocs to get started.

(Un)license
-----------

This is free and unencumbered software released into the public domain.

Anyone is free to copy, modify, publish, use, compile, sell, or
distribute this software, either in source code form or as a compiled
binary, for any purpose, commercial or non-commercial, and by any means.

In jurisdictions that recognize copyright laws, the author or authors of
this software dedicate any and all copyright interest in the software to
the public domain. We make this dedication for the benefit of the public
at large and to the detriment of our heirs and successors. We intend
this dedication to be an overt act of relinquishment in perpetuity of
all present and future rights to this software under copyright law.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.

For more information, please refer to http://unlicense.org/

Credits
~~~~~~~

This library uses `six <http://packages.python.org/six/>`__, which is
licensed as follows:

    Copyright (c) 2010-2012 Benjamin Peterson

    Permission is hereby granted, free of charge, to any person
    obtaining a copy of this software and associated documentation files
    (the "Software"), to deal in the Software without restriction,
    including without limitation the rights to use, copy, modify, merge,
    publish, distribute, sublicense, and/or sell copies of the Software,
    and to permit persons to whom the Software is furnished to do so,
    subject to the following conditions:

    The above copyright notice and this permission notice shall be
    included in all copies or substantial portions of the Software.

    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
    EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
    MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
    NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
    BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
    ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
    CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
    SOFTWARE.

Many thanks go to `Aron Griffis <http://arongriffis.com/>`__ for porting
this library to Python 3, and to
`vmalloc <https://github.com/vmalloc>`__ for work on the comprehensive
API documentation and Sphinx setup.

.. |PyPI| image:: https://img.shields.io/pypi/v/URLObject.svg?style=plastic
   :target: PyPI_

.. |Build Status| image:: https://img.shields.io/travis/zacharyvoase/urlobject/master.svg?style=plastic
   :target: Travis_

.. |Coverage Report| image:: https://img.shields.io/codecov/c/github/zacharyvoase/urlobject/master.svg?style=plastic
   :target: CodeCov_

.. |Python Versions| image:: https://img.shields.io/pypi/pyversions/urlobject.svg?style=plastic
   :target: PyPI_

.. _PyPI: https://pypi.python.org/pypi/URLObject

.. _Travis: http://travis-ci.org/zacharyvoase/urlobject?branch=master

.. _CodeCov: https://codecov.io/gh/zacharyvoase/urlobject/branch/master