File: api.rst

package info (click to toggle)
python-pbcommand 2.1.1%2Bgit20220616.3f2e6c2-2
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 940 kB
  • sloc: python: 6,929; makefile: 220; sh: 71
file content (40 lines) | stat: -rw-r--r-- 1,124 bytes parent folder | download | duplicates (5)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
pbcommand API docs
##################

The `pbcommand` package provides Python modules for common data models, building commandline tools (e.g., ToolContract, CLI parser interface) and interacting with the SMRT Link webservices.


Library API documentation
=========================

    .. automodule:: pbcommand.pb_io
        :members:

    :doc:`pbcommand.utils`: Util functions

    :doc:`pbcommand.models`: Core models

    :doc:`pbcommand.models.file_types`: Registered File Types

    :doc:`pbcommand.models.tc` Tool Contract data model

    :doc:`pbcommand.models.rtc` Resolved Tool Contract data model

    :doc:`pbcommand.engine`: Util functions for calling an external process

    :doc:`pbcommand.cli`: Commandline interface

    :doc:`pbcommand.pb_io.tc`: IO to load Tool Contract and Resolved Tool Contracts

    :doc:`pbcommand.pb_io.pipeline`: IO to load Pipeline and Pipeline Chunk

    :doc:`pbcommand.models.task_options`: PacBio Task Options models

    :doc:`pbcommand.services`: Client API to SMRT Link WebServices

    :doc:`pbcommand.models.view_rules`: View Rules used by SMRT Link WebServices