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.
Source Distributions
Built Distribution
Hashes for cityiq-0.0.5-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9924c8b3268c20f6b07798d5f8bdae81465174b9a0015dcefefed544d5611195 |
|
MD5 | dd211101cb6bfefb35ce6a83e02c13f8 |
|
BLAKE2b-256 | e8cb1b1ee3ce48b3ed9c5e4c55c07b39c709e32a4db8709770b98ca376000544 |