.. This file is part of feedparser. Copyright 2010-2024 Kurt McKee [email protected] Copyright 2002-2008 Mark Pilgrim Released under the BSD 2-clause license.
feedparser ##########
Parse Atom and RSS feeds in Python.
feedparser can be installed by running pip:
.. code-block:: console
$ pip install feedparser
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.
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) $ python -m pip install --upgrade pip
(venv) $ python -m pip install tox
(venv) $ tox