Metadata-Version: 2.0
Name: opencellid
Version: 1.0
Summary: A python wrapper for the OpenCellID DB
Home-page: https://github.com/ashmastaflash/opencellid-wrapper
Author: Ash Wilson
Author-email: ash.d.wilson@gmail.com
License: BSD
Keywords: opencellid
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 2.7
Requires-Dist: requests

----------------
OpenCellID Utils
----------------

.. image:: https://travis-ci.org/ashmastaflash/opencellid-wrapper.svg?branch=master
    :target: https://travis-ci.org/ashmastaflash/opencellid-wrapper

.. image:: https://codeclimate.com/github/ashmastaflash/opencellid-wrapper/badges/gpa.svg
   :target: https://codeclimate.com/github/ashmastaflash/opencellid-wrapper
   :alt: Code Climate

.. image:: https://codeclimate.com/github/ashmastaflash/opencellid-wrapper/badges/coverage.svg
   :target: https://codeclimate.com/github/ashmastaflash/opencellid-wrapper/coverage
   :alt: Test Coverage

.. image:: https://codeclimate.com/github/ashmastaflash/opencellid-wrapper/badges/issue_count.svg
   :target: https://codeclimate.com/github/ashmastaflash/opencellid-wrapper
   :alt: Issue Count


This project is not associated with the OpenCellID project.  This is a utility
package for downloading and parsing the OpenCellID database.


Usage (with API key from Unwired Labs):
---------------------------------------

::

        import opencellid
        ocid_obj = opencellid.OpenCellIdFeed("/dir/for/feed/file/", "api_key")
        # Update OpenCellID feed from web:
        ocid_obj.update_feed()
        # Print all rows in OpenCellID feed:
        for row in ocid_obj:
            print row


Usage (no API key, update from Mozilla Location Services):
----------------------------------------------------------

::

        import opencellid
        ocid_obj = opencellid.OpenCellIdFeed("/dir/for/feed/file/")
        # Update OpenCellID feed from web:
        ocid_obj.update_feed()
        # Print all rows in OpenCellID feed:
        for row in ocid_obj:
            print row


Installation:
-------------

pip install opencellid

Testing:
--------

py.test

The test fixture file cell_towers.csv.gz contains information from the
OpenCellID database, which is licensed CC-BY-SA 3.0

Changelog
=========

v1.0
----

Changes
~~~~~~~

- Support update from UnwiredLabs or Mozilla Location Services.  API
  changed, now use update_feed() method and source will be chosen
  depending on the presence of an API key. [Ash Wilson]

v0.1.1 (2017-01-23)
-------------------

New
~~~

- Unit and integration tests. [Ash Wilson]

- Creates an OpenCellIdFeed object which can be updated from web and
  iterated over. [Ash Wilson]




