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
• Installation
  • From PyPI
  • Manual installation
  • Uninstall
• Usage
  • Example of execution
• Contributors
  • How do I contribute to Pybacker?
• License
• Credits

Requirements

Here's a breakdown of the packages needed and their versions:

• poetry >= 1.7.1 (only for manual installation)
• core-helpers
• requests >= 2.31.0
• 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:

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 for a safe and isolated installation experience. Therefore, the appropriate command to install pybacker would be:

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 from this repository:

   git clone https://github.com/YisusChrist/pybacker
   cd pybacker

2. Install the package:

   poetry install

3. Run the program:

   poetry run pybacker

Uninstall

If you installed it from PyPI, you can use the following command:

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.

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 and help where you can.

See Contributing Guidelines for more details.

License

pybacker is released under the GPL-2.0 License.

Credits

Note

Credits to 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.