Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yisuschrist/pybacker
Python script for local folders backup
https://github.com/yisuschrist/pybacker
backup python3 script
Last synced: about 11 hours ago
JSON representation
Python script for local folders backup
- Host: GitHub
- URL: https://github.com/yisuschrist/pybacker
- Owner: YisusChrist
- License: gpl-2.0
- Created: 2023-03-20T20:56:07.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-11-08T17:00:31.000Z (12 days ago)
- Last Synced: 2024-11-08T18:17:34.986Z (11 days ago)
- Topics: backup, python3, script
- Language: Python
- Homepage:
- Size: 153 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Report Bug
·
Request Feature
·
Ask Question
·
Report security bug
`pybacker` is a Python script that allows you to backup your GitHub repositories in a simple and fast way.
Table of Contents
- [Requirements](#requirements)
- [Installation](#installation)
- [From PyPI](#from-pypi)
- [Manual installation](#manual-installation)
- [Uninstall](#uninstall)
- [Usage](#usage)
- [Example of execution](#example-of-execution)
- [Contributors](#contributors)
- [How do I contribute to Pybacker?](#how-do-i-contribute-to-pybacker)
- [License](#license)
- [Credits](#credits)
## Requirements
Here's a breakdown of the packages needed and their versions:
- [poetry](https://pypi.org/project/poetry) >= 1.7.1 (_only for manual installation_)
- [core-helpers](https://github.com/YisusChrist/core_helpers)
- [requests](https://pypi.org/project/requests) >= 2.31.0
- [rich](https://pypi.org/project/rich) >= 13.7.0
> [!NOTE]
> The software has been developed and tested using Python `3.12.1`. The minimum required version to run the software is Python 3.6. Although the software may work with previous versions, it is not guaranteed.
## Installation
### From PyPI
`pybacker` can be installed easily as a PyPI package. Just run the following command:
```bash
pip3 install pybacker
```
> [!IMPORTANT]
> For best practices and to avoid potential conflicts with your global Python environment, it is strongly recommended to install this program within a virtual environment. Avoid using the --user option for global installations. We highly recommend using [pipx](https://pypi.org/project/pipx) for a safe and isolated installation experience. Therefore, the appropriate command to install `pybacker` would be:
>
> ```bash
> pipx install pybacker
> ```
The program can now be ran from a terminal with the `pybacker` command.
### Manual installation
If you prefer to install the program manually, follow these steps:
> [!WARNING]
> This will install the version from the latest commit, not the latest release.
1. Download the latest version of [pybacker](https://github.com/YisusChrist/pybacker) from this repository:
```bash
git clone https://github.com/YisusChrist/pybacker
cd pybacker
```
2. Install the package:
```bash
poetry install
```
3. Run the program:
```bash
poetry run pybacker
```
### Uninstall
If you installed it from PyPI, you can use the following command:
```bash
pipx uninstall pybacker
```
## Usage
> [!TIP]
> For more information about the usage of the program, run `pybacker --help` or `pybacker -h`.
### Example of execution
## Contributors
### How do I contribute to Pybacker?
Before you participate in our delightful community, please read the [code of conduct](https://github.com/YisusChrist/.github/blob/main/CODE_OF_CONDUCT.md).
I'm far from being an expert and suspect there are many ways to improve – if you have ideas on how to make the configuration easier to maintain (and faster), don't hesitate to fork and send pull requests!
We also need people to test out pull requests. So take a look through [the open issues](https://github.com/YisusChrist/pybacker/issues) and help where you can.
See [Contributing Guidelines](https://github.com/YisusChrist/.github/blob/main/CONTRIBUTING.md) for more details.
## License
`pybacker` is released under the [GPL-2.0 License](https://opensource.org/license/GPL-2.0).
## Credits
> [!NOTE]
> Credits to [Julynx](https://github.com/Julynx) for creating the script. I only make improvements in his code based on my preferences to customize it. All the ideas and the base of the script are his.