Metadata-Version: 2.1
Name: bluepyentity
Version: 0.0.1
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/
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
Provides-Extra: krb
License-File: COPYING
License-File: COPYING.LESSER
License-File: AUTHORS.txt

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

NEXUS Productivity Layer, helps to:

- access NEXUS through the command line interface
- provide convenience functions to simplify common operations using NEXUS

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

From PyPi:

.. code-block:: bash

   pip install bluepyentity


Usage and 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


Acknowledgements
----------------

The development of this software was supported by funding to the Blue Brain Project, a research center of the École polytechnique fédérale de Lausanne (EPFL), from the Swiss government’s ETH Board of the Swiss Federal Institutes of Technology.

This project/research has received funding from the European Union’s Horizon 2020 Framework Programme for Research and Innovation under the Specific Grant Agreement No. 785907 (Human Brain Project SGA2).

License
-------

Blue Brain Entity is licensed under the terms of the GNU Lesser General Public License version 3,
unless noted otherwise, for example, external dependencies.
Refer to `COPYING.LESSER <https://github.com/BlueBrain/bluepyentity/blob/master/COPYING.LESSER>`__ and
`COPYING <https://github.com/BlueBrain/bluepyentity/blob/master/COPYING>`__ for details.

Copyright (c) 2019-2022 Blue Brain Project/EPFL

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License version 3
as published by the Free Software Foundation.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License
along with this program.  If not, see <https://www.gnu.org/licenses/>.
