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
|
..
This file is part of feedparser.
Copyright 2010-2025 Kurt McKee <contactme@kurtmckee.org>
Copyright 2002-2008 Mark Pilgrim
Released under the BSD 2-clause license.
feedparser
##########
Parse Atom and RSS feeds in Python.
----
Installation
============
feedparser can be installed by running pip:
.. code-block:: console
$ pip install feedparser
Documentation
=============
The feedparser documentation is available on the web at:
https://feedparser.readthedocs.io/en/latest/
It is also included in its source format, ReST, in the ``docs/`` directory.
To build the documentation you'll need the Sphinx package, which is available at:
https://www.sphinx-doc.org/
You can then build HTML pages using a command similar to:
.. code-block:: console
$ sphinx-build -b html docs/ fpdocs
This will produce HTML documentation in the ``fpdocs/`` directory.
Testing
=======
Feedparser has an extensive test suite, powered by tox. To run it, type this:
.. code-block:: console
$ python -m venv venv
$ source venv/bin/activate # or "venv\bin\activate.ps1" on Windows
(venv) $ pip install -r requirements-dev.txt
(venv) $ tox
This will spawn an HTTP server that will listen on port 8097. The tests will
fail if that port is in use.
|
