Skip to content

baseplate-admin/Shiinobi

Repository files navigation

Shiinobi

A Python CLI tool for extracting and retrieving data from various platforms,
including anime and manga.

PyPI - Downloads PyPI - Python Version GitHub License



GitHub Actions Workflow Status Read the Docs

API Documentation

The API documentation for Shiinobi is available here.

Installation

  1. Clone the repository and navigate into dir:
git clone https://github.com/baseplate-admin/Shiinobi.git
cd Shiinobi
  1. Install dependencies:
poetry install
  1. Build the CLI tool:
poetry run poe build-cli

Usage

For a list of available commands, use:

poetry run poe dev-cli --help
# python ./src/shiinobi/cli.py --help

Run the CLI tool with:

poetry run poe dev-cli <command>
# python ./src/shiinobi/cli.py <command>

Executable Binaries

Pre-built executable binaries are available for Windows, Linux, and macOS in the releases section.

Used by

Shiinobi is primarily used within the CoreSeeder project.

Contributing

  • If you have a suggestion/idea that would make this project better, please create a pull request. All pull requests will be reviewed by us, and adjusted. You can also open a new issue or help us with an existing one.

  • Other than that, you can also help the project by giving it a star ⭐ Your help is extremely appreciated :)

License

This project is licensed under the MIT License. See the LICENSE file for details.