webcrawlers 0.2.dev1

===============
`Web Crawlers`_
===============

Copyright (c) 2016 Jeremie DECOCK (http://www.jdhp.org)


* Web site: http://www.jdhp.org/projects_en.html#web-crawlers
* Source code: https://github.com/jeremiedecock/web-crawlers
* Issue tracker: https://github.com/jeremiedecock/web-crawlers/issues
* Web Crawlers on PyPI: https://pypi.python.org/pypi/webcrawlers


Description
===========

Some web crawlers written with Python, feedparser and Beautifulsoup.

Note:

This project is still in beta stage, so the API is not finalized yet.


Dependencies
============

- Python >= 3.0
- Beautifulsoup
- Feedparser
- WaWA

.. _install:

Installation
============

Gnu/Linux
---------

You can install, upgrade, uninstall Web Crawlers with these commands (in a
terminal)::

pip install --pre webcrawlers
pip install --upgrade webcrawlers
pip uninstall webcrawlers

Or, if you have downloaded the Web Crawlers source code::

python3 setup.py install

.. There's also a package for Debian/Ubuntu::
..
.. sudo apt-get install webcrawlers

Windows
-------

Note:

The following installation procedure has been tested to work with Python
3.4 under Windows 7.
It should also work with recent Windows systems.

You can install, upgrade, uninstall Web Crawlers with these commands (in a
`command prompt`_)::

py -m pip install --pre webcrawlers
py -m pip install --upgrade webcrawlers
py -m pip uninstall webcrawlers

Or, if you have downloaded the Web Crawlers source code::

py setup.py install

MacOSX
-------

Note:

The following installation procedure has been tested to work with Python
3.5 under MacOSX 10.9 (*Mavericks*).
It should also work with recent MacOSX systems.

You can install, upgrade, uninstall Web Crawlers with these commands (in a
terminal)::

pip install --pre webcrawlers
pip install --upgrade webcrawlers
pip uninstall webcrawlers

Or, if you have downloaded the Web Crawlers source code::

python3 setup.py install


Bug reports
===========

To search for bugs or report them, please use the Web Crawlers Bug Tracker at:

https://github.com/jeremiedecock/web-crawlers/issues


License
=======

This project is provided under the terms and conditions of the
`MIT License`_.


.. _MIT License: http://opensource.org/licenses/MIT

.. _Web Crawlers: http://www.jdhp.org/projects_en.html#web-crawlers