From a458a362e6a07d2c2d980e5fff31156dc425bac7 Mon Sep 17 00:00:00 2001 From: veni-vidi-vici-dormivi Date: Tue, 7 Jan 2025 09:24:49 +0100 Subject: [PATCH 1/8] complete CHANGELOG and add release description --- CHANGELOG.md | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index c1c74a5..56820e1 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,9 +1,14 @@ # Changelog -## v0.4.0 - unreleased -- Added documentation files for readthedocs ([#134](https://github.com/mpytools/filefisher/pull/134)) +## v1.0.0 - 07.01.2025 +The package was renamed to filefisher (from filefinder). First release to pypi. Includes some modifications of the FileContainer class to be more user friendly. Defines and tests minimum supported versions of the dependencies and drops support for python 3.9, while testing explicitly on python 3.13. Moreover, adds documentation and some handy functionalities like concatenating two FileContainers or finding exactly one path or file. + +- Renamed from filefinder to filefisher ([#131](https://github.com/mpytools/filefisher/pull/131)) and deprecated + filefinder ([#132](https://github.com/mpytools/filefisher/pull/132)) +- Added documentation for readthedocs ([#134](https://github.com/mpytools/filefisher/pull/134)) and extended the documentation with usage ([#135](https://github.com/mpytools/filefisher/pull/135)), and installation instructions ([#136](https://github.com/mpytools/filefisher/pull/136)) +- Added method to concatenate two FileContainers ([#126](https://github.com/mpytools/filefisher/pull/126)) - Added two methods to find _exactly_ one file or path (and raise an error otherwise): `FileFinder.find_single_file` and `FileFinder.find_single_path` ([#101](https://github.com/mpytools/filefisher/pull/101)). @@ -13,9 +18,6 @@ longer be passed by position ([#99](https://github.com/mpytools/filefisher/pull/99)). - `FileFinder` now raises an error if an invalid `"{placeholder}"` is used ([#99](https://github.com/mpytools/filefisher/pull/99)). -- An empty `FileContainer` is returned instead of an empty list when no files/ paths are - found ([#114](https://github.com/mpytools/filefisher/pull/114)) - - Define and test the minimum supported versions of the dependencies ([#125](https://github.com/mpytools/filefisher/pull/125)). | Package | Old | New | @@ -25,7 +27,8 @@ | parse | undefined | 1.19 | - Changes to `FileContainer`: - + - An empty `FileContainer` is returned instead of an empty list when no files/ paths are + found ([#114](https://github.com/mpytools/filefisher/pull/114)) - Renamed the `"filename"` column to `"path"` and made it a `pd.Index`, thus removing this column from the underlying `DataFrame` ([#113](https://github.com/mpytools/filefisher/pull/113)). - Added `meta` and `paths` properties to `FileContainer` which allow to iterate over them From f78369d4ceab69304b269dc1d57bf3a06762e34d Mon Sep 17 00:00:00 2001 From: Victoria <112418493+veni-vidi-vici-dormivi@users.noreply.github.com> Date: Tue, 7 Jan 2025 09:59:39 +0100 Subject: [PATCH 2/8] Update CHANGELOG.md Co-authored-by: Mathias Hauser --- CHANGELOG.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 56820e1..97c012b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,6 +1,7 @@ # Changelog ## v1.0.0 - 07.01.2025 + The package was renamed to filefisher (from filefinder). First release to pypi. Includes some modifications of the FileContainer class to be more user friendly. Defines and tests minimum supported versions of the dependencies and drops support for python 3.9, while testing explicitly on python 3.13. Moreover, adds documentation and some handy functionalities like concatenating two FileContainers or finding exactly one path or file. - Renamed from filefinder to filefisher ([#131](https://github.com/mpytools/filefisher/pull/131)) and deprecated From 245cf4444ef8d6f7dff8d553cc4fbcb7de43d677 Mon Sep 17 00:00:00 2001 From: Victoria <112418493+veni-vidi-vici-dormivi@users.noreply.github.com> Date: Tue, 7 Jan 2025 10:00:31 +0100 Subject: [PATCH 3/8] Update CHANGELOG.md Co-authored-by: Mathias Hauser --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 97c012b..ab63e83 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,7 +2,7 @@ ## v1.0.0 - 07.01.2025 -The package was renamed to filefisher (from filefinder). First release to pypi. Includes some modifications of the FileContainer class to be more user friendly. Defines and tests minimum supported versions of the dependencies and drops support for python 3.9, while testing explicitly on python 3.13. Moreover, adds documentation and some handy functionalities like concatenating two FileContainers or finding exactly one path or file. +version 1.0.0 renames the package to filefisher (from filefinder) and makes the first release to pypi. It includes some modifications of the `FileContainer` class to be more user friendly, allows concatenating two `FileContainers` and adds methods to find exactly one path or file. Defines and tests minimum supported versions of the dependencies and adds documentation on readthedocs.``` - Renamed from filefinder to filefisher ([#131](https://github.com/mpytools/filefisher/pull/131)) and deprecated filefinder ([#132](https://github.com/mpytools/filefisher/pull/132)) From 461934630fede21b34e7f92b930696141742788e Mon Sep 17 00:00:00 2001 From: Victoria <112418493+veni-vidi-vici-dormivi@users.noreply.github.com> Date: Tue, 7 Jan 2025 10:28:16 +0100 Subject: [PATCH 4/8] Update CHANGELOG.md --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index ab63e83..7b922d2 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,7 +2,7 @@ ## v1.0.0 - 07.01.2025 -version 1.0.0 renames the package to filefisher (from filefinder) and makes the first release to pypi. It includes some modifications of the `FileContainer` class to be more user friendly, allows concatenating two `FileContainers` and adds methods to find exactly one path or file. Defines and tests minimum supported versions of the dependencies and adds documentation on readthedocs.``` +Version 1.0.0 renames the package to filefisher (from filefinder) and makes the first release to pypi. It includes some modifications of the `FileContainer` class to be more user friendly, allows concatenating two `FileContainers` and adds methods to find exactly one path or file. Defines and tests minimum supported versions of the dependencies and adds documentation on readthedocs. - Renamed from filefinder to filefisher ([#131](https://github.com/mpytools/filefisher/pull/131)) and deprecated filefinder ([#132](https://github.com/mpytools/filefisher/pull/132)) From d2a0ae95cea0e5f2562576f2451861cc5eb82a89 Mon Sep 17 00:00:00 2001 From: veni-vidi-vici-dormivi Date: Tue, 7 Jan 2025 10:42:12 +0100 Subject: [PATCH 5/8] update link in readme --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 0755ab7..9d878d5 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ predefined naming structure. ## Documentation -Learn more about filefisher in its official documentation at https://filefisher.readthedocs.io/ +Learn more about filefisher in its official documentation at [https://filefisher.readthedocs.io/](https://filefisher.readthedocs.io) ## Get in touch From 2c2ad173c479581f3c262f82e65c47718856878e Mon Sep 17 00:00:00 2001 From: veni-vidi-vici-dormivi Date: Tue, 7 Jan 2025 13:55:56 +0100 Subject: [PATCH 6/8] fix link to api reference in usage --- docs/source/usage.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/usage.rst b/docs/source/usage.rst index 276456a..12a078a 100644 --- a/docs/source/usage.rst +++ b/docs/source/usage.rst @@ -208,4 +208,4 @@ Resulting in the desired selection: /root/c/c_1h c 1h -.. _API reference: API.html \ No newline at end of file +.. _API reference: api.html \ No newline at end of file From b677c821937040f8c5d1da6ca93e71fee7de81e5 Mon Sep 17 00:00:00 2001 From: veni-vidi-vici-dormivi Date: Tue, 7 Jan 2025 13:59:59 +0100 Subject: [PATCH 7/8] nit in CHANGELOG --- CHANGELOG.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 42c3f93..02abf21 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,8 +7,8 @@ Version 1.0.0 renames the package to filefisher (from filefinder) and makes the - Renamed from filefinder to filefisher ([#131](https://github.com/mpytools/filefisher/pull/131)) and deprecated filefinder ([#132](https://github.com/mpytools/filefisher/pull/132)) - Added documentation for readthedocs ([#134](https://github.com/mpytools/filefisher/pull/134)) - and extended the documentation with usage ([#135](https://github.com/mpytools/filefisher/pull/135)), as well as extension of the api documentation ([#141](https://github.com/mpytools/filefisher/pull/141)) - installation instructions ([#136](https://github.com/mpytools/filefisher/pull/136)) + and extended the documentation with usage ([#135](https://github.com/mpytools/filefisher/pull/135)) and + installation instructions ([#136](https://github.com/mpytools/filefisher/pull/136)), as well as extension of the api documentation ([#141](https://github.com/mpytools/filefisher/pull/141)) - Added method to concatenate two FileContainers ([#126](https://github.com/mpytools/filefisher/pull/126)) - Added two methods to find _exactly_ one file or path (and raise an error otherwise): `FileFinder.find_single_file` and `FileFinder.find_single_path` From 654f766da7a6f89b1e995d87e4a9567ee8a8c279 Mon Sep 17 00:00:00 2001 From: Victoria <112418493+veni-vidi-vici-dormivi@users.noreply.github.com> Date: Tue, 7 Jan 2025 16:09:53 +0100 Subject: [PATCH 8/8] Update README.md Co-authored-by: Mathias Hauser --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 9d878d5..40ab972 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ predefined naming structure. ## Documentation -Learn more about filefisher in its official documentation at [https://filefisher.readthedocs.io/](https://filefisher.readthedocs.io) +Learn more about filefisher in its official documentation at [https://filefisher.readthedocs.io](https://filefisher.readthedocs.io) ## Get in touch