Module Index

Methods

Attributes

Class: apydia

apydia command

The apydia-command as an extension to distutils.

Run by typing 

python setup.py apydia

Availlable options are: 

--title (-t)             The name of your project
--destination (-d)       Target directory where the apidocs go
--theme (-t)             Choose an Apydia theme
--docformat              Set this to the docstring's format (eg. markdown,
                       textile, reStrucuturedText)
--format (-f)            XHTML or HTML, defaults to xhtml
--modules                Include the given modules in documentation
--exclude-modules (-x)   Don't generate documentation for the given modules
--trac-browser-url (-b)  URL to Trac's sourcecode browser
--open (-o)              Open generated files in browser when done

It is recommended to supply options through an [apydia]-section in the target project's setup.cfg. See the documentation of the apydia.command module for more information.

Methods

announce (self, msg, level=1)

If the current verbosity level is of greater than or equal to 'level' print 'msg' to stdout.

copy_file (self, infile, outfile, preserve_mode=1, preserve_times=1, link=None, level=1)

Copy a file respecting verbose, dry-run and force flags. (The former two default to whatever is in the Distribution object, and the latter defaults to false for commands that don't define it.)

copy_tree (self, infile, outfile, preserve_mode=1, preserve_times=1, preserve_symlinks=0, level=1)

Copy an entire directory tree respecting verbose, dry-run, and force flags.

debug_print (self, msg)

Print 'msg' to stdout if the global DEBUG (taken from the DISTUTILS_DEBUG environment variable) flag is true.

dump_options (self, header=None, indent='')

ensure_dirname (self, option)

ensure_filename (self, option)

Ensure that 'option' is the name of an existing file.

ensure_finalized (self)

ensure_string (self, option, default=None)

Ensure that 'option' is a string; if not defined, set it to 'default'.

ensure_string_list (self, option)

Ensure that 'option' is a list of strings. If 'option' is currently a string, we split it either on /,s*/ or /s+/, so "foo bar baz", "foo,bar,baz", and "foo, bar baz" all become ["foo", "bar", "baz"].

execute (self, func, args, msg=None, level=1)

finalize_options (self)

get_command_name (self)

get_finalized_command (self, command, create=1)

Wrapper around Distribution's 'get_command_obj()' method: find (create if necessary and 'create' is true) the command object for 'command', call its 'ensure_finalized()' method, and return the finalized command object.

get_sub_commands (self)

Determine the sub-commands that are relevant in the current distribution (ie., that need to be run). This is based on the 'sub_commands' class attribute: each tuple in that list may include a method that we call to determine if the subcommand needs to be run for the current distribution. Return a list of command names.

initialize_options (self)

make_archive (self, base_name, format, root_dir=None, base_dir=None)

make_file (self, infiles, outfile, func, args, exec_msg=None, skip_msg=None, level=1)

Special case of 'execute()' for operations that process one or more input files and generate one output file. Works just like 'execute()', except the operation is skipped and a different message printed if 'outfile' already exists and is newer than all files listed in 'infiles'. If the command defined 'self.force', and it is true, then the command is unconditionally run -- does no timestamp checks.

mkpath (self, name, mode=511)

move_file (self, src, dst, level=1)

Move a file respectin dry-run flag.

reinitialize_command (self, command, reinit_subcommands=0)

XXX rename to 'get_reinitialized_command()'? (should do the same in dist.py, if so)

run (self)

run_command (self, command)

Run some other command: uses the 'run_command()' method of Distribution, which creates and finalizes the command object if necessary and then invokes its 'run()' method.

set_undefined_options (self, src_cmd, *option_pairs)

Set the values of any "undefined" options from corresponding option values in some other command object. "Undefined" here means "is None", which is the convention used to indicate that an option has not been changed between 'initialize_options()' and 'finalize_options()'. Usually called from 'finalize_options()' for options that depend on some other command rather than another option of the same command. 'src_cmd' is the other command from which option values will be taken (a command object will be created for it if necessary); the remaining arguments are '(src_option,dst_option)' tuples which mean "take the value of 'src_option' in the 'src_cmd' command object, and copy it to 'dst_option' in the current command object".

spawn (self, cmd, search_path=1, level=1)

Spawn an external command respecting dry-run flag.

warn (self, msg)

Attributes

Value of 

None

Value of 

None

Value of 

None