Imported Upstream version 4.4.1
[platform/upstream/python-lxml.git] / README.rst
1 What is lxml?
2 =============
3
4 lxml is the most feature-rich and easy-to-use library for processing XML and HTML in the Python language.
5 It's also very fast and memory friendly, just so you know.
6
7 For an introduction and further documentation, see `doc/main.txt`_.
8
9 For installation information, see `INSTALL.txt`_.
10
11 For issue tracker, see https://bugs.launchpad.net/lxml
12
13 Support the project
14 -------------------
15
16 lxml has been downloaded from the `Python Package Index`_
17 millions of times and is also available directly in many package
18 distributions, e.g. for Linux or MacOS-X.
19
20 .. _`Python Package Index`: https://pypi.python.org/pypi/lxml
21
22 Most people who use lxml do so because they like using it.
23 You can show us that you like it by blogging about your experience
24 with it and linking to the project website.
25
26 If you are using lxml for your work and feel like giving a bit of
27 your own benefit back to support the project, consider sending us
28 money through PayPal that we can use for fixing bugs in the software
29 and improving its features and documentation.  Please read the Legal
30 Notice below, at the bottom of this page.  Thank you for your support.
31
32 .. class:: center
33
34   |Donate|_
35
36 .. _Donate: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=R56JE3VCPDA9N
37
38 Please `contact Stefan Behnel <http://consulting.behnel.de/>`_
39 for other ways to support the lxml project,
40 as well as commercial consulting, customisations and trainings on lxml and
41 fast Python XML processing.
42
43 .. |Donate| image:: https://lxml.de/paypal_btn_donateCC_LG.png
44             :width: 160
45             :height: 47
46             :alt: Donate to the lxml project
47
48 .. _`doc/main.txt`: https://github.com/lxml/lxml/blob/master/doc/main.txt
49 .. _`INSTALL.txt`: http://lxml.de/installation.html
50
51 `Travis-CI <https://travis-ci.org/>`_ and `AppVeyor <https://www.appveyor.com/>`_
52 support the lxml project with their build and CI servers.
53 Jetbrains supports the lxml project by donating free licenses of their
54 `PyCharm IDE <https://www.jetbrains.com/pycharm/>`_.
55
56
57 Legal Notice for Donations
58 --------------------------
59
60 Any donation that you make to the lxml project is voluntary and
61 is not a fee for any services, goods, or advantages.  By making
62 a donation to the lxml project, you acknowledge that we have the
63 right to use the money you donate in any lawful way and for any
64 lawful purpose we see fit and we are not obligated to disclose
65 the way and purpose to any party unless required by applicable
66 law.  Although lxml is free software, to the best of our knowledge
67 the lxml project does not have any tax exempt status.  The lxml
68 project is neither a registered non-profit corporation nor a
69 registered charity in any country.  Your donation may or may not
70 be tax-deductible; please consult your tax advisor in this matter.
71 We will not publish or disclose your name and/or e-mail address
72 without your consent, unless required by applicable law.  Your
73 donation is non-refundable.