file-tree 1.2.0

Describe structure directory for pipeline

Framework to represent structured directories in python as FileTree objects. FileTrees can be read in from simple text files describing the directory structure. This is particularly useful for pipelines with large number of input, output, and intermediate files. It can also be used to visualise the data in structured directories using FSLeyes or file-tree on the command line.

• General documentation: https://open.win.ox.ac.uk/pages/ndcn0236/file-tree/
• FSLeyes documentation on using FileTrees: https://users.fmrib.ox.ac.uk/~paulmc/fsleyes/userdoc/latest/filetree.html

Running tests

Tests are run using the pytest framework. After installation (pip install pytest) they can be run from the project root as:

pytest src/tests

Release procedure

• Create a new release branch
• Make sure "CHANGELOG.md" is up to date
  • All commits can be seen in gitlab by clicking the "Unreleased" link in "CHANGELOG.md"
  • Add new header just below "## [Unreleased]" with the new version
  • Update the footnotes for both the new version and [Unreleased]
• Run bump2version patch/minor/major
• Merge branch on gitlab
• Push to pypi by running custom pipeline job in gitlab