Metadata-Version: 2.1
Name: blackfynn
Version: 2.4.4
Summary: Python client for the Blackfynn Platform
Home-page: http://www.blackfynn.com
Author: Blackfynn, Inc.
Author-email: mark@blackfynn.com
License: UNKNOWN
Keywords: blackfynn client rest api
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Topic :: Utilities
Requires-Python: <3
Requires-Dist: pytz (==2018.4)
Requires-Dist: boto3 (>=1.4)
Requires-Dist: requests (>=2.18)
Requires-Dist: requests-futures (>=0.9)
Requires-Dist: numpy (>=1.13)
Requires-Dist: pandas (>=0.20)
Requires-Dist: protobuf (==3.2.0)
Requires-Dist: configparser (>=3.5)
Requires-Dist: docopt (>=0.6)
Requires-Dist: psutil (>=5.4)

blackfynn-python
================

.. image:: https://travis-ci.org/Blackfynn/blackfynn-python.svg?branch=master
    :target: https://travis-ci.org/Blackfynn/blackfynn-python

Python client and command line tool for Blackfynn.

Installation
------------

To install, simply

.. code:: bash

    pip install -U blackfynn

See `install notes <INSTALL.rst>`_ for more details.

Documentation
-------------

Client and command line documentation can be found on `Blackfynn’s
documentation website`_.

.. _Blackfynn’s documentation website: http://docs.blackfynn.io/python/latest

You can also `contribute`_ to Blackfynn's documentation to improve this project and help others learn.

.. _contribute: https://github.com/Blackfynn/blackfynn-python/blob/master/docs/CONTRIBUTION_TEMPLATE.md

Tests
-------------
To run tests, make sure you install the requirements before running `pytest`_.

.. _pytest: https://docs.pytest.org/en/latest/usage.html

.. code:: bash

    pip install -r requirements-test.txt
    pytest

Contribution
-------------

Please make sure to read the `Contributing Guide`_ before making a pull request.

.. _Contributing Guide: https://github.com/Blackfynn/blackfynn-python/blob/master/docs/CONTRIBUTION_TEMPLATE.md


Changelog
-------------

Changes for each release are documented in the `release notes`_.

.. _release notes: https://github.com/Blackfynn/blackfynn-python/blob/master/CHANGELOG.md

