ae1d7cad65ecfe0c012bf05be0b3b0029325499c
[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 GitHub Sponsors, Tidelift or PayPal that we can use
29 to buy us free time for the maintenance of this great library, to
30 fix bugs in the software, review and integrate code contributions,
31 and improving its features and documentation.  Please read the
32 Legal Notice below, at the bottom of this page.
33 Thank you for your support.
34
35 .. class:: center
36
37   Support lxml through `GitHub Sponsors <https://github.com/users/scoder/sponsorship>`_
38
39   (Note: GitHub will currently double your donation!)
40
41   via `Tidelift <https://tidelift.com/subscription/pkg/pypi-lxml>`_
42
43   or via PayPal:
44
45   |Donate|_
46
47 .. _`Donate`: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=R56JE3VCPDA9N
48
49 Please `contact Stefan Behnel <http://consulting.behnel.de/>`_
50 for other ways to support the lxml project,
51 as well as commercial consulting, customisations and trainings on lxml and
52 fast Python XML processing.
53
54 .. |Donate| image:: https://lxml.de/paypal_btn_donateCC_LG.png
55             :width: 160
56             :height: 47
57             :alt: Donate to the lxml project
58
59 .. _`doc/main.txt`: https://github.com/lxml/lxml/blob/master/doc/main.txt
60 .. _`INSTALL.txt`: http://lxml.de/installation.html
61
62 `Travis-CI <https://travis-ci.org/>`_ and `AppVeyor <https://www.appveyor.com/>`_
63 support the lxml project with their build and CI servers.
64 Jetbrains supports the lxml project by donating free licenses of their
65 `PyCharm IDE <https://www.jetbrains.com/pycharm/>`_.
66 Another supporter of the lxml project is
67 `COLOGNE Webdesign <https://www.colognewebdesign.de/>`_.
68
69
70 Project income report
71 ---------------------
72
73 * Total project income in 2019: EUR 717.52  (59.79 € / month)
74
75   - Tidelift: EUR 360.30
76   - Paypal: EUR 157.22
77   - other: EUR 200.00
78
79
80 Legal Notice for Donations
81 --------------------------
82
83 Any donation that you make to the lxml project is voluntary and
84 is not a fee for any services, goods, or advantages.  By making
85 a donation to the lxml project, you acknowledge that we have the
86 right to use the money you donate in any lawful way and for any
87 lawful purpose we see fit and we are not obligated to disclose
88 the way and purpose to any party unless required by applicable
89 law.  Although lxml is free software, to the best of our knowledge
90 the lxml project does not have any tax exempt status.  The lxml
91 project is neither a registered non-profit corporation nor a
92 registered charity in any country.  Your donation may or may not
93 be tax-deductible; please consult your tax advisor in this matter.
94 We will not publish or disclose your name and/or e-mail address
95 without your consent, unless required by applicable law.  Your
96 donation is non-refundable.