| Name | pyfileindex JSON |
| Version |
0.0.38
JSON |
| download |
| home_page | None |
| Summary | pyfileindex - pythonic file system index |
| upload_time | 2025-07-09 19:38:54 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | <3.14,>=3.9 |
| license | BSD 3-Clause License
Copyright (c) 2019, Jan Janssen
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of the copyright holder nor the names of its
contributors may be used to endorse or promote products derived from
this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| keywords |
pyiron
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# pyfileindex
PyFileIndex - pythonic file system index
[](https://github.com/pyiron/pyfileindex/actions/workflows/pipeline.yml)
[](https://codecov.io/gh/pyiron/pyfileindex)
[](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.
# 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},
}
```
Raw data
{
"_id": null,
"home_page": null,
"name": "pyfileindex",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.14,>=3.9",
"maintainer_email": null,
"keywords": "pyiron",
"author": null,
"author_email": "Jan Janssen <janssen@mpie.de>",
"download_url": "https://files.pythonhosted.org/packages/4f/8a/35ecfc0899c18deb42a7958927b0593171318f7b869a909052090c1dfd7c/pyfileindex-0.0.38.tar.gz",
"platform": null,
"description": "# pyfileindex\nPyFileIndex - pythonic file system index \n\n[](https://github.com/pyiron/pyfileindex/actions/workflows/pipeline.yml)\n[](https://codecov.io/gh/pyiron/pyfileindex)\n[](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\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\u00f6rg Neugebauer},\n keywords = {Modelling workflow, Integrated development environment, Complex simulation protocols},\n}\n```\n",
"bugtrack_url": null,
"license": "BSD 3-Clause License\n \n Copyright (c) 2019, Jan Janssen\n All rights reserved.\n \n Redistribution and use in source and binary forms, with or without\n modification, are permitted provided that the following conditions are met:\n \n * Redistributions of source code must retain the above copyright notice, this\n list of conditions and the following disclaimer.\n \n * Redistributions in binary form must reproduce the above copyright notice,\n this list of conditions and the following disclaimer in the documentation\n and/or other materials provided with the distribution.\n \n * Neither the name of the copyright holder nor the names of its\n contributors may be used to endorse or promote products derived from\n this software without specific prior written permission.\n \n THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\"\n AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE\n IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE\n DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE\n FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL\n DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR\n SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER\n CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,\n OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE\n OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.",
"summary": "pyfileindex - pythonic file system index",
"version": "0.0.38",
"project_urls": {
"Documentation": "https://github.com/pyiron/pyfileindex",
"Homepage": "https://github.com/pyiron/pyfileindex",
"Repository": "https://github.com/pyiron/pyfileindex"
},
"split_keywords": [
"pyiron"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "dc53acd72526e225bf86a994f479a4305cbefb989ebc4d0536673bd2bd696d2f",
"md5": "dbe9ee29162af7f3bf97231a88999017",
"sha256": "eafadb47155215a651fb8a89bd11b79a26ff15fd0f8891b95d134a28fb7d864e"
},
"downloads": -1,
"filename": "pyfileindex-0.0.38-py3-none-any.whl",
"has_sig": false,
"md5_digest": "dbe9ee29162af7f3bf97231a88999017",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.14,>=3.9",
"size": 7386,
"upload_time": "2025-07-09T19:38:53",
"upload_time_iso_8601": "2025-07-09T19:38:53.781372Z",
"url": "https://files.pythonhosted.org/packages/dc/53/acd72526e225bf86a994f479a4305cbefb989ebc4d0536673bd2bd696d2f/pyfileindex-0.0.38-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "4f8a35ecfc0899c18deb42a7958927b0593171318f7b869a909052090c1dfd7c",
"md5": "d7ab48b3903789ce68a47621ad662322",
"sha256": "7eb099dd99b77b261808e329fdeab8faf2aa8e132bd52ee06d054ca4b4adffe7"
},
"downloads": -1,
"filename": "pyfileindex-0.0.38.tar.gz",
"has_sig": false,
"md5_digest": "d7ab48b3903789ce68a47621ad662322",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.14,>=3.9",
"size": 6083,
"upload_time": "2025-07-09T19:38:54",
"upload_time_iso_8601": "2025-07-09T19:38:54.802002Z",
"url": "https://files.pythonhosted.org/packages/4f/8a/35ecfc0899c18deb42a7958927b0593171318f7b869a909052090c1dfd7c/pyfileindex-0.0.38.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-09 19:38:54",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "pyiron",
"github_project": "pyfileindex",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "pyfileindex"
}
