BuildApiScript

class commandlinetools.BuildApiScript

Builds the Abjad APIs.

abjad$ ajv api --help
usage: build-api [-h] [--version] [-C] [-I] [-M] [-O] [-R] [-S] [-X]
[--api-title API_TITLE] [--docs-directory DOCS_DIRECTORY]
[--packages-to-document PACKAGES_TO_DOCUMENT]
[--format FORMAT]

Build the Abjad APIs.

optional arguments:
-h, --help            show this help message and exit
--version             show program's version number and exit
-C, --clean           run "make clean" before building the api
-I, --ide             build the Abjad IDE API
-M, --mainline        build the mainline API
-O, --open            open the docs in a web browser after building
-R, --rst-only        generate the ReSt source files but do not build
-S, --score-library   build score library API
-X, --experimental    build the experimental API
--api-title API_TITLE
title of API
--docs-directory DOCS_DIRECTORY
documentation directory
--packages-to-document PACKAGES_TO_DOCUMENT
comma-delimited packages list (ex:
"foo.tools,bar.tools")
--format FORMAT       Sphinx builder to use

Lineage

digraph InheritanceGraph { graph [background=transparent, bgcolor=transparent, color=lightslategrey, fontname=Arial, outputorder=edgesfirst, overlap=prism, penwidth=2, rankdir=LR, root="__builtin__.object", splines=spline, style="dotted, rounded", truecolor=true]; node [colorscheme=pastel19, fontname=Arial, fontsize=12, penwidth=2, style="filled, rounded"]; edge [color=lightsteelblue2, penwidth=2]; subgraph cluster_abctools { graph [label=abctools]; "abjad.tools.abctools.AbjadObject.AbjadObject" [color=1, group=0, label=AbjadObject, shape=box]; "abjad.tools.abctools.AbjadObject.AbstractBase" [color=1, group=0, label=AbstractBase, shape=box]; "abjad.tools.abctools.AbjadObject.AbstractBase" -> "abjad.tools.abctools.AbjadObject.AbjadObject"; } subgraph cluster_commandlinetools { graph [label=commandlinetools]; "abjad.tools.commandlinetools.BuildApiScript.BuildApiScript" [color=black, fontcolor=white, group=2, label=<<B>BuildApiScript</B>>, shape=box, style="filled, rounded"]; "abjad.tools.commandlinetools.CommandlineScript.CommandlineScript" [color=3, group=2, label=CommandlineScript, shape=oval, style=bold]; "abjad.tools.commandlinetools.CommandlineScript.CommandlineScript" -> "abjad.tools.commandlinetools.BuildApiScript.BuildApiScript"; } subgraph cluster_builtins { graph [label=builtins]; "builtins.object" [color=2, group=1, label=object, shape=box]; } "abjad.tools.abctools.AbjadObject.AbjadObject" -> "abjad.tools.commandlinetools.CommandlineScript.CommandlineScript"; "builtins.object" -> "abjad.tools.abctools.AbjadObject.AbstractBase"; }

Bases

Attribute summary

argument_parser The script’s instance of argparse.ArgumentParser.
formatted_help Formatted help of developer script.
formatted_usage Formatted usage of developer script.
formatted_version Formatted version of developer script.
list_commandline_script_classes() Returns a list of all developer script classes.
program_name The name of the script, callable from the command line.
__call__([arguments]) Calls developer script.
__eq__(argument) Is true when ID of argument equals ID of Abjad object.
__format__([format_specification]) Formats Abjad object.
__hash__() Hashes Abjad object.
__ne__(argument) Is true when Abjad object does not equal argument.
__repr__() Gets interpreter representation of Abjad object.

Read-only properties

(CommandlineScript).argument_parser

The script’s instance of argparse.ArgumentParser.

(CommandlineScript).formatted_help

Formatted help of developer script.

(CommandlineScript).formatted_usage

Formatted usage of developer script.

(CommandlineScript).formatted_version

Formatted version of developer script.

(CommandlineScript).program_name

The name of the script, callable from the command line.

Class & static methods

(CommandlineScript).list_commandline_script_classes()

Returns a list of all developer script classes.

Special methods

(CommandlineScript).__call__(arguments=None)

Calls developer script.

Returns none.

(AbjadObject).__eq__(argument)

Is true when ID of argument equals ID of Abjad object. Otherwise false.

Returns true or false.

(AbjadObject).__format__(format_specification='')

Formats Abjad object.

Set format_specification to ‘’ or ‘storage’. Interprets ‘’ equal to ‘storage’.

Returns string.

(AbjadObject).__hash__()

Hashes Abjad object.

Required to be explicitly redefined on Python 3 if __eq__ changes.

Returns integer.

(AbjadObject).__ne__(argument)

Is true when Abjad object does not equal argument. Otherwise false.

Returns true or false.

(AbjadObject).__repr__()

Gets interpreter representation of Abjad object.

Returns string.