Metadata-Version: 2.1
Name: pyxylookup
Version: 0.2.1
Summary: Python client for the OBIS xylookup API
Home-page: http://github.com/iobis/pyxylookup
Author: Samuel Bosch
Author-email: mail@samuelbosch.com
License: MIT
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering :: Bio-Informatics
Classifier: Natural Language :: English
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
License-File: LICENSE
Requires-Dist: requests (>2.7)
Requires-Dist: msgpack (>=0.5.6)
Requires-Dist: numpy (>=1.14.0)

pyxylookup
==========

|travis| |coverage|

Python client for the `OBIS xylookup API <http://github.com/iobis/xylookup>`_

`Source on GitHub at iobis/pyxylookup <https://github.com/iobis/pyxylookup>`_

`Documentation at Read the Docs <http://pyxylookup.readthedocs.io/>`_

Other OBIS xylookup clients:

* R: `obistools`, `iobis/obistools <https://github.com/iobis/obistools>`_

Installation
============

.. code-block:: shell

    pip install git+git://github.com/iobis/pyxylookup.git

Example usage
=============

.. code-block:: python

    # nested list of longitude/latitude
    import pyxylookup as xy
    xy.lookup([[120,0], [-170,1]])

    # numpy 2d array
    import numpy as np
    points = np.asarray([[120,0], [-170,1]])
    xy.lookup(points)

    ## pandas DataFrame
    import pandas as pd
    points = pd.DataFrame({'x': [120,-170], 'y': [0,1]})
    ## retrieve results as a pandas DataFrame
    xy.lookup(points, asdataframe = True)


Development environment installation
====================================

.. code-block:: shell

    pipenv --three
    pipenv install vcrpy
    pipenv install tox
    pipenv install nose
    pipenv install requests
    pipenv install u-msgpack-python
    pipenv install pandas
    pipenv install sphinx sphinx-autobuild sphinx_rtd_theme
    # enter virtual evironment
    pipenv shell
    # run tests
    pipenv run tox

Meta
====

* License: MIT, see `LICENSE file <LICENSE>`_

.. |travis| image:: https://travis-ci.org/iobis/pyxylookup.svg
   :target: https://travis-ci.org/iobis/pyxylookup

.. |coverage| image:: https://coveralls.io/repos/iobis/pyxylookup/badge.svg?branch=master&service=github
   :target: https://coveralls.io/github/iobis/pyxylookup?branch=master

Changelog
=========

0.1.0 (2018-01-12)
------------------
- First release

0.2.0 (2018-09-18)
------------------
- adaptations related to changes in xylookup
