Describe structure directory for pipeline
Project description
[![PyPI - Downloads](https://img.shields.io/pypi/dm/file-tree)](https://pypi.org/project/file-tree/) [![documentation](https://img.shields.io/badge/Documentation-file–tree-blue)](https://open.win.ox.ac.uk/pages/ndcn0236/file-tree/) [![documentation](https://img.shields.io/badge/Documentation-fsleyes-blue)](https://users.fmrib.ox.ac.uk/~paulmc/fsleyes/userdoc/latest/filetree.html) [![Pipeline status](https://git.fmrib.ox.ac.uk/ndcn0236/file-tree/badges/master/pipeline.svg)](https://git.fmrib.ox.ac.uk/ndcn0236/file-tree/-/pipelines) [![coverage report](https://git.fmrib.ox.ac.uk/ndcn0236/file-tree/badges/master/coverage.svg)](https://open.win.ox.ac.uk/pages/ndcn0236/file-tree/htmlcov)
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](https://docs.pytest.org) framework. After installation (pip install pytest) they can be run from the project root as: `shell pytest src/tests `
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for file_tree-0.5.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2c074fae8f7afd4b75ce4c59c2c33ce003b52176c6e84ac3a29f1dde79fd08ae |
|
MD5 | 4a3144a8a3e74c8e66e7d6540b3efa78 |
|
BLAKE2b-256 | d7cf4fcd18c3ca4a01e146da2b1751473defdda12fe8e8a72d593ca1a52dbd38 |