https://github.com/pyiron/pyfileindex

PyFileIndex - pythonic file system index
https://github.com/pyiron/pyfileindex

filesystem monitoring python

Last synced: 5 days ago
JSON representation

PyFileIndex - pythonic file system index

• Host: GitHub
• URL: https://github.com/pyiron/pyfileindex
• Owner: pyiron
• License: bsd-3-clause
• Created: 2019-07-15T11:48:06.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2024-04-11T15:55:25.000Z (7 months ago)
• Last Synced: 2024-04-11T17:18:45.185Z (7 months ago)
• Topics: filesystem, monitoring, python
• Language: Python
• Homepage:
• Size: 2.61 MB
• Stars: 4
• Watchers: 6
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# pyfileindex

PyFileIndex - pythonic file system index 

[![Python package](https://github.com/pyiron/pyfileindex/workflows/Python%20package/badge.svg)](https://github.com/pyiron/pyfileindex/actions)

[![Coverage Status](https://coveralls.io/repos/github/pyiron/pyfileindex/badge.svg?branch=main)](https://coveralls.io/github/pyiron/pyfileindex?branch=main)

[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/pyiron/pyfileindex/main?filepath=notebooks%2Fdemo.ipynb)

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. 

![Preview](pyfileindex.gif)

# Installation

The pyfileindex can either be installed via pip using:

```shell

pip install pyfileindex

```

Or via anaconda from the conda-forge channel

```shell

conda install -c conda-forge pyfileindex

```

# Usage 

Import pyfileindex:

```python

from pyfileindex import PyFileIndex 

pfi = PyFileIndex(path='.')

```  

Or you can filter for a specifc file extension: 

```python

def filter_function(file_name):

    return '.txt' in file_name

    

pfi = PyFileIndex(path='.', filter_function=filter_function)

```

List files in the file system index: 

```python

pfi.dataframe 

```

Update file system index: 

```python

pfi.update()

```

And open a subdirectory using: 

```python

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},

}

```