Skip to content
Snippets Groups Projects
Commit c51600ef authored by Alexandar Mechev's avatar Alexandar Mechev
Browse files

Updating Token doc

parent adb584ca
No related branches found
No related tags found
No related merge requests found
......@@ -4,22 +4,27 @@ Tokens
The GRID_LRT.Token module is responsible for interactions with CouchDB using the PiCaS token framework. It contains a **Token_Handler** object which manages a single _design document on CouchDB, intended for a set of jobs that are logically linked together. In the LOFAR Surveys case, this holds the jobs of a single Observation. Additionally a **Token_Set** object can create batch tokens, upload attachments to them in bulk and change Token fields in bulk as well. This module is used in combination with the :ref:`srmlist <srmlist-doc>` class to automatically create sets of jobs with N files each.
Token.py
token.py
--------
Location: GRID_LRT/token.py
Imports:
>>> from GRID_LRT.token import TokenHandler
>>> from GRID_LRT.token import Token, TokenBuilder #Abstract classes
>>> from GRID_LRT.token import caToken, TokenJsonBUilder, TokenList, TokenView
>>> from GRID_LRT.token import TokenSet
TokenHandler
Tokens
~~~~~~~~~~~~~~~~~~~~~~
.. autoclass:: GRID_LRT.token.TokenHandler
.. autoclass:: GRID_LRT.token.Token
:members:
:undoc-members:
.. autoclass:: GRID_LRT.token.caToken
:members:
:undoc-members
TokenSet
~~~~~~~~~~~~~~~~~~~~~~
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment