Skip to main content

Python3 library for working with the Philadelphia Indego Bike Share API

This project has been archived.

The maintainers of this project have marked this project as archived. No new releases are expected.

Project description

Indego Bike Share Python Library

About

I have tried to make a re-usable Python library for the Philadelphia Indego Bike Share API! I'm not very familiar with Python, but tried to learn by creating this.

I wrote this similarly to my existing Indego PHP library.

Check out the City of Philadelphia GitHub if you think this library is interesting!

Installation

Installation of this library should be as simple as running:

pip install indego

Compatibility

Please note that this library is only compatible with Python 3+. Python 2 is not supported.

Example

When combined with the provided Indego class, the following code will generate the example output:

from indego import Indego

# Instantiate the Indego class
indego = Indego()

# Retrieve and print "university" stations
uni_stations = indego.get_stations('university')
print(uni_stations)

# Show how many stations were returned above
uni_count = len(uni_stations)
print(uni_count, 'stations returned')

Output:

$ python3 university_example.py
{3008: {'addressStreet': '1076 Berks Street', 'addressCity': 'Philadelphia', 'addressState': 'PA', 'addressZipCode': '19122', 'bikesAvailable': 3, 'closeTime': '03:55:00', 'docksAvailable': 16, 'eventEnd': None, 'eventStart': None, 'isEventBased': False, 'isVirtual': False, 'isVisible': False, 'kioskId': 3008, 'kioskPublicStatus': 'Active', 'kioskStatus': 'FullService', 'name': 'Temple University Station', 'notes': None, 'openTime': '04:00:00', 'publicText': '', 'timeZone': 'Eastern Standard Time', 'totalDocks': 19, 'trikesAvailable': 0, 'kioskConnectionStatus': 'Active', 'kioskType': 1, 'latitude': 39.98078, 'longitude': -75.15055, 'hasGeofence': False, 'classicBikesAvailable': 3, 'smartBikesAvailable': 0, 'electricBikesAvailable': 0, 'isArchived': False}, 3020: {'addressStreet': '3051 South St.', 'addressCity': 'Philadelphia', 'addressState': 'PA', 'addressZipCode': '19147', 'bikesAvailable': 11, 'closeTime': '03:55:00', 'docksAvailable': 24, 'eventEnd': None, 'eventStart': None, 'isEventBased': False, 'isVirtual': False, 'isVisible': False, 'kioskId': 3020, 'kioskPublicStatus': 'Active', 'kioskStatus': 'FullService', 'name': 'University City Station', 'notes': None, 'openTime': '04:00:00', 'publicText': '', 'timeZone': 'Eastern Standard Time', 'totalDocks': 35, 'trikesAvailable': 0, 'kioskConnectionStatus': 'Active', 'kioskType': 1, 'latitude': 39.94922, 'longitude': -75.19036, 'hasGeofence': False, 'classicBikesAvailable': 11, 'smartBikesAvailable': 0, 'electricBikesAvailable': 0, 'isArchived': False}}
2 stations returned

Providing an argument/filter to get_stations() to limit the selection of stations only limits the results within the Indego class. The API end-point itself always returns all stations.

Unfortunately, there does not appear to be a signifcant amount of documentation for the API being used nor does there seem to be any parameters available to limit the stations being retrieved from the API.

Calling get_stations() without any arguments will return a list of all (currently, 132) stations.

More Information

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

indego-1.0.6.tar.gz (3.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

indego-1.0.6-py3-none-any.whl (5.1 kB view details)

Uploaded Python 3

File details

Details for the file indego-1.0.6.tar.gz.

File metadata

  • Download URL: indego-1.0.6.tar.gz
  • Upload date:
  • Size: 3.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.6.7

File hashes

Hashes for indego-1.0.6.tar.gz
Algorithm Hash digest
SHA256 df01b08b37d78ad1bcec5e29a648af6b55d77aaa459b09b18ae254a8d6ad46f1
MD5 832661421bb03d5d86a74932a753852f
BLAKE2b-256 bf0219f8e37f56a46cc3f5dfb2bbe119f9c9d7b9421ba94f87cddf1333af578d

See more details on using hashes here.

File details

Details for the file indego-1.0.6-py3-none-any.whl.

File metadata

  • Download URL: indego-1.0.6-py3-none-any.whl
  • Upload date:
  • Size: 5.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.6.7

File hashes

Hashes for indego-1.0.6-py3-none-any.whl
Algorithm Hash digest
SHA256 df6706bdddaf94bf2b76574b668e42f959f812ec083c602d6f2fcd23c19313ae
MD5 b57cb5e9f497b380c0a27eb62de29728
BLAKE2b-256 89d4a2e11f3cab8a2ba345eddc45f3bba9740fa5d816a7695e8e817e56d0d323

See more details on using hashes here.

Supported by

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