Skip to main content

Tools for online voter registration in the United States of America

Project description

voter-tools

PyPI Tests Changelog License

Tools for online voter registration in the United States of America.

Contains a command-line tool (vote) and a python library (voter_tools) to:

  1. Check voter registration status in key states, currently including:
    • Georgia
    • Michigan
    • Pennsylvania
    • Wisconsin
  2. Perform online voter registration (OVR) directly with key states, via their APIs. We currently support the Pennsylvania OVR API with plans to support Michigan and Washington states in the future.

Installation

Install this library using pip:

pip install voter-tools

Command-line usage

Check registration of a single voter

To check whether a voter is registered:

vote check <first-name> <last-name> <zip> <dob YYYY-MM-DD> [--details]

This will tell you whether the user is registered to vote. You can request extra details (registration date, current status, etc.) with the --details flag. Not all states support all details.

Check registration of multiple voters in bulk

There is also a tool to check every record in a CSV file:

vote check-csv <input-file.csv> [--details]

A new CSV is written to stdout with the same fields as the input CSV plus extras related to the registration check.

Development

To contribute to this library, first checkout the code. Then create a new virtual environment:

cd voter-tools
python -m venv .venv
source .venv/bin/activate

Now install the dependencies and test dependencies:

pip install -e '.[dev]'

To run tests:

make test

To run a full lint/typecheck/test pass:

make check

Project details


Download files

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

Source Distribution

voter_tools-0.0.1.tar.gz (14.7 kB view details)

Uploaded Source

Built Distribution

voter_tools-0.0.1-py3-none-any.whl (17.0 kB view details)

Uploaded Python 3

File details

Details for the file voter_tools-0.0.1.tar.gz.

File metadata

  • Download URL: voter_tools-0.0.1.tar.gz
  • Upload date:
  • Size: 14.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.0 CPython/3.12.4

File hashes

Hashes for voter_tools-0.0.1.tar.gz
Algorithm Hash digest
SHA256 b8199d66ed6a7839efc51787ad4659465ab90b8fcd5381afa2fcca95fbefd20f
MD5 080f8284ab1d2323846edb04db5a6a04
BLAKE2b-256 54e20f9264d2f19e88fc7a40e745563c4c1db80d6720a692079037604e1e0026

See more details on using hashes here.

Provenance

File details

Details for the file voter_tools-0.0.1-py3-none-any.whl.

File metadata

  • Download URL: voter_tools-0.0.1-py3-none-any.whl
  • Upload date:
  • Size: 17.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.0 CPython/3.12.4

File hashes

Hashes for voter_tools-0.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 794e06134874b7354721845e18c6f143a4159e3cdd211ee1a92a5721a3d01bdd
MD5 11ce219d6d4f7e99bfe2554cc976a386
BLAKE2b-256 3268e0d1abfda3b8a8ca8272da4f2a5e116c40fc8696f0a1c698f21b2223496d

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page