Metadata-Version: 2.1
Name: blackfynn
Version: 3.6.3
Summary: Python client for the Blackfynn Platform
Home-page: https://github.com/Blackfynn/blackfynn-python
Author: Blackfynn, Inc.
Author-email: mark@blackfynn.com
License: UNKNOWN
Project-URL: Blackfynn, https://www.blackfynn.com
Project-URL: Documentation, https://developer.blackfynn.io/python
Project-URL: Bug Reports, https://github.com/Blackfynn/blackfynn-python/issues
Keywords: blackfynn client rest api
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Topic :: Utilities
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Requires-Python: >=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, <4.0
Requires-Dist: pytz (>=2016)
Requires-Dist: boto3 (>=1.4)
Requires-Dist: requests (>=2.18)
Requires-Dist: protobuf (>=3.2.0)
Requires-Dist: configparser (>=3.5)
Requires-Dist: future (>=0.15.0)
Requires-Dist: deprecated (>=1.2.0)
Requires-Dist: semver (>=2.8.0)
Requires-Dist: websocket-client (>=0.50.0)
Requires-Dist: docopt (>=0.6)
Requires-Dist: psutil (>=5.4)
Requires-Dist: python-dateutil (>=2.8.0)
Provides-Extra: data
Requires-Dist: numpy (>=1.13) ; extra == 'data'
Requires-Dist: pandas (>=0.20) ; extra == 'data'

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

.. image:: https://travis-ci.org/Blackfynn/blackfynn-python.svg?branch=master
    :target: https://travis-ci.org/Blackfynn/blackfynn-python
.. image:: https://codecov.io/gh/Blackfynn/blackfynn-python/branch/master/graph/badge.svg
    :target: https://codecov.io/gh/Blackfynn/blackfynn-python
.. image:: https://img.shields.io/pypi/pyversions/blackfynn.svg
    :target: https://pypi.org/project/blackfynn/

Python client and command line tool for Blackfynn.

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

To install, run

.. code:: bash

    pip install -U blackfynn

See the `installation notes`_ for more details.

.. _installation notes: https://github.com/Blackfynn/blackfynn-python/blob/master/INSTALL.rst

Release
-------

To release, you should:

- Change CHANGELOG.md with the proper changes for the release
- Modify the version in __init.py__
- Merge the branch into master
- Create a new Github Release

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

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

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

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
-------------
Install the test requirements before running `pytest`_:

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

.. code:: bash

    make install
    pytest

To run the Blackfynn CLI Agent integration tests, you need to `install the agent`_
and run the tests with the `--agent` argument:

.. _install the agent: https://developer.blackfynn.io/agent/index.html

.. code:: bash

    pytest --agent


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


