GenerIter.app package

Submodules

GenerIter.app.algorithm module

App that is used to generate code stubs for local algorithmic development.

usage: generalg [-h] -A A -M M -L L

optional arguments:
   -h, --help  show this help message and exit
   -A A        Algorithm name
   -M M        Module name
   -L L        Library name

Thus:

generalg -L testlib -M testmod -A testalg

will ensure that a directory named testlib is created.

Within testlib, the app ensures that the __init__.py and Testmod.py files exist.

The Testmod.py will contain:

from GenerIter.process import Process

class Testmod(Process):

    def __init__(self):
        super().__init__()


    def testalg(self):
        print("Executing testalg")
        # Your code goes here

class GenerIter.app.algorithm.Algorithm

Bases: GenerIter.app.clibase.CLIBase

alg_template = '\n    def {ALG}(self):\n        print("Executing {ALG}")\n        # Your code goes here\n\n'

build_class()

build_lib()

build_method()

klass_template = 'from GenerIter.process import Process\n\nclass {KLASS}(Process):\n\n    def __init__(self):\n        super().__init__()\n\n'

parseArguments()

There is no implementation of this function for the abstract base class.

Raises

GenerIter.excepts.GINotImplementedErr –

process()

There is no implementation of this function for the abstract base class.

Raises

GenerIter.excepts.GINotImplementedErr –

GenerIter.app.categorise module

App that is used to subcategorise a sample set according to a string search parameter.

The app will iterate through all the files in the current directory looking for files containing the category search pattern substring (the -C argument).

If the category search pattern is found in a filename, the file is moved into a subdirectory, which will be created if necessary. The name of the subdirectory will either correspond to the category search string or is specified by the -D argument.

Thus:

genercat -C Drums

and

genercat -C Drums -D Drums

are functionally identical, whereas

genercat -C Drums - D Percussion

puts the same files into a different subdirectory.

class GenerIter.app.categorise.Categorise

Bases: GenerIter.app.clibase.CLIBase

parseArguments()

Parses the CLI arguments for the app.

usage: genercat [-h] -C C [-D D]

optional arguments:
-h, --help  show this help message and exit
-C C        Category search pattern
-D D        Destination category name

process()

The execution function for the app.

The basic flow:

1. A destination subdirectory is created, unless it already exists.

2. The app then examines all the files in the current directory.

3. If the specfied category search substring is found in the filename, that file is moved into the subdirectory.

GenerIter.app.clep_algorithm module

GenerIter.app.clep_algorithm.main()

The Command Line Entry Point for the packaged GenerIter.app.inventory app.

GenerIter.app.clep_categorise module

GenerIter.app.clep_categorise.main()

The Command Line Entry Point for the packaged GenerIter.app.categorise app.

GenerIter.app.clep_generator module

GenerIter.app.clep_generator.main()

The Command Line Entry Point for the packaged GenerIter.app.generator app.

GenerIter.app.clep_inventory module

GenerIter.app.clep_inventory.main()

The Command Line Entry Point for the packaged GenerIter.app.inventory app.

GenerIter.app.clibase module

Abstract base class for Command Line Interface apps in the GenerIter ecosystem

Copyright 2020 Thomas Jackson Park & Jeremy Pavier

class GenerIter.app.clibase.CLIBase

Bases: object

parseArguments()

There is no implementation of this function for the abstract base class.

Raises

GenerIter.excepts.GINotImplementedErr –

process()

There is no implementation of this function for the abstract base class.

Raises

GenerIter.excepts.GINotImplementedErr –

GenerIter.app.generator module

App to generate music.

Copyright 2020 Thomas Jackson Park & Jeremy Pavier

class GenerIter.app.generator.Generator

Bases: GenerIter.app.clibase.CLIBase

loadConfiguration()

loadSelections()

parseArguments()

There is no implementation of this function for the abstract base class.

Raises

GenerIter.excepts.GINotImplementedErr –

process()

There is no implementation of this function for the abstract base class.

Raises

GenerIter.excepts.GINotImplementedErr –

GenerIter.app.inventory module

App to catalogue and select source files into a configuration.

Copyright 2020 Thomas Jackson Park & Jeremy Pavier

class GenerIter.app.inventory.Inventory

Bases: GenerIter.app.clibase.CLIBase

parseArguments()

There is no implementation of this function for the abstract base class.

Raises

GenerIter.excepts.GINotImplementedErr –

process()

There is no implementation of this function for the abstract base class.

Raises

GenerIter.excepts.GINotImplementedErr –

Module contents