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


Use pip::

pip install cityiq


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


The :py:class:`cityiq.api.CityIq` object is the main entry point for the API. It is constructed on a
:py:class:`cityiq.config.Config` object. For mass downloading and processing events, the :py:class`cityiq.scrape
.EventScraper` is the main object, also constructed from a ``Config``



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

$ python --version

Set the version with a tag. The version numbers are specified with PEP440_ ::

$ git tag 0.0.1


Publish the project to to PyPI_ with twine::

pip install twine
twine upload dist/*


This project has been set up using PyScaffold 3.1. For details and usage
information on PyScaffold see

.. _CityIQ:
.. _PEP440:
.. _PyPI:

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

cityiq-0.0.4.tar.gz (459.4 kB view hashes)

Uploaded Source

Built Distribution

cityiq-0.0.4-py2.py3-none-any.whl (21.8 kB view hashes)

Uploaded Python 2 Python 3

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