taika

The top-level package contain some meta info about the package to be accessible by other tools.

__author__(str)

The author name.

__email__(str)

The email of __author__.

__version__(str)

The version of the package.

class Taika(source, destination, conf_path=None)[source]

Taika main class.

Attributes:
source : pathlib.Path
destination : pathlib.Path
events : taika.events.EventManager
config : dict
documents : list
import_extensions(self)[source]

Load the configuration and extensions.

process(self)[source]

Run Taika.read() and Taika.write().

read(self, source)[source]

Read all the files recursively from a source directory and load them as dictionaries.

Parameters:
source : pathlib.Path

The source directory where the documents are read from.
Returns:
documents : list

A list of dictionaries that represent documents.
write(self, documents, destination)[source]

Call taika.taika.write_file for each document on documents with destination.

Parameters:
documents : list

A list of dictionaries that represent documents.

destination : str or pathlib.Path

The destination directory.