Skip to main content

pyfileindex - pythonic file system index

Project description


PyFileIndex - pythonic file system index

Python package Coverage Status Binder

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.



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


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:


Update file system index:


And open a subdirectory using:'subdirectory')

For more details, take a look at the example notebook:


The pyfileindex is released under the BSD license . It is a spin-off of the pyiron project therefore if you use the pyfileindex for your publication, please cite:

  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 = {},
  url = {},
  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},

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyfileindex-0.0.25.tar.gz (8.2 kB view hashes)

Uploaded Source

Built Distribution

pyfileindex-0.0.25-py3-none-any.whl (13.8 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page