{ "info": { "author": "Insight Industry Inc.", "author_email": "software@insightindustry.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 4 - Beta", "Environment :: Web Environment", "Intended Audience :: Developers", "License :: OSI Approved :: MIT License", "Operating System :: OS Independent", "Programming Language :: Python :: 3.6", "Programming Language :: Python :: 3.7", "Topic :: Database :: Front-Ends", "Topic :: Internet :: WWW/HTTP :: Dynamic Content", "Topic :: Software Development :: Libraries", "Topic :: Software Development :: Libraries :: Python Modules", "Topic :: Utilities" ], "description": "####################################################\nThe WalkScore Library\n####################################################\n\n**(Unofficial) Python Bindings for the WalkScore API**\n\n.. list-table::\n :widths: 10 90\n :header-rows: 1\n\n * - Branch\n - Unit Tests\n * - `latest `_\n -\n .. image:: https://travis-ci.org/insightindustry/walkscore-api.svg?branch=master\n :target: https://travis-ci.org/insightindustry/walkscore\n :alt: Build Status (Travis CI)\n\n .. image:: https://codecov.io/gh/insightindustry/walkscore-api/branch/master/graph/badge.svg\n :target: https://codecov.io/gh/insightindustry/walkscore\n :alt: Code Coverage Status (Codecov)\n\n .. image:: https://readthedocs.org/projects/walkscore-api/badge/?version=latest\n :target: http://walkscore-api.readthedocs.io/en/latest/?badge=latest\n :alt: Documentation Status (ReadTheDocs)\n\n * - `v.1.0 `_\n -\n .. image:: https://travis-ci.org/insightindustry/walkscore-api.svg?branch=v.1.0.0\n :target: https://travis-ci.org/insightindustry/walkscore\n :alt: Build Status (Travis CI)\n\n .. image:: https://codecov.io/gh/insightindustry/walkscore-api/branch/v.1.0.0/graph/badge.svg\n :target: https://codecov.io/gh/insightindustry/walkscore\n :alt: Code Coverage Status (Codecov)\n\n .. image:: https://readthedocs.org/projects/walkscore-api/badge/?version=v.1.0.0\n :target: http://walkscore-api.readthedocs.io/en/latest/?badge=v.1.0.0\n :alt: Documentation Status (ReadTheDocs)\n\n * - `develop `_\n -\n .. image:: https://travis-ci.org/insightindustry/walkscore-api.svg?branch=develop\n :target: https://travis-ci.org/insightindustry/walkscore\n :alt: Build Status (Travis CI)\n\n .. image:: https://codecov.io/gh/insightindustry/walkscore-api/branch/develop/graph/badge.svg\n :target: https://codecov.io/gh/insightindustry/walkscore\n :alt: Code Coverage Status (Codecov)\n\n .. image:: https://readthedocs.org/projects/walkscore-api/badge/?version=develop\n :target: http://walkscore-api.readthedocs.io/en/latest/?badge=develop\n :alt: Documentation Status (ReadTheDocs)\n\nThe **WalkScore Library** is a Python library that provides Python bindings for the\n`WalkScore API `_. It enables you to retrieve\nWalkScores, TransitScores, and BikeScores from the API within your Python code\nin Python versions 3.6 and higher.\n\n.. warning::\n\n The **WalkScore Library** is completely unaffiliated with\n `WalkScore `_. It is entirely unofficial and was\n developed based on publicly available documentation of the WalkScore APIs\n published to the WalkScore website. Use of WalkScore is subject to WalkScore's\n licenses and terms of service, and this library is not endorsed by WalkScore\n or any affiliates thereof.\n\n**COMPLETE DOCUMENTATION:** http://walkscore-api.readthedocs.org/en/latest/index.html\n\n.. contents::\n :depth: 3\n :backlinks: entry\n\n-----------------\n\n***************\nInstallation\n***************\n\nTo install the **WalkScore Library**, just execute:\n\n.. code:: bash\n\n $ pip install walkscore-api\n\n\nDependencies\n==============\n\n.. list-table::\n :widths: 100\n :header-rows: 1\n\n * - Python 3.x\n * - | * `Validator-Collection v1.3 `_ or higher\n | * `Backoff-Utils v.1.0 `_ or higher\n\n-------------\n\nKey WalkScore Features\n========================\n\n* Python representation of WalkScores, TransitScores, and BikeScores.\n* Easy serialization and deserialization of API responses to Python objects,\n `dict` objects or JSON\n* Built-in back-off/retry logic if the WalkScore API is unstable at any mometn in time\n* Robust error handling to surface meaningful information to help you debug your\n code.\n\n------------------\n\n********************************\nHello, World and Basic Usage\n********************************\n\n1. Import the WalkScore API\n===============================\n\n.. code-block:: python\n\n from walkscore import WalkScoreAPI\n\n2. Initialize the API\n============================\n\nYou can either use a single object to communicate with all of the available\nWalkScore APIs, or initialize a single object for each API:\n\n.. code-block:: python\n\n api_key = 'YOUR API KEY GOES HERE'\n\n walkscore_api = WalkScoreAPI(api_key = api_key)\n\n3. Retrieve a Score\n=============================\n\n.. code-block:: python\n\n address = '123 Anyplace St Anywhere, AK 12345'\n\n result = walkscore_api.get_score(latitude = 123.45, longitude = 54.321, address = address)\n\n # the WalkScore for the location\n result.walk_score\n\n # the TransitScore for the location\n result.transit_score\n\n # the BikeScore for the location\n result.bike_score\n\n--------------\n\n*********************\nQuestions and Issues\n*********************\n\nYou can ask questions and report issues on the project's\n`Github Issues Page `_\n\n-----------------\n\n*********************\nContributing\n*********************\n\nWe welcome contributions and pull requests! For more information, please see the\n`Contributor Guide `_.\n\n-------------------\n\n*********************\nTesting\n*********************\n\nWe use `TravisCI `_ for our build automation and\n`ReadTheDocs `_ for our documentation.\n\nDetailed information about our test suite and how to run tests locally can be\nfound in our `Testing Reference `_.\n\n--------------------\n\n**********************\nLicense\n**********************\n\n**WalkScore** is made available under an\n`MIT License `_.\n\n\n", "description_content_type": "text/x-rst", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://walkscore-api.readthedocs.io/en/latest", "keywords": "walkscore binding WalkScore API real estate", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "walkscore-api", "package_url": "https://pypi.org/project/walkscore-api/", "platform": "", "project_url": "https://pypi.org/project/walkscore-api/", "project_urls": { "Bug Reports": "https://github.com/insightindustry/walkscore-api/issues", "Documentation": "https://walkscore-api.readthedocs.io/en/latest", "Homepage": "https://walkscore-api.readthedocs.io/en/latest", "Say Thanks!": "https://saythanks.io/to/walkscore-api", "Source": "https://github.com/insightindustry/walkscore-api/" }, "release_url": "https://pypi.org/project/walkscore-api/1.0.0/", "requires_dist": [ "validator-collection (>=1.3.0)", "backoff-utils (>=1.0.0)", "check-manifest ; extra == 'dev'", "sphinx ; extra == 'dev'", "sphinx-rtd-theme ; extra == 'dev'", "sphinx-tabs ; extra == 'dev'", "readme-renderer ; extra == 'dev'", "restview ; extra == 'dev'", "coverage ; extra == 'test'", "pytest ; extra == 'test'", "pytest-benchmark ; extra == 'test'", "pytest-cov ; extra == 'test'", "tox ; extra == 'test'", "codecov ; extra == 'test'" ], "requires_python": ">2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, <4", "summary": "Unofficial Python bindings for the WalkScore API", "version": "1.0.0" }, "last_serial": 5767865, "releases": { "1.0.0": [ { "comment_text": "", "digests": { "md5": "1d832c59012a52d38fd569cf5299eba4", "sha256": "bcee0710605a786c91ca0bb4db5e0cc2e4a947e93afbb4410cfa7a45e52f6bc6" }, "downloads": -1, "filename": "walkscore_api-1.0.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "1d832c59012a52d38fd569cf5299eba4", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": ">2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, <4", "size": 20503, "upload_time": "2019-09-01T19:58:03", "url": "https://files.pythonhosted.org/packages/e5/74/fb23f2cca51d192cb9eb2a8f6a3f03e68cebfa49657dcc3f44de4c4bf767/walkscore_api-1.0.0-py2.py3-none-any.whl" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "1d832c59012a52d38fd569cf5299eba4", "sha256": "bcee0710605a786c91ca0bb4db5e0cc2e4a947e93afbb4410cfa7a45e52f6bc6" }, "downloads": -1, "filename": "walkscore_api-1.0.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "1d832c59012a52d38fd569cf5299eba4", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": ">2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, <4", "size": 20503, "upload_time": "2019-09-01T19:58:03", "url": "https://files.pythonhosted.org/packages/e5/74/fb23f2cca51d192cb9eb2a8f6a3f03e68cebfa49657dcc3f44de4c4bf767/walkscore_api-1.0.0-py2.py3-none-any.whl" } ] }