This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (pypi.python.org).
Help us improve Python packaging - Donate today!

Veliberator provides a Python API for getting informations about the stations of the Velib' network.

Project Description

Veliberator is a Python module who provides an API for getting the informations related to the stations of the Velib’ bike renting network.

API Usage

To retrieve the informations of a station you only have to have the ID of the station and a database synchronized with all the available stations.

Then in your Python interpreter you can play with the API:

>>> from veliberator.stations import Station
>>> station = Station(42008)
>>> station.informations.address
u'128 AVENUE DANIEL CASANOVA'

The informations attributes contains many data such as:

  • address
  • postal_code
  • city
  • lat (the latitude of the GPS coordonates)
  • lng (the longitude of the GPS coordonates)
  • opened (True if the station is open)
  • bonus (True if the station is a bonus station)

You could retrieve the live status of the station easily:

>>> station.status.available
24
>>> station.status.free
1
>>> station.status.total
25
>>> station.status.closed
0

More useful, you can retrieve the closest stations sorted by distance:

>>> station.stations_around
[<StationInformation "42006" (23 RUE PIERRE BROSSOLETTE)>, <StationInformation "42010" (1 RUE ROBESPIERRE)>, ...]

The veliberator script

Write an API for developers is a nice idea, but write an useful script who uses the API for the end-user is a much nicer idea.

So the package provide a script named veliberator.

For exemple if I need to know the status of the Velib’ station with the ID: 42008, I simply need to run this command:

$ veliberator 42008

This command will display the status of the station and find other stations around if no parking place are available.

The veliberator script can also find the Velib’ stations around an address, by simply launching the script.

Note that at the first run of the script a database will be created for registering all the available stations.

For update or create the database you can run this command:

$ veliberator --synchronize

Run this command for more informations:

$ veliberator -h

Settings

The veliberator module can be configured by a configuration file. Take a look on the file etc/veliberator-sample.cfg for having a example of the options availables.

The module is going to look in your home directory if a file named .veliberator.cfg is present and in etc/veliberator.cfg from your current working directory.

Release History

Release History

This version
History Node

0.3.3

History Node

0.3.1

History Node

0.3

History Node

0.2.9.2

History Node

0.2.9.1

History Node

0.2.9

History Node

0.2.8.1

History Node

0.2.8

History Node

0.2.7

History Node

0.2.6

History Node

0.2.5

History Node

0.2.4.1

History Node

0.2.4

History Node

0.2.3

History Node

0.2.2

History Node

0.2.1

History Node

0.1.9

History Node

0.1.2

History Node

0.1.1

History Node

0.1

Download Files

Download Files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
veliberator-0.3.3.tar.gz (87.7 kB) Copy SHA256 Checksum SHA256 Source Mar 16, 2015

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting