Introduction
============

|Latest Version| |Supported Versions|

PyPy3 is also supported (and tested against).

Find MechanicalSoup on `Python Package Index (Pypi)
<https://pypi.python.org/pypi/MechanicalSoup/>`__ and follow the
development on `GitHub <https://github.com/MechanicalSoup/MechanicalSoup>`__.

Installation
------------

Download and install the latest released version from `PyPI <https://pypi.python.org/pypi/MechanicalSoup/>`__::

  pip install MechanicalSoup

Download and install the development version from GitHub::

  pip install git+https://github.com/MechanicalSoup/MechanicalSoup

Installing from source (installs the version in the current working directory)::

  git clone https://github.com/MechanicalSoup/MechanicalSoup.git
  cd MechanicalSoup
  python setup.py install

(In all cases, add ``--user`` to the ``install`` command to
install in the current user's home directory.)

Example code: https://github.com/MechanicalSoup/MechanicalSoup/tree/main/examples/

.. |Latest Version| image:: https://img.shields.io/pypi/v/MechanicalSoup.svg
   :target: https://pypi.python.org/pypi/MechanicalSoup/
.. |Supported Versions| image:: https://img.shields.io/pypi/pyversions/mechanicalsoup.svg
   :target: https://pypi.python.org/pypi/MechanicalSoup/