Skip to main content

Python access to the CityIQ api.

Project description

This module and command line tool provides access to the CityIQ API, with particular focus on getting metadata and parking events. The interface includes a basic access object for getting metadata and events, a scraper object for mass downloading events, and a command line tool for downloading and processing events.

Installation

Use pip:

pip install cityiq

Configuration

The program requires a configuration file that hold credentials and urls. You can generate a default configuration with

ciq_config  -w

The generated file is configured for the San Diego system. To you this system , you will just need to add your client id and secret.

The code will look for this file in several places in this order:

  • The path specified by the CITYIQ_CONFIG env var
  • .city-iq.yaml in the current dir
  • city-iq.yaml in the current dir
  • .city-iq.yaml in the user’s home dir

Use

After generating a config file you can run the ciq_events program to get event records. See the documentation for Scraping for more information.

The Documentation has more details, but not much more.

Devlopment

Committing

The project scaffold gets the version number for the module from git. To get the version number:

$ python setup.py --version

Set the version with a tag. The version numbers are specified with PEP440

$ git tag 0.0.1

Publishing

Publish the project to to PyPI with twine:

pip install twine
twine upload dist/*

Scaffolding

This project has been set up using PyScaffold 3.1. For details and usage information on PyScaffold see https://pyscaffold.org/.

Project details


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
cityiq-0.0.5-py2.py3-none-any.whl (22.1 kB) Copy SHA256 hash SHA256 Wheel py2.py3

Supported by

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