Transcriptic Python Client Library (TxPy) documentation

Installation

$ pip install transcriptic

or

$ git clone https://github.com/transcriptic/transcriptic.git
$ cd transcriptic
$ pip install .

to upgrade to the latest version using pip or check whether you’re already up to date:

$ pip install transcriptic --upgrade

Then, login to your Transcriptic account:

$ transcriptic login
Email: me@example.com
Password:
Logged in as me@example.com (example-lab)

Overview

In the command line interface (CLI), use transcriptic –help for a summary of arguments and their function.

Transcriptic library objects are developed with Jupyter notebooks in mind and are best utilized alongside that interface. Use transcriptic.object and transcriptic.analysis to load and analyze data respectively. API calls are located in the transcriptic.config module for more advanced connection needs.

Further Documentation

See the Transcriptic Developer Documentation for detailed information about how to use this package, including learning about how to package protocols and build releases.

Contributing

You can find our Github repository at https://github.com/transcriptic/transcriptic Please read CONTRIBUTING.md for more information.

Indices and tables