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
  • From PyPI
  • Manual installation
  • Uninstall
• Usage
• 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)

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

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

pip3 install mal_organizer

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

pipx install mal_organizer

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

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

2. Install the package:

   poetry install --only main

3. Run the program:

   poetry run mal_organizer

Uninstall

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

pipx uninstall mal_organizer

Usage

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

License

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