paths

root_dir

Tessif's root directory.

doc_dir

Tessif's documentation directory

log_dir

Tessif's log directory.

example_dir

Tessif's example directory

write_dir

Tessif's write (output) directory

tests_dir

Tessif's tests directory

paths is a tessif subpackage aggregating frequently used path implementations for conveniently accessing utilities and data coming with tessif.

tessif.frused.paths.find_subpath_incwd(path, includes=['tessif'], excludes=['.git'])[source]

Function to find location of path. Credit to: https://stackoverflow.com/a/41546830

Note

To make this utility work os independently it is advised to supply path using os.path.join().

Parameters:
  • path (str) – String representation of the directory/file to find the path for. Supplying this paremter us ing os.path.join() makes this utility platform independent

  • includes (Iterable, str) – String or iterable of strings that should be part of the found path.

  • exludes (Iterable, str) – String or iterable of strings that should not be part of the found path.

Returns:

found_paths – List of found paths

Return type:

list

tessif.frused.paths.root_dir = '/home/docs/checkouts/readthedocs.org/user_builds/tessif-phd/envs/latest/lib/python3.8/site-packages/tessif'

Tessif’s root directory.

tessif.frused.paths.doc_dir = '/home/docs/checkouts/readthedocs.org/user_builds/tessif-phd/envs/latest/lib/python3.8/docs'

Tessif’s documentation directory

tessif.frused.paths.log_dir = '/home/docs/checkouts/readthedocs.org/user_builds/tessif-phd/envs/latest/lib/python3.8/site-packages/tessif/write/logs'

Tessif’s log directory.

tessif.frused.paths.example_dir = '/home/docs/checkouts/readthedocs.org/user_builds/tessif-phd/envs/latest/lib/python3.8/site-packages/tessif/examples'

Tessif’s example directory

tessif.frused.paths.write_dir = '/home/docs/checkouts/readthedocs.org/user_builds/tessif-phd/envs/latest/lib/python3.8/site-packages/tessif/write'

Tessif’s write (output) directory

tessif.frused.paths.tests_dir = '/home/docs/checkouts/readthedocs.org/user_builds/tessif-phd/envs/latest/lib/python3.8/tests'

Tessif’s tests directory