Metadata-Version: 2.4
Name: cronbi
Version: 0.1.5
Summary: A friendly terminal UI for scheduling backup commands on Ubuntu
Author: Cronbi contributors
License:                                  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.
        
Project-URL: Source, https://github.com/tmeftah/cronbi
Project-URL: Issues, https://github.com/tmeftah/cronbi/issues
Keywords: backup,cron,scheduler,tui,ubuntu
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: System :: Archiving :: Backup
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Dynamic: license-file

# 🥦 Cronbi

Cronbi is a terminal UI for creating and managing scheduled backup commands on Ubuntu. It lets you create cron schedules without opening the `crontab` editor and works with any command-line backup tool, including `rsync`, `tar`, `cp`, Restic, Borg, or your own scripts.

Cronbi stores the backup definitions locally, then writes active jobs to your user crontab when you choose **Apply**.

![Cronbi dashboard](https://raw.githubusercontent.com/tmeftah/cronbi/main/assets/cronbi-dashboard.png)

## Requirements

- Ubuntu or another Linux system with `cron`
- Python 3.10 or newer
- A backup command available on your system, such as `rsync`

Install cron and rsync if needed:

```bash
sudo apt install cron
sudo systemctl enable --now cron
sudo apt install rsync
```

## Run Cronbi

### Run directly from this checkout

```bash
git clone https://github.com/tmeftah/cronbi.git
cd cronbi
PYTHONPATH=src python3 -m cronbi.app
```

### Install the `cronbi` command

From the project directory:

```bash
python3 -m pip install --user -e .
cronbi
```

If `cronbi: command not found` appears after installation, start a new terminal or add the user Python bin directory to `PATH`:

```bash
export PATH="$HOME/.local/bin:$PATH"
```

## Create Your First Backup

1. Start Cronbi and press `n`.
2. Enter a job name, such as `Home documents`.
3. Enter the source directory. Press `Tab` to complete files and directories; press `Tab` repeatedly to cycle between matches.
4. Enter a destination directory or remote destination.
5. Pick **Every minute**, **Hourly**, **Daily**, **Weekly**, **Monthly**, or **Custom cron expression** with the arrow keys.
6. For the preset schedules, use the arrow keys to set the minute, hour, day, or weekday. Press `Tab` or Right Arrow to move to the next field and `Enter` to confirm.
7. Review the generated backup command. The default is:

   ```bash
   rsync -av SOURCE DESTINATION
   ```

   Change it to any command that works when run manually in a terminal.

8. Press `a` on the main screen to apply the active jobs to cron.

Cronbi saves a job immediately, but it does not update your crontab until you press `a`. Repeat that step after editing, pausing, resuming, or deleting a job.

## Manage Jobs

| Key        | Action                                                 |
| ---------- | ------------------------------------------------------ |
| Up / Down  | Select a job                                           |
| `n`        | Create a job                                           |
| `e`        | Edit the selected job                                  |
| `p`        | Pause the selected job                                 |
| `r`        | Resume the selected job                                |
| `d`        | Delete the selected job; press `y` or Enter to confirm |
| `a`        | Apply active jobs to your user crontab                 |
| `?`        | Show Cronbi diagnostics and paths                      |
| `q` or Esc | Quit                                                   |

## Commands and Examples

Cronbi schedules exactly the command you save. Test a command in a regular terminal before adding it to a schedule.

Copy a local folder with rsync:

```bash
rsync -av --delete /path/to/source/ /path/to/backup-destination/
```

Create a compressed archive:

```bash
tar -czf /path/to/backup/home-$(date +\%F).tar.gz /path/to/source
```

Cron treats `%` as a special character. Escape it as `\%` in commands entered in Cronbi, as shown in the archive example.

## How Cronbi Uses Cron

Cronbi does not open the interactive `crontab` editor. When you press `a`, it:

1. Reads your current user crontab.
2. Keeps every line it does not own.
3. Removes only lines tagged with `# cronbi:<id>`.
4. Adds the active Cronbi jobs and submits the result through `crontab -`.

Paused jobs are kept in Cronbi's local job list but are omitted from the installed crontab. Deleting a job removes its managed cron line the next time you press `a`.

## Files and Logs

| Location                                  | Purpose                                            |
| ----------------------------------------- | -------------------------------------------------- |
| `~/.local/share/cronbi/jobs.json`         | Saved Cronbi job definitions                       |
| `~/.local/state/cronbi/logs/<job-id>.log` | Standard output and errors from a scheduled job    |
| `crontab -l`                              | The user crontab, including Cronbi-managed entries |

Check the installed Cronbi entries:

```bash
crontab -l | grep '# cronbi:'
```

Check a job's latest output:

```bash
tail -n 100 ~/.local/state/cronbi/logs/<job-id>.log
```

The job ID appears in the installed cron line. You can also press `?` inside Cronbi to see its jobs and log locations.

## Troubleshooting

- **No backup appears:** confirm the job is marked `ACTIVE`, press `a`, then inspect its log file. Also run the saved command manually in a terminal.
- **`crontab` is unavailable:** install and start cron with `sudo apt install cron` and `sudo systemctl enable --now cron`.
- **A command works in a terminal but not cron:** cron has a minimal environment. Use absolute paths to executables and files, and avoid relying on shell aliases or environment variables.
- **Destination requires mounting:** make sure the target drive or network mount exists before the scheduled time. For system-managed mounts, prefer stable mount points and configure the mount to be available before cron runs.

## Safety

Cronbi preserves unrelated cron entries, but a backup command can still overwrite or delete files. In particular, `rsync --delete` removes destination files that are no longer in the source. Test commands with a non-critical destination before scheduling them.
