Skip to main content
Help us improve Python packaging – donate today!

Fill HTML login forms automatically

Project Description

https://secure.travis-ci.org/scrapy/loginform.png?branch=master Coverage report

loginform is a library for filling HTML login forms given the login url, username & password. Which form and fields to fill are inferred automatically.

It’s implemented on top of lxml form filling, and thus depends on lxml.

Usage

Usage is very simple and best illustrated with an example:

>>> from loginform import fill_login_form
>>> import requests
>>> url = "https://github.com/login"
>>> r = requests.get(url)
>>> fill_login_form(url, r.text, "john", "secret")
([('authenticity_token', 'FQgPiKd1waDL+pycPH8IGutirTnP69SiZgm0zXwn+VQ='),
  ('login', 'john'),
  ('password', 'secret')],
 u'https://github.com/session',
 'POST')

And it is possible to use it as a tool to quickly debug a login form:

$ python -m loginform -u john -p secret https://github.com/login
url: https://github.com/session
method: POST
payload:
- authenticity_token: FQgPiKd1waDL+pycPH8IGutirTnP69SiZgm0zXwn+VQ=
- login: john
- password: secret

Testing

A collection of real-world samples is used to keep this library tested. Those samples are managed as follows:

First, you select a site to try, find out its login url, and run the following command to try loginform on it:

$ python test_samples.py https://github.com/login
[
   "https://github.com/login",
   [
      [
         [
            "authenticity_token",
            "NsdVWGpzxKmn7zSJSOdgnDcLIzIdJlCTO754LiEv2W4="
         ],
         [
            "login",
            "USER"
         ],
         [
            "password",
            "PASS"
         ]
      ],
      "https://github.com/session",
      "POST"
   ]
]

From the output you can judge if it worked or not. If it worked, great. If it didn’t, you would hack loginform.py to make it work and then add the sample with:

$ python test_samples.py https://github.com/login -w github

Note that we gave the sample a name (github in this case).

To list all available samples use:

$ python test_samples.py -l

To run all tests, install tox and run:

$ tox

Release history Release notifications

This version
History Node

1.2.0

History Node

1.1.1

History Node

1.0

History Node

0.9

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
loginform-1.2.0-py2-none-any.whl (3.3 kB) Copy SHA256 hash SHA256 Wheel py2 Aug 16, 2016
loginform-1.2.0.tar.gz (3.1 kB) Copy SHA256 hash SHA256 Source None Aug 16, 2016

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page