pyfileindex - pythonic file system index
Project description
pyfileindex
PyFileIndex - pythonic file system index
The pyfileindex helps to keep track of files in a specific directory, to monitor added files, modified files and deleted files. The module is compatible with Python 3.7 or later but restricted to Unix-like system - Windows is not supported.
Installation
The pyfileindex can either be installed via pip using:
pip install pyfileindex
Or via anaconda from the conda-forge channel
conda install -c conda-forge pyfileindex
Usage
Import pyfileindex:
from pyfileindex import PyFileIndex
pfi = PyFileIndex(path='.')
Or you can filter for a specifc file extension:
def filter_function(file_name):
return '.txt' in file_name
pfi = PyFileIndex(path='.', filter_function=filter_function)
List files in the file system index:
pfi.dataframe
Update file system index:
pfi.update()
And open a subdirectory using:
pfi.open(path='subdirectory')
For more details, take a look at the example notebook: https://github.com/pyiron/pyfileindex/blob/main/notebooks/demo.ipynb
License
The pyfileindex is released under the BSD license https://github.com/pyiron/pyfileindex/blob/main/LICENSE . It is a spin-off of the pyiron project https://github.com/pyiron/pyiron therefore if you use the pyfileindex for your publication, please cite:
@article{pyiron-paper,
title = {pyiron: An integrated development environment for computational materials science},
journal = {Computational Materials Science},
volume = {163},
pages = {24 - 36},
year = {2019},
issn = {0927-0256},
doi = {https://doi.org/10.1016/j.commatsci.2018.07.043},
url = {http://www.sciencedirect.com/science/article/pii/S0927025618304786},
author = {Jan Janssen and Sudarsan Surendralal and Yury Lysogorskiy and Mira Todorova and Tilmann Hickel and Ralf Drautz and Jörg Neugebauer},
keywords = {Modelling workflow, Integrated development environment, Complex simulation protocols},
}
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
File details
Details for the file pyfileindex-0.0.21.tar.gz.
File metadata
- Download URL: pyfileindex-0.0.21.tar.gz
- Upload date:
- Size: 8.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/4.0.2 CPython/3.11.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | fae0fb939c226c21b121a24aa09ee8fbbe1043ca704d3055da8d51f3403d5eb8 |
|
| MD5 | 2a44564cb0a565b86f2a3db7169c33ab |
|
| BLAKE2b-256 | 8e5b53f16b48ae0e567aef1a4c695992c722cd565e6be6bdfd68696e6d6114d6 |
File details
Details for the file pyfileindex-0.0.21-py3-none-any.whl.
File metadata
- Download URL: pyfileindex-0.0.21-py3-none-any.whl
- Upload date:
- Size: 13.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/4.0.2 CPython/3.11.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | e60c7b11477fa8dcc14c2524e535a3b48cad945317c94093f53390e7d554cc44 |
|
| MD5 | adf417d83df7a889ae44593c5f833bae |
|
| BLAKE2b-256 | 7081d11e8fa6989e05b177c09ae0323dd5c50420b50058ac59594ae8f6057a95 |
