Metadata-Version: 2.1
Name: bluepyentity
Version: 0.0.0
Summary: NEXUS Productivity Layer
Home-page: https://github.com/BlueBrain/bluepyentity/
Author: 'Blue Brain Project, EPFL'
License: BBP-internal-confidential
Project-URL: Tracker, https://github.com/BlueBrain/bluepyentity/
Project-URL: Source, https://github.com/BlueBrain/bluepyentity/
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: Science/Research
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Topic :: Scientific/Engineering :: Bio-Informatics
Requires-Python: >=3.7
Description-Content-Type: text/x-rst
Provides-Extra: docs

bluepyentity
============

NEXUS Productivity Layer


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

.. Replace this text by proper installation instructions.


Examples: Command Line Interaction
----------------------------------


Token:
------

Using the `keyring`_, a NEXUS token can be stored to reduce the number of required authentication steps:

.. code-block:: bash

    token='copy your token here'
    bluepyentity token set --token $token

One can see the contents of the token with:

.. code-block:: bash

    bluepyentity token decode

One can get the token with (note that this can be piped to other apps that need the token, or saved as an environment variable:

.. code-block:: bash

    bluepyentity token get

    # save as environment variable:

    token=`bluepyentity token get`

Info:
-----

One can look at the associated information of an identifier with:

.. code-block:: bash

    bluepyentity info SOME_ID

.. _`keyring`: https://github.com/jaraco/keyring


