Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yisuschrist/mal-organizer
A CLI tool to organize your MyAnimeList collection
https://github.com/yisuschrist/mal-organizer
anime myanimelist myanimelist-api python
Last synced: about 1 month ago
JSON representation
A CLI tool to organize your MyAnimeList collection
- Host: GitHub
- URL: https://github.com/yisuschrist/mal-organizer
- Owner: YisusChrist
- License: gpl-3.0
- Created: 2023-05-07T22:34:54.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-11-04T15:32:31.000Z (about 2 months ago)
- Last Synced: 2024-11-04T16:33:49.851Z (about 2 months ago)
- Topics: anime, myanimelist, myanimelist-api, python
- Language: Python
- Homepage: https://myanimelist.net
- Size: 309 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
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](#requirements)
- [Installation](#installation)
- [From PyPI](#from-pypi)
- [Manual installation](#manual-installation)
- [Uninstall](#uninstall)
- [Usage](#usage)
- [Contributors](#contributors)
- [How do I contribute to MAL-Organizer?](#how-do-i-contribute-to-mal-organizer)
- [License](#license)
## Requirements
Here's a breakdown of the packages needed and their versions:
- [malclient-upgraded](https://pypi.org/project/malclient-upgraded) (version 1.3.3)
- [platformdirs](https://pypi.org/project/platformdirs) (version 4.0.0)
- [python-dotenv](https://pypi.org/project/python-dotenv) (version 1.0.0)
- [rich-argparse-plus](https://pypi.org/project/rich-argparse-plus) (version 0.3.1.4)
- [rich](https://pypi.org/project/rich) (version 13.7.0)
- [tqdm](https://pypi.org/project/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:
```bash
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](https://pypi.org/project/pipx) for a safe and isolated installation experience. Therefore, the appropriate command to install `mal_organizer` would be:
>
> ```bash
> 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](https://github.com/YisusChrist/mal_organizer) from this repository:
```bash
git clone https://github.com/YisusChrist/mal_organizer
cd mal_organizer
```
2. Install the package:
```bash
poetry install
```
3. Run the program:
```bash
poetry run mal_organizer
```
### Uninstall
If you installed it from PyPI, you can use the following command:
```bash
pipx uninstall mal_organizer
```
## Usage
To run the `mal-organizer` script, you can use the following command:
```bash
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](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/MAL-Organizer/issues) and help where you can.
See [Contributing Guidelines](https://github.com/YisusChrist/.github/blob/main/CONTRIBUTING.md) for more details.
## License
`MAL-Organizer` is released under the [GPL-3.0 license](https://opensource.org/license/GPL-3.0).