How to Read the Logs#

datashuttle stores detailed logs when commands that create folders, change project configs or perform data transfers are run.

These logs can be accessed and read directly in the graphical interface, or located on your filesysetm and opened in your favourite text editor.

Logs are stored as ISO8601-prefixed filenames that includes the relevant datashuttle method performed.

Find and read the logs#

../../_images/how-to-logs-tui-dark.png ../../_images/how-to-logs-tui-light.png

The Logs tab on the Project Manager page displays a list of all logs for the project.

Double-click on the name of any log file to open it within the datashuttle graphical interface.

Clicking Open Most Recent will open the most recently saved logs.

The path where logs are stored can be accessed by running get_logging_path():

logs_path = project.get_logging_path()

print(logs_path)
# Path('C:/Users/Joe/data/local/my_first_project/.datashuttle/logs')

You can then navigate to this path in your system filebrowser and open the logs.

../../_images/how-to-logs-filesbrowser-dark.png ../../_images/how-to-logs-filesbrowser-light.png