{"id":13738366,"url":"https://github.com/pyiron/pyfileindex","last_synced_at":"2026-02-19T07:27:39.250Z","repository":{"id":35135841,"uuid":"196988371","full_name":"pyiron/pyfileindex","owner":"pyiron","description":"PyFileIndex - pythonic file system index ","archived":false,"fork":false,"pushed_at":"2025-04-28T19:02:08.000Z","size":2861,"stargazers_count":7,"open_issues_count":1,"forks_count":1,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-04-28T20:22:26.455Z","etag":null,"topics":["filesystem","monitoring","python"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/pyiron.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2019-07-15T11:48:06.000Z","updated_at":"2025-04-28T19:02:12.000Z","dependencies_parsed_at":"2023-07-12T22:01:18.138Z","dependency_job_id":"a29c5a19-3705-496a-91a3-485832cb9454","html_url":"https://github.com/pyiron/pyfileindex","commit_stats":{"total_commits":161,"total_committers":10,"mean_commits":16.1,"dds":0.4161490683229814,"last_synced_commit":"8eca3f2d823e15a3d561a61b1638250e86beacbc"},"previous_names":["pyfileindex/pyfileindex"],"tags_count":35,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pyiron%2Fpyfileindex","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pyiron%2Fpyfileindex/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pyiron%2Fpyfileindex/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pyiron%2Fpyfileindex/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pyiron","download_url":"https://codeload.github.com/pyiron/pyfileindex/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253105496,"owners_count":21855042,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["filesystem","monitoring","python"],"created_at":"2024-08-03T03:02:20.284Z","updated_at":"2025-10-21T20:55:30.070Z","avatar_url":"https://github.com/pyiron.png","language":"Python","funding_links":[],"categories":["Python"],"sub_categories":[],"readme":"# pyfileindex\nPyFileIndex - pythonic file system index \n\n[![Pipeline](https://github.com/pyiron/pyfileindex/actions/workflows/pipeline.yml/badge.svg)](https://github.com/pyiron/pyfileindex/actions/workflows/pipeline.yml)\n[![codecov](https://codecov.io/gh/pyiron/pyfileindex/graph/badge.svg?token=J9EWZBBKPH)](https://codecov.io/gh/pyiron/pyfileindex)\n[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/pyiron/pyfileindex/main?filepath=notebooks%2Fdemo.ipynb)\n\nThe 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. \n\n![Preview](https://raw.githubusercontent.com/pyiron/pyfileindex/main/pyfileindex.gif)\n\n# Installation\nThe pyfileindex can either be installed via pip using:\n```shell\npip install pyfileindex\n```\nOr via anaconda from the conda-forge channel\n```shell\nconda install -c conda-forge pyfileindex\n```\n\n# Usage \nImport pyfileindex:\n```python\nfrom pyfileindex import PyFileIndex \npfi = PyFileIndex(path='.')\n```  \nOr you can filter for a specifc file extension: \n```python\ndef filter_function(file_name):\n    return '.txt' in file_name\n    \npfi = PyFileIndex(path='.', filter_function=filter_function)\n```\nList files in the file system index: \n```python\npfi.dataframe \n```\nUpdate file system index: \n```python\npfi.update()\n```\nAnd open a subdirectory using: \n```python\npfi.open(path='subdirectory')\n```\nFor more details, take a look at the example notebook: https://github.com/pyiron/pyfileindex/blob/main/notebooks/demo.ipynb\n\n\n# License\nThe 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: \n```\n@article{pyiron-paper,\n  title = {pyiron: An integrated development environment for computational materials science},\n  journal = {Computational Materials Science},\n  volume = {163},\n  pages = {24 - 36},\n  year = {2019},\n  issn = {0927-0256},\n  doi = {https://doi.org/10.1016/j.commatsci.2018.07.043},\n  url = {http://www.sciencedirect.com/science/article/pii/S0927025618304786},\n  author = {Jan Janssen and Sudarsan Surendralal and Yury Lysogorskiy and Mira Todorova and Tilmann Hickel and Ralf Drautz and Jörg Neugebauer},\n  keywords = {Modelling workflow, Integrated development environment, Complex simulation protocols},\n}\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpyiron%2Fpyfileindex","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpyiron%2Fpyfileindex","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpyiron%2Fpyfileindex/lists"}