Skip to main content

(Unofficial) Python Bindings for the WalkScore API

Branch

Unit Tests

latest

Build Status (Travis CI) Code Coverage Status (Codecov) Documentation Status (ReadTheDocs)

v.1.0

Build Status (Travis CI) Code Coverage Status (Codecov) Documentation Status (ReadTheDocs)

develop

Build Status (Travis CI) Code Coverage Status (Codecov) Documentation Status (ReadTheDocs)

The WalkScore Library is a Python library that provides Python bindings for the WalkScore API. It enables you to retrieve WalkScores, TransitScores, and BikeScores from the API within your Python code in Python versions 3.6 and higher.

COMPLETE DOCUMENTATION: http://walkscore-api.readthedocs.org/en/latest/index.html


Installation

To install the WalkScore Library, just execute:

$ pip install walkscore-api

Dependencies

Python 3.x


Key WalkScore Features

  • Python representation of WalkScores, TransitScores, and BikeScores.

  • Easy serialization and deserialization of API responses to Python objects, dict objects or JSON

  • Built-in back-off/retry logic if the WalkScore API is unstable at any mometn in time

  • Robust error handling to surface meaningful information to help you debug your code.


Hello, World and Basic Usage

1. Import the WalkScore API

from walkscore import WalkScoreAPI

2. Initialize the API

You can either use a single object to communicate with all of the available WalkScore APIs, or initialize a single object for each API:

api_key = 'YOUR API KEY GOES HERE'

walkscore_api = WalkScoreAPI(api_key = api_key)

3. Retrieve a Score

address = '123 Anyplace St Anywhere, AK 12345'

result = walkscore_api.get_score(latitude = 123.45, longitude = 54.321, address = address)

# the WalkScore for the location
result.walk_score

# the TransitScore for the location
result.transit_score

# the BikeScore for the location
result.bike_score

Questions and Issues

You can ask questions and report issues on the project’s Github Issues Page


Contributing

We welcome contributions and pull requests! For more information, please see the Contributor Guide.


Testing

We use TravisCI for our build automation and ReadTheDocs for our documentation.

Detailed information about our test suite and how to run tests locally can be found in our Testing Reference.


License

WalkScore is made available under an MIT License.

Metadata

Release files for walkscore-api 1.0.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Built distribution (wheel)

Table of built distributions (wheels) for walkscore-api 1.0.1
File Interpreter ABI Platform
walkscore_api-1.0.1-py2.py3-none-any.whl Python 3, Python 2 none any Details

Release files / walkscore_api-1.0.1-py2.py3-none-any.whl

Download URL walkscore_api-1.0.1-py2.py3-none-any.whl
Size 20.5 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
fd7dc4a25ea148859b32750b69995198b2ff4fa12f6badd650f90746f1ee2f09
BLAKE2b-256 checksum
How to use checksums
1decb598a6bf4fb946d92d2c752ce56fb9404d401324617d6422841092eb49c1
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.35.0 CPython/3.7.1

Release history Release notifications | RSS feed

This release

1.0.1 This release

1 release file

1.0.0

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page