prefect-managedfiletransfer 0.1.0__tar.gz

prefect_managedfiletransfer-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2021 Prefect Technologies, Inc.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

prefect_managedfiletransfer-0.1.0/PKG-INFO

@@ -0,0 +1,193 @@
+Metadata-Version: 2.4
+Name: prefect-managedfiletransfer
+Version: 0.1.0
+Summary: Upload and download files easily between Local/SFTP/Cloud storage using rclone
+Author-email: Alastair Crabtree <a.crabtree@imperial.ac.uk>
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/ImperialCollegeLondon/prefect-managedfiletransfer
+Keywords: prefect,file,copy,move,transfer,SFTP,rclone
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: System Administrators
+Classifier: Natural Language :: English
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Libraries
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: prefect>=3.1.7
+Requires-Dist: pydantic>=2.11.0a2
+Requires-Dist: paramiko>=4.0.0
+Dynamic: license-file
+
+# Prefect Managed File Transfer
+
+<p align="center">
+    <!--- Insert a cover image here -->
+    <!--- <br> -->
+    <a href="https://pypi.python.org/pypi/prefect-managedfiletransfer/" alt="PyPI version">
+        <img alt="PyPI" src="https://img.shields.io/pypi/v/prefect-managedfiletransfer?color=0052FF&labelColor=090422"></a>
+    <a href="https://github.com/ImperialCollegeLondon/prefect-managedfiletransfer/" alt="Stars">
+        <img src="https://img.shields.io/github/stars/ImperialCollegeLondon/prefect-managedfiletransfer?color=0052FF&labelColor=090422" /></a>
+    <a href="https://pypistats.org/packages/prefect-managedfiletransfer/" alt="Downloads">
+        <img src="https://img.shields.io/pypi/dm/prefect-managedfiletransfer?color=0052FF&labelColor=090422" /></a>
+    <a href="https://github.com/ImperialCollegeLondon/prefect-managedfiletransfer/pulse" alt="Activity">
+        <img src="https://img.shields.io/github/commit-activity/m/ImperialCollegeLondon/prefect-managedfiletransfer?color=0052FF&labelColor=090422" /></a>
+    <br>
+</p>
+
+Turn a prefect.io server into a managed file transfer solution. UI and Programatic creation of cron style jobs (aka Flows!) to upload and download files easily between servers. Support local, SFTP remotes plus any Cloud storage supported by rclone -  so thats aws, azure, google, sharepoint, and [many more](https://rclone.org/overview/) out of the box.
+
+Using prefect for managed file transfer means retries, logging, multi node and [high availability](https://docs.prefect.io/v3/advanced/self-hosted) come as standard - turning prefect into a reliable enterprise ready file transfer solution. 
+
+This package is not the fastest solution to move files around, but it prioritises reliability and ease of use, making it an excellent choice for replacing both quick cron job copy scripts and enterprise managed file transfer applicances.
+
+Key features
+
+- Copy and move files between almost any storage system easily.
+- Reliable file moving with checksumming, file size checking etc.
+- Smart and safe moving - settings to allow/block overwriting and to only copy files if they are new or changed.
+- Unzip/Untar compressed folders after downloading them.
+- Repath files as you move them.
+- Complex filtering and ordering of files - by path, age, size etc. Pattern matching with regular expressions.
+- Leverage Prefect.IO built in scheduling and orchestration capabilities:
+    - Transfer files on complex cron schedules
+    - notifications on success/failure - slack, email, etc
+    - Highly available server architecture - database server + multi-node workers and front ends.
+
+Example use cases:
+
+- Once per day SSH into my database server and copy the latest *.bkup file to a central storage location.
+- Monitor a local network share directory for new files and automatically upload them to a cloud storage bucket.
+- Schedule a weekly job to synchronize files between two remote servers.
+- Move log files from a SSH available web server older than 30 days to a cold storage location.
+- Copy file yyyy-MM-dd.zip from a remote server, where yyyy-MM-dd matches todays date, to a local directory and then unzip it.
+- Download any file in an S3 bucket larger than 1GB and store it in a local directory.
+
+### Installation
+
+Install `prefect-managedfiletransfer` with `pip`. (Requires an installation of Python 3.10+.)
+
+```bash
+pip install prefect-managedfiletransfer
+# or 
+uv add prefect-managedfiletransfer
+```
+
+We recommend using a Python virtual environment manager such as uv, pipenv, conda or virtualenv.
+
+In one (venv) terminal start a prefect server with logs enabled
+
+```bash
+export PREFECT_LOGGING_LEVEL="INFO"
+export PREFECT_LOGGING_EXTRA_LOGGERS="prefect_managedfiletransfer"
+prefect server start
+# OR uv run prefect server start
+```
+
+There are many ways to manage infrastructure and code with prefect - here we demonstate starting a local worker:
+
+```bash
+export PREFECT_API_URL=http://127.0.0.1:4200/api
+# or perhaps export PREFECT_API_URL=http://host.docker.internal:4200/api
+export PREFECT_LOGGING_EXTRA_LOGGERS="prefect_managedfiletransfer"
+export PREFECT_LOGGING_LEVEL="INFO"
+# [Optional] add all logs: export PREFECT_LOGGING_ROOT_LEVEL="INFO"
+
+
+prefect worker start --pool 'default-pool' --type process
+# OR prefect worker start --pool 'default-pool' --type docker
+
+```
+    
+Install the blocks using the prefect CLI
+
+```bash
+prefect block register -m prefect_managedfiletransfer
+```
+
+And then deploy the flows. 
+
+```bash
+# deploy the flows to run locally
+python -m prefect_managedfiletransfer.deploy --local
+
+# OR deploy to run with a docker image - see deploy.py
+python -m prefect_managedfiletransfer.deploy --docker
+
+# or a version of the above using uv run:
+uv run python -m prefect_managedfiletransfer.deploy --local
+uv run python -m prefect_managedfiletransfer.deploy --docker
+```
+
+Visit the server UI http://localhost:4200.
+1. Create 2 blocks, one source and one destination
+2. On the deployments page start a `transfer_files_flow`. Configure your flow run to copy/move files between the 2 blocks.
+
+### Installation via docker
+
+```bash
+# run prefect server in a container port-forwarded to your local machine’s 4200 port:
+docker run -d -p 4200:4200 prefecthq/prefect:3-latest -- prefect server start --host 0.0.0.0
+```
+
+### List of components
+
+Blocks
+- ServerWithBasicAuthBlock - A block for connecting to a server using basic authentication.
+- ServerWithPublicKeyAuthBlock - A block for connecting to a server using public key authentication.
+- RCloneConfigFileBlock - A block for managing RClone configuration files.
+
+Tasks
+- list_remote_files_task - A task for listing files in a remote directory.
+- download_file_task - A task for downloading a single file from a remote server.
+- upload_file_task - A task for uploading a single file to a remote server.
+- [TODO] delete_file_task
+
+Flows
+- transfer_files_flow - a fully featured flow for transferring files between different storage locations.
+- upload_file_flow - a flow for uploading a file to a remote server. Supports pattern matching by date
+
+### Feedback
+
+If you encounter any bugs while using `prefect-managedfiletransfer`, feel free to open an issue in the [prefect-managedfiletransfer](https://github.com/ImperialCollegeLondon/prefect-managedfiletransfer) repository.
+
+
+Feel free to star or watch [`prefect-managedfiletransfer`](https://github.com/ImperialCollegeLondon/prefect-managedfiletransfer) for updates too!
+
+### Contributing
+
+If you'd like to help contribute to fix an issue or add a feature to `prefect-managedfiletransfer`, please [propose changes through a pull request from a fork of the repository](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork).
+
+Here are the steps:
+
+1. [Fork the repository](https://docs.github.com/en/get-started/quickstart/fork-a-repo#forking-a-repository)
+2. [Clone the forked repository](https://docs.github.com/en/get-started/quickstart/fork-a-repo#cloning-your-forked-repository)
+3. Install the repository and its dependencies:
+```
+# install uv first, then
+uv sync
+```
+
+You can also access all the prefect CLI tooling inside a uv managed venv
+```
+uv venv
+source .venv/bin/activate
+prefect server start
+```
+
+4. Make desired changes
+5. Add tests
+6. Insert an entry to [CHANGELOG.md](https://github.com/ImperialCollegeLondon/prefect-managedfiletransfer/blob/main/CHANGELOG.md)
+7. Install `pre-commit` to perform quality checks prior to commit:
+```
+pre-commit install
+```
+8. use the build script to run all the checks and tests:
+
+```
+./build.sh
+```
+8. `git commit`, `git push`, and create a pull request

prefect_managedfiletransfer-0.1.0/README.md

@@ -0,0 +1,169 @@
+# Prefect Managed File Transfer
+
+<p align="center">
+    <!--- Insert a cover image here -->
+    <!--- <br> -->
+    <a href="https://pypi.python.org/pypi/prefect-managedfiletransfer/" alt="PyPI version">
+        <img alt="PyPI" src="https://img.shields.io/pypi/v/prefect-managedfiletransfer?color=0052FF&labelColor=090422"></a>
+    <a href="https://github.com/ImperialCollegeLondon/prefect-managedfiletransfer/" alt="Stars">
+        <img src="https://img.shields.io/github/stars/ImperialCollegeLondon/prefect-managedfiletransfer?color=0052FF&labelColor=090422" /></a>
+    <a href="https://pypistats.org/packages/prefect-managedfiletransfer/" alt="Downloads">
+        <img src="https://img.shields.io/pypi/dm/prefect-managedfiletransfer?color=0052FF&labelColor=090422" /></a>
+    <a href="https://github.com/ImperialCollegeLondon/prefect-managedfiletransfer/pulse" alt="Activity">
+        <img src="https://img.shields.io/github/commit-activity/m/ImperialCollegeLondon/prefect-managedfiletransfer?color=0052FF&labelColor=090422" /></a>
+    <br>
+</p>
+
+Turn a prefect.io server into a managed file transfer solution. UI and Programatic creation of cron style jobs (aka Flows!) to upload and download files easily between servers. Support local, SFTP remotes plus any Cloud storage supported by rclone -  so thats aws, azure, google, sharepoint, and [many more](https://rclone.org/overview/) out of the box.
+
+Using prefect for managed file transfer means retries, logging, multi node and [high availability](https://docs.prefect.io/v3/advanced/self-hosted) come as standard - turning prefect into a reliable enterprise ready file transfer solution. 
+
+This package is not the fastest solution to move files around, but it prioritises reliability and ease of use, making it an excellent choice for replacing both quick cron job copy scripts and enterprise managed file transfer applicances.
+
+Key features
+
+- Copy and move files between almost any storage system easily.
+- Reliable file moving with checksumming, file size checking etc.
+- Smart and safe moving - settings to allow/block overwriting and to only copy files if they are new or changed.
+- Unzip/Untar compressed folders after downloading them.
+- Repath files as you move them.
+- Complex filtering and ordering of files - by path, age, size etc. Pattern matching with regular expressions.
+- Leverage Prefect.IO built in scheduling and orchestration capabilities:
+    - Transfer files on complex cron schedules
+    - notifications on success/failure - slack, email, etc
+    - Highly available server architecture - database server + multi-node workers and front ends.
+
+Example use cases:
+
+- Once per day SSH into my database server and copy the latest *.bkup file to a central storage location.
+- Monitor a local network share directory for new files and automatically upload them to a cloud storage bucket.
+- Schedule a weekly job to synchronize files between two remote servers.
+- Move log files from a SSH available web server older than 30 days to a cold storage location.
+- Copy file yyyy-MM-dd.zip from a remote server, where yyyy-MM-dd matches todays date, to a local directory and then unzip it.
+- Download any file in an S3 bucket larger than 1GB and store it in a local directory.
+
+### Installation
+
+Install `prefect-managedfiletransfer` with `pip`. (Requires an installation of Python 3.10+.)
+
+```bash
+pip install prefect-managedfiletransfer
+# or 
+uv add prefect-managedfiletransfer
+```
+
+We recommend using a Python virtual environment manager such as uv, pipenv, conda or virtualenv.
+
+In one (venv) terminal start a prefect server with logs enabled
+
+```bash
+export PREFECT_LOGGING_LEVEL="INFO"
+export PREFECT_LOGGING_EXTRA_LOGGERS="prefect_managedfiletransfer"
+prefect server start
+# OR uv run prefect server start
+```
+
+There are many ways to manage infrastructure and code with prefect - here we demonstate starting a local worker:
+
+```bash
+export PREFECT_API_URL=http://127.0.0.1:4200/api
+# or perhaps export PREFECT_API_URL=http://host.docker.internal:4200/api
+export PREFECT_LOGGING_EXTRA_LOGGERS="prefect_managedfiletransfer"
+export PREFECT_LOGGING_LEVEL="INFO"
+# [Optional] add all logs: export PREFECT_LOGGING_ROOT_LEVEL="INFO"
+
+
+prefect worker start --pool 'default-pool' --type process
+# OR prefect worker start --pool 'default-pool' --type docker
+
+```
+    
+Install the blocks using the prefect CLI
+
+```bash
+prefect block register -m prefect_managedfiletransfer
+```
+
+And then deploy the flows. 
+
+```bash
+# deploy the flows to run locally
+python -m prefect_managedfiletransfer.deploy --local
+
+# OR deploy to run with a docker image - see deploy.py
+python -m prefect_managedfiletransfer.deploy --docker
+
+# or a version of the above using uv run:
+uv run python -m prefect_managedfiletransfer.deploy --local
+uv run python -m prefect_managedfiletransfer.deploy --docker
+```
+
+Visit the server UI http://localhost:4200.
+1. Create 2 blocks, one source and one destination
+2. On the deployments page start a `transfer_files_flow`. Configure your flow run to copy/move files between the 2 blocks.
+
+### Installation via docker
+
+```bash
+# run prefect server in a container port-forwarded to your local machine’s 4200 port:
+docker run -d -p 4200:4200 prefecthq/prefect:3-latest -- prefect server start --host 0.0.0.0
+```
+
+### List of components
+
+Blocks
+- ServerWithBasicAuthBlock - A block for connecting to a server using basic authentication.
+- ServerWithPublicKeyAuthBlock - A block for connecting to a server using public key authentication.
+- RCloneConfigFileBlock - A block for managing RClone configuration files.
+
+Tasks
+- list_remote_files_task - A task for listing files in a remote directory.
+- download_file_task - A task for downloading a single file from a remote server.
+- upload_file_task - A task for uploading a single file to a remote server.
+- [TODO] delete_file_task
+
+Flows
+- transfer_files_flow - a fully featured flow for transferring files between different storage locations.
+- upload_file_flow - a flow for uploading a file to a remote server. Supports pattern matching by date
+
+### Feedback
+
+If you encounter any bugs while using `prefect-managedfiletransfer`, feel free to open an issue in the [prefect-managedfiletransfer](https://github.com/ImperialCollegeLondon/prefect-managedfiletransfer) repository.
+
+
+Feel free to star or watch [`prefect-managedfiletransfer`](https://github.com/ImperialCollegeLondon/prefect-managedfiletransfer) for updates too!
+
+### Contributing
+
+If you'd like to help contribute to fix an issue or add a feature to `prefect-managedfiletransfer`, please [propose changes through a pull request from a fork of the repository](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork).
+
+Here are the steps:
+
+1. [Fork the repository](https://docs.github.com/en/get-started/quickstart/fork-a-repo#forking-a-repository)
+2. [Clone the forked repository](https://docs.github.com/en/get-started/quickstart/fork-a-repo#cloning-your-forked-repository)
+3. Install the repository and its dependencies:
+```
+# install uv first, then
+uv sync
+```
+
+You can also access all the prefect CLI tooling inside a uv managed venv
+```
+uv venv
+source .venv/bin/activate
+prefect server start
+```
+
+4. Make desired changes
+5. Add tests
+6. Insert an entry to [CHANGELOG.md](https://github.com/ImperialCollegeLondon/prefect-managedfiletransfer/blob/main/CHANGELOG.md)
+7. Install `pre-commit` to perform quality checks prior to commit:
+```
+pre-commit install
+```
+8. use the build script to run all the checks and tests:
+
+```
+./build.sh
+```
+8. `git commit`, `git push`, and create a pull request

prefect_managedfiletransfer-0.1.0/prefect_managedfiletransfer/AssetDownloadResult.py

@@ -0,0 +1,40 @@
+from datetime import datetime
+from pathlib import Path
+
+
+class AssetDownloadResult:
+    """
+    Represents the result of an asset download operation.
+    """
+
+    def __init__(
+        self,
+        success: bool,
+        file_path: Path | None,
+        download_skipped: bool = False,
+        last_modified: datetime | None = None,
+        size: int = 0,
+        error: str | None = None,
+    ):
+        """
+        Represents the result of an asset download operation.
+        :param success: True if the download was successful, False otherwise.
+        :param file_path: The path to the downloaded file, or None if the download failed.
+        :param download_skipped: True if the download was skipped because the file was not newer than the destination file.
+        :param last_modified: The last modified time of the file, if available.
+        """
+        self.last_modified = last_modified
+        self.success = success
+        self.file_path = file_path
+        self.download_skipped = download_skipped
+        self.error = error
+        self.size = size
+
+        if not success and file_path is not None:
+            raise ValueError("If success is False, file_path must be None")
+
+    def __repr__(self):
+        if self.error:
+            return f"AssetDownloadResult(success={self.success}, error={self.error})"
+
+        return f"AssetDownloadResult(success={self.success}, file_path={self.file_path}, download_skipped={self.download_skipped}, last_modified={self.last_modified})"

prefect_managedfiletransfer-0.1.0/prefect_managedfiletransfer/FileMatcher.py

@@ -0,0 +1,41 @@
+from datetime import timedelta
+from pydantic import BaseModel, Field
+from prefect_managedfiletransfer.SortFilesBy import SortFilesBy
+
+from pathlib import Path
+
+
+class FileMatcher(BaseModel):
+    """
+    Represents a file matcher with a source path and a pattern to match files.
+    This is used to find files in a directory that match a specific pattern.
+    """
+
+    source_folder: Path = Field(
+        default=Path("."),
+        description="Path to the source directory to look for files.",
+    )
+    pattern_to_match: str = Field(
+        default="*",
+        description="Pattern to match files in the source directory. Supports glob patterns like '*.txt' or 'file_*.csv'.",
+    )
+    minimum_age: str | int | timedelta | None = Field(
+        default=None,
+        description="Only transfer files older than this in secs (or other time with suffix s|m|h|d|w|month|year). Default off.",
+    )
+    maximum_age: str | int | timedelta | None = Field(
+        default=None,
+        description="Only transfer files newer than this in secs (or other time with suffix s|m|h|d|w|month|year). Default off.",
+    )
+    sort: SortFilesBy = Field(
+        default=SortFilesBy.PATH_ASC,
+        description="Sort files by a specific attribute. Default is PATH_ASC.",
+    )
+    skip: int = Field(
+        default=0,
+        description="Number of files to skip in the sorted list. Default is 0.",
+    )
+    take: int | None = Field(
+        default=None,
+        description="Number of files to take from the sorted list. If None, all files are taken. Default is None.",
+    )