rail.projects.library module

Functions to manage various objects associated to RailProjects

rail.projects.library.clear()[source]

Clean all the factories

Return type:

None

rail.projects.library.load_yaml(yaml_file)[source]

Read a yaml file and load the factory accordingly

Return type:

None

Parameters:

yaml_file (str) – File to read

Notes

See class description for yaml file syntax

rail.projects.library.print_contents()[source]

Print the contents of the factories

Return type:

None

rail.projects.library.setup_mininal_example_files()[source]
Return type:

int

rail.projects.library.setup_project_area()[source]

Download test files to setup a project testsing area

Return type:

int

Returns:

0 for success, error code otherwise

Return type:

int

Notes

This will download files into ‘tests/temp_data’, and could take a few minutes.

This will not download the files if they are already present

rail.projects.library.teardown_project_area()[source]
Return type:

None

rail.projects.library.write_yaml(yaml_file)[source]

Write the current contents for the factories to a yaml file

Return type:

None

Parameters:

yaml_file (str) – File to write

Notes

See class description for yaml file syntax