Report Bug · Request Feature · Ask Question · Report security bug

py_ao3 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 py_ao3?
• License
• Credits

Requirements

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

• poetry >= 1.7.1 (only for manual installation)
• chardet >= 5.2.0
• matplotlib >= 3.9.1
• rich >= 13.7.1
• textual >= 0.74.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

py_ao3 can be installed easily as a PyPI package. Just run the following command:

pip3 install py_ao3

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 py_ao3 would be:

pipx install py_ao3

The program can now be ran from a terminal with the py_ao3 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 py_ao3 from this repository:

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

2. Install the package:

   poetry install --only main

3. Run the program:

   poetry run py_ao3

Uninstall

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

pipx uninstall py_ao3

Usage

To run the program, simply execute the following command:

py_ao3

In order to use the program, you must have a valid text file that contains the information of the stories you want to process. The file must be in the following format:

_[TITLE]_

- [CHARACTERS] ([SERIES])

- by [[AUTHOR]]([AUTHOR_URL]) → [WORDS]

- [RATING][COMMENT]

As you may see, Markdown syntax is used to format the text file, so the program will read the file and process the information accordingly. You are free to pass any text file you want, as long as it follows the format above.

Example of execution

demo.mp4

Contributors

How do I contribute to py_ao3?

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

py_ao3 is released under the GPL-3.0 License.

Credits

Note

Thanks to the Textualize team for the textual TUI framework, which was a great inspiration for me to develop this project.