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

MAL-Organizer is a project that helps you organize and manage your anime watchlist on MyAnimeList. It allows you to easily add, remove, and update your anime list from the command line.

Table of Contents

• Requirements
• Installation
  • Manual installation
• Execution
• Contributors
  • How do I contribute to MAL-Organizer?
• License

Requirements

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

• malclient-upgraded (version 1.3.3)
• platformdirs (version 4.0.0)
• python-dotenv (version 1.0.0)
• rich-argparse-plus (version 0.3.1.4)
• rich (version 13.7.0)
• tqdm (version 4.66.1)

These packages can be installed using the following command:

pip3 install -r requirements.txt

This will install all the packages and their dependencies listed in the requirements.

Note: Something important to say, e.g. your code version.

Installation

MAL-Organizer can be installed easily as a Pypi package. Just run the following command:

pip3 install mal-organizer

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 MAL-Organizer would be:

pipx install mal-organizer

Manual installation

If you prefer to install the program manually, follow these steps:

Note: This will install the version from the latest commit, not the latest release.

1. Download the latest version of MAL-Organizer from this repository:

git clone https://github.com/YisusChrist/MAL-Organizer
cd MAL-Organizer

2. Install the dependencies:

pip3 install -r requirements.txt

3. Run the following commands to install MAL-Organizer in your /usr/bin/ directory:

sudo chmod +x mal-organizer
sudo cp mal-organizer /usr/bin/

The program can now be ran from a terminal with the mal-organizer command.

Execution

To run the mal-organizer script, you can use the following command:

mal-organizer [OPTIONS] ...

where [OPTIONS] are the command line options described below:

Contributors

How do I contribute to MAL-Organizer?

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 for more details.

License

MAL-Organizer is released under the GPL-3.0 license.