rsync-time-machine 1.0.0__tar.gz

rsync-time-machine-1.0.0/LICENSE

@@ -0,0 +1,201 @@
+                                 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 [yyyy] [name of copyright owner]
+
+   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.

rsync-time-machine-1.0.0/PKG-INFO

@@ -0,0 +1,195 @@
+Metadata-Version: 2.1
+Name: rsync-time-machine
+Version: 1.0.0
+Summary: rsync-time-machine.py is a wrapper around rsync to make it easier to create and maintain Time Machine style backups.
+Author-email: Bas Nijholt <bas@nijho.lt>
+Project-URL: Homepage, https://github.com/basnijholt/rsync-time-machine.py
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+Provides-Extra: test
+Provides-Extra: docs
+License-File: LICENSE
+
+# Rsync Time Machine 🕰️💾
+
+Introducing `rsync-time-machine.py` - a Python port of the [`rsync-time-backup`](https://github.com/laurent22/rsync-time-backup) script, offering Time Machine-style backups using rsync. It creates incremental backups of files and directories to the destination of your choice. The backups are structured in a way that makes it easy to recover any file at any point in time. 🚀
+
+It works on Linux, macOS, and Windows (via WSL or Cygwin). The main advantage over Time Machine is flexibility, as it can backup from/to any filesystem and works on any platform. You can also backup to a Truecrypt drive without any problem. 😃
+
+`rsync-time-machine.py` is fully tested, has no external dependencies (only Python ≥3.7 🐍), is fully compatible with [`rsync-time-backup`](https://github.com/laurent22/rsync-time-backup), offers pretty terminal output, and is fully typed! 🎉
+
+<details><summary><b><u>[ToC]</u></b> 📚</summary>
+
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+
+- [:star2: Features](#star2-features)
+- [:books: Usage](#books-usage)
+- [:hammer_and_wrench: Installation](#hammer_and_wrench-installation)
+- [:bulb: Examples](#bulb-examples)
+- [:calendar: Backup Expiration Logic](#calendar-backup-expiration-logic)
+- [:page_facing_up: Exclusion File](#page_facing_up-exclusion-file)
+- [:lock: Built-in Lock](#lock-built-in-lock)
+- [:gear: Rsync Options](#gear-rsync-options)
+- [:no_entry_sign: No Automatic Backup Expiration](#no_entry_sign-no-automatic-backup-expiration)
+- [:arrows_counterclockwise: How to Restore](#arrows_counterclockwise-how-to-restore)
+- [:heart: Support and Contributions](#heart-support-and-contributions)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
+</details>
+
+## :star2: Features
+
+* 📁 Each backup is in its own folder named after the current timestamp.
+* 🔒 Backup to/from remote destinations over SSH.
+* 🔗 Files that haven't changed from one backup to the next are hard-linked to the previous backup, saving space.
+* ⚠️ Safety check - the backup will only happen if the destination has explicitly been marked as a backup destination.
+* 🔄 Resume feature - if a backup has failed or was interrupted, the tool will resume from there on the next backup.
+* 🚫 Exclude file - support for pattern-based exclusion via the `--exclude-from` rsync parameter.
+* 🧹 Automatically purge old backups based on a configurable expiration strategy.
+* 🔗 "latest" symlink that points to the latest successful backup.
+
+## :books: Usage
+
+To use `rsync-time-machine.py`, you'll need to provide source and destination paths, along with any desired options:
+
+```bash
+rsync-time-machine --help
+```
+Shows the help message:
+
+<!-- CODE:BASH:START -->
+<!-- echo '```bash' -->
+<!-- rsync-time-machine --help -->
+<!-- echo '```' -->
+<!-- CODE:END -->
+
+<!-- OUTPUT:START -->
+<!-- ⚠️ This content is auto-generated by `markdown-code-runner`. -->
+```bash
+usage: rsync-time-machine [-h] [-p PORT] [-i ID_RSA] [--rsync-get-flags]
+                          [--rsync-set-flags RSYNC_SET_FLAGS]
+                          [--rsync-append-flags RSYNC_APPEND_FLAGS]
+                          [--log-dir LOG_DIR] [--strategy STRATEGY]
+                          [--no-auto-expire] [--allow-host-only] [-v]
+                          src_folder dest_folder [exclusion_file]
+
+A script for creating and managing time-stamped backups using rsync.
+
+positional arguments:
+  src_folder            Source folder for backup. Format: [USER@HOST:]SOURCE
+  dest_folder           Destination folder for backup. Format:
+                        [USER@HOST:]DESTINATION
+  exclusion_file        Path to the file containing exclude patterns.
+
+options:
+  -h, --help            show this help message and exit
+  -p PORT, --port PORT  SSH port.
+  -i ID_RSA, --id_rsa ID_RSA
+                        Specify the private ssh key to use.
+  --rsync-get-flags     Display the default rsync flags that are used for
+                        backup. If using remote drive over SSH, --compress
+                        will be added.
+  --rsync-set-flags RSYNC_SET_FLAGS
+                        Set the rsync flags that are going to be used for
+                        backup.
+  --rsync-append-flags RSYNC_APPEND_FLAGS
+                        Append the rsync flags that are going to be used for
+                        backup.
+  --log-dir LOG_DIR     Set the log file directory. If this flag is set,
+                        generated files will not be managed by the script - in
+                        particular they will not be automatically deleted.
+                        Default: $HOME/.rsync-time-backup
+  --strategy STRATEGY   Set the expiration strategy. Default: "1:1 30:7
+                        365:30" means after one day, keep one backup per day.
+                        After 30 days, keep one backup every 7 days. After 365
+                        days keep one backup every 30 days.
+  --no-auto-expire      Disable automatically deleting backups when out of
+                        space. Instead, an error is logged, and the backup is
+                        aborted.
+  --allow-host-only     By default, the script expects a 'USER@HOST' pattern
+                        for specifying SSH connections. When this flag is
+                        used, it allows for the 'HOST' pattern without a
+                        specified user. This is useful if you want to use
+                        configurations from the `.ssh/config` file or rely on
+                        the current username. Note: this option will not
+                        enforce SSH usage, it only broadens the accepted input
+                        formats.
+  -v, --verbose         Enable verbose output.
+```
+
+<!-- OUTPUT:END -->
+
+Please refer to the original [`rsync-time-backup`](https://github.com/laurent22/rsync-time-backup) README for a list of options, as they have been preserved in the Python port.
+
+## :hammer_and_wrench: Installation
+
+To install `rsync-time-machine.py`, simply clone the repository:
+
+```bash
+pip install rsync-time-machine
+```
+
+and use it like `rsync-time-machine --help`
+
+Or just copy the script to your computer:
+
+```bash
+wget https://raw.githubusercontent.com/basnijholt/rsync-time-machine.py/main/rsync_time_machine.py
+```
+and use it like `./rsync_time_machine.py --help`
+
+## :bulb: Examples
+
+* Backup the home folder to backup_drive:
+
+```
+./rsync_time_machine.py /home /mnt/backup_drive
+```
+
+* Backup with exclusion list:
+
+```
+./rsync_time_machine.py /home /mnt/backup_drive excluded_patterns.txt
+```
+
+For more examples and detailed usage instructions, please refer to the original [`rsync-time-backup`](https://github.com/laurent22/rsync-time-backup) README.
+
+## :calendar: Backup Expiration Logic
+
+Backup sets are automatically deleted following a simple expiration strategy defined with the `--strategy` flag. The default strategy is `1:1 30:7 365:30`. Please see the original README for a detailed explanation.
+
+## :page_facing_up: Exclusion File
+
+An optional exclude file can be provided as a third parameter, compatible with the `--exclude-from` parameter of rsync.
+
+## :lock: Built-in Lock
+
+The script is designed so that only one backup operation can be active for a given directory, avoiding conflicts.
+
+## :gear: Rsync Options
+
+To display, add, or remove rsync options, use the `--rsync-get-flags`, `--rsync-append-flags`, or `--rsync-set-flags` options.
+
+## :no_entry_sign: No Automatic Backup Expiration
+
+Use the `--no-auto-expire` flag to disable the default behavior of purging old backups when out of space.
+
+## :arrows_counterclockwise: How to Restore
+
+Restoring files from the backup is simple, as the script creates a backup in a regular directory. You can easily copy the files back to the original directory using a command like:
+
+```
+rsync -aP /path/to/last/backup/ /path/to/restore/to/
+```
+
+Consider using the `--dry-run` option to check what exactly is going to be copied. If you want to delete files that exist in the destination but not in the backup, use the `--delete` option. Be extra cautious when using this option to avoid data loss.
+
+You can also restore files using any file explorer, including Finder on macOS or the command line.
+
+## :heart: Support and Contributions
+
+We appreciate your feedback and contributions! If you encounter any issues or have suggestions for improvements, please file an issue on the GitHub repository. We also welcome pull requests for bug fixes or new features.
+
+Happy backing up! 💾🕰️🎉

rsync-time-machine-1.0.0/README.md

@@ -0,0 +1,183 @@
+# Rsync Time Machine 🕰️💾
+
+Introducing `rsync-time-machine.py` - a Python port of the [`rsync-time-backup`](https://github.com/laurent22/rsync-time-backup) script, offering Time Machine-style backups using rsync. It creates incremental backups of files and directories to the destination of your choice. The backups are structured in a way that makes it easy to recover any file at any point in time. 🚀
+
+It works on Linux, macOS, and Windows (via WSL or Cygwin). The main advantage over Time Machine is flexibility, as it can backup from/to any filesystem and works on any platform. You can also backup to a Truecrypt drive without any problem. 😃
+
+`rsync-time-machine.py` is fully tested, has no external dependencies (only Python ≥3.7 🐍), is fully compatible with [`rsync-time-backup`](https://github.com/laurent22/rsync-time-backup), offers pretty terminal output, and is fully typed! 🎉
+
+<details><summary><b><u>[ToC]</u></b> 📚</summary>
+
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+
+- [:star2: Features](#star2-features)
+- [:books: Usage](#books-usage)
+- [:hammer_and_wrench: Installation](#hammer_and_wrench-installation)
+- [:bulb: Examples](#bulb-examples)
+- [:calendar: Backup Expiration Logic](#calendar-backup-expiration-logic)
+- [:page_facing_up: Exclusion File](#page_facing_up-exclusion-file)
+- [:lock: Built-in Lock](#lock-built-in-lock)
+- [:gear: Rsync Options](#gear-rsync-options)
+- [:no_entry_sign: No Automatic Backup Expiration](#no_entry_sign-no-automatic-backup-expiration)
+- [:arrows_counterclockwise: How to Restore](#arrows_counterclockwise-how-to-restore)
+- [:heart: Support and Contributions](#heart-support-and-contributions)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
+</details>
+
+## :star2: Features
+
+* 📁 Each backup is in its own folder named after the current timestamp.
+* 🔒 Backup to/from remote destinations over SSH.
+* 🔗 Files that haven't changed from one backup to the next are hard-linked to the previous backup, saving space.
+* ⚠️ Safety check - the backup will only happen if the destination has explicitly been marked as a backup destination.
+* 🔄 Resume feature - if a backup has failed or was interrupted, the tool will resume from there on the next backup.
+* 🚫 Exclude file - support for pattern-based exclusion via the `--exclude-from` rsync parameter.
+* 🧹 Automatically purge old backups based on a configurable expiration strategy.
+* 🔗 "latest" symlink that points to the latest successful backup.
+
+## :books: Usage
+
+To use `rsync-time-machine.py`, you'll need to provide source and destination paths, along with any desired options:
+
+```bash
+rsync-time-machine --help
+```
+Shows the help message:
+
+<!-- CODE:BASH:START -->
+<!-- echo '```bash' -->
+<!-- rsync-time-machine --help -->
+<!-- echo '```' -->
+<!-- CODE:END -->
+
+<!-- OUTPUT:START -->
+<!-- ⚠️ This content is auto-generated by `markdown-code-runner`. -->
+```bash
+usage: rsync-time-machine [-h] [-p PORT] [-i ID_RSA] [--rsync-get-flags]
+                          [--rsync-set-flags RSYNC_SET_FLAGS]
+                          [--rsync-append-flags RSYNC_APPEND_FLAGS]
+                          [--log-dir LOG_DIR] [--strategy STRATEGY]
+                          [--no-auto-expire] [--allow-host-only] [-v]
+                          src_folder dest_folder [exclusion_file]
+
+A script for creating and managing time-stamped backups using rsync.
+
+positional arguments:
+  src_folder            Source folder for backup. Format: [USER@HOST:]SOURCE
+  dest_folder           Destination folder for backup. Format:
+                        [USER@HOST:]DESTINATION
+  exclusion_file        Path to the file containing exclude patterns.
+
+options:
+  -h, --help            show this help message and exit
+  -p PORT, --port PORT  SSH port.
+  -i ID_RSA, --id_rsa ID_RSA
+                        Specify the private ssh key to use.
+  --rsync-get-flags     Display the default rsync flags that are used for
+                        backup. If using remote drive over SSH, --compress
+                        will be added.
+  --rsync-set-flags RSYNC_SET_FLAGS
+                        Set the rsync flags that are going to be used for
+                        backup.
+  --rsync-append-flags RSYNC_APPEND_FLAGS
+                        Append the rsync flags that are going to be used for
+                        backup.
+  --log-dir LOG_DIR     Set the log file directory. If this flag is set,
+                        generated files will not be managed by the script - in
+                        particular they will not be automatically deleted.
+                        Default: $HOME/.rsync-time-backup
+  --strategy STRATEGY   Set the expiration strategy. Default: "1:1 30:7
+                        365:30" means after one day, keep one backup per day.
+                        After 30 days, keep one backup every 7 days. After 365
+                        days keep one backup every 30 days.
+  --no-auto-expire      Disable automatically deleting backups when out of
+                        space. Instead, an error is logged, and the backup is
+                        aborted.
+  --allow-host-only     By default, the script expects a 'USER@HOST' pattern
+                        for specifying SSH connections. When this flag is
+                        used, it allows for the 'HOST' pattern without a
+                        specified user. This is useful if you want to use
+                        configurations from the `.ssh/config` file or rely on
+                        the current username. Note: this option will not
+                        enforce SSH usage, it only broadens the accepted input
+                        formats.
+  -v, --verbose         Enable verbose output.
+```
+
+<!-- OUTPUT:END -->
+
+Please refer to the original [`rsync-time-backup`](https://github.com/laurent22/rsync-time-backup) README for a list of options, as they have been preserved in the Python port.
+
+## :hammer_and_wrench: Installation
+
+To install `rsync-time-machine.py`, simply clone the repository:
+
+```bash
+pip install rsync-time-machine
+```
+
+and use it like `rsync-time-machine --help`
+
+Or just copy the script to your computer:
+
+```bash
+wget https://raw.githubusercontent.com/basnijholt/rsync-time-machine.py/main/rsync_time_machine.py
+```
+and use it like `./rsync_time_machine.py --help`
+
+## :bulb: Examples
+
+* Backup the home folder to backup_drive:
+
+```
+./rsync_time_machine.py /home /mnt/backup_drive
+```
+
+* Backup with exclusion list:
+
+```
+./rsync_time_machine.py /home /mnt/backup_drive excluded_patterns.txt
+```
+
+For more examples and detailed usage instructions, please refer to the original [`rsync-time-backup`](https://github.com/laurent22/rsync-time-backup) README.
+
+## :calendar: Backup Expiration Logic
+
+Backup sets are automatically deleted following a simple expiration strategy defined with the `--strategy` flag. The default strategy is `1:1 30:7 365:30`. Please see the original README for a detailed explanation.
+
+## :page_facing_up: Exclusion File
+
+An optional exclude file can be provided as a third parameter, compatible with the `--exclude-from` parameter of rsync.
+
+## :lock: Built-in Lock
+
+The script is designed so that only one backup operation can be active for a given directory, avoiding conflicts.
+
+## :gear: Rsync Options
+
+To display, add, or remove rsync options, use the `--rsync-get-flags`, `--rsync-append-flags`, or `--rsync-set-flags` options.
+
+## :no_entry_sign: No Automatic Backup Expiration
+
+Use the `--no-auto-expire` flag to disable the default behavior of purging old backups when out of space.
+
+## :arrows_counterclockwise: How to Restore
+
+Restoring files from the backup is simple, as the script creates a backup in a regular directory. You can easily copy the files back to the original directory using a command like:
+
+```
+rsync -aP /path/to/last/backup/ /path/to/restore/to/
+```
+
+Consider using the `--dry-run` option to check what exactly is going to be copied. If you want to delete files that exist in the destination but not in the backup, use the `--delete` option. Be extra cautious when using this option to avoid data loss.
+
+You can also restore files using any file explorer, including Finder on macOS or the command line.
+
+## :heart: Support and Contributions
+
+We appreciate your feedback and contributions! If you encounter any issues or have suggestions for improvements, please file an issue on the GitHub repository. We also welcome pull requests for bug fixes or new features.
+
+Happy backing up! 💾🕰️🎉

rsync-time-machine-1.0.0/pyproject.toml

@@ -0,0 +1,83 @@
+[build-system]
+requires = ["setuptools>=42", "wheel", "versioningit"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "rsync-time-machine"
+description = "rsync-time-machine.py is a wrapper around rsync to make it easier to create and maintain Time Machine style backups."
+dynamic = ["version"]
+authors = [{ name = "Bas Nijholt", email = "bas@nijho.lt" }]
+dependencies = []
+requires-python = ">=3.7"
+
+[project.readme]
+file = "README.md"
+content-type = "text/markdown"
+
+[project.urls]
+Homepage = "https://github.com/basnijholt/rsync-time-machine.py"
+
+[project.optional-dependencies]
+test = ["pytest", "pre-commit", "coverage", "pytest-cov"]
+docs = []
+
+[project.scripts]
+rsync-time-machine = "rsync_time_machine:main"
+
+[tool.setuptools]
+py-modules = ["rsync_time_machine"]
+
+[tool.pytest.ini_options]
+addopts = """
+    --cov=rsync_time_machine
+    --cov-report term
+    --cov-report html
+    --cov-fail-under=70
+"""
+
+[tool.coverage.report]
+exclude_lines = [
+    "pragma: no cover",
+    "raise NotImplementedError",
+    "if TYPE_CHECKING:",
+    "if __name__ == .__main__.:",
+]
+
+[tool.black]
+line_length = 88
+
+[tool.ruff]
+line-length = 150
+target-version = "py37"
+select = ["ALL"]
+ignore = [
+    "T20",     # flake8-print
+    "ANN101",  # Missing type annotation for {name} in method
+    "S101",    # Use of assert detected
+    "PD901",   # df is a bad variable name. Be kinder to your future self.
+    "ANN401",  # Dynamically typed expressions (typing.Any) are disallowed in {name}
+    "D402",    # First line should not be the function's signature
+    "PLW0603", # Using the global statement to update `X` is discouraged
+    "D401",    # First line of docstring should be in imperative mood
+    "SLF001",  # Private member accessed
+    "PTH",     # Use pathlib.Path
+    "DTZ005",  # The use of `datetime.datetime.now()` without `tz` argument is not allowed
+    "PLR0913", # Too many arguments to function call
+]
+
+[tool.ruff.per-file-ignores]
+"tests/*" = ["SLF001"]
+".github/*" = ["INP001"]
+
+[tool.ruff.mccabe]
+max-complexity = 18
+
+[tool.mypy]
+python_version = "3.7"
+
+[tool.versioningit]
+
+[tool.versioningit.vcs]
+method = "git"
+match = ["v*"]
+default-tag = "0.0.0"