Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/baseplate-admin/shiinobi

myanimelist python scraper selectolax

Last synced: 14 days ago
JSON representation

Host: GitHub
URL: https://github.com/baseplate-admin/shiinobi
Owner: baseplate-admin
License: mit
Created: 2024-07-30T17:14:48.000Z (6 months ago)
Default Branch: master
Last Pushed: 2025-01-14T06:21:43.000Z (19 days ago)
Last Synced: 2025-01-14T06:35:37.581Z (19 days ago)
Topics: myanimelist, python, scraper, selectolax
Language: Python
Homepage: https://shiinobi.readthedocs.io/
Size: 812 KB
Stars: 1
Watchers: 1
Forks: 0
Open Issues: 1
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

Shiinobi

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

![PyPI - Downloads](https://img.shields.io/pypi/dm/Shiinobi?style=flat-square&color=%23B8B8C4)
![PyPI - Python Version](https://img.shields.io/pypi/pyversions/Shiinobi?style=flat-square&color=%23B8B8C4)
![GitHub License](https://img.shields.io/github/license/baseplate-admin/Shiinobi?style=flat-square&color=%23B8B8C4)

![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/baseplate-admin/Shiinobi/CI.yaml?style=for-the-badge&color=%23B8B8C4)
![Read the Docs](https://img.shields.io/readthedocs/shiinobi?style=for-the-badge&color=%23B8B8C4)

## API Documentation

The API documentation for Shiinobi is available [here](https://shiinobi.readthedocs.io/).

## Installation

1. Clone the repository and navigate into dir:

```bash
git clone https://github.com/baseplate-admin/Shiinobi.git
cd Shiinobi
```

2. Install dependencies:

```bash
poetry install
```

3. Build the CLI tool:

```bash
poetry run poe build-cli
```

## Usage

For a list of available commands, use:

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

Run the CLI tool with:

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

## Executable Binaries

Pre-built executable binaries are available for Windows, Linux, and macOS in the [releases](https://github.com/baseplate-admin/Shiinobi/releases) section.

## Used by

Shiinobi is primarily used within the [CoreSeeder](https://github.com/coreproject-moe/CoreProject/tree/master/seeder) 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](https://github.com/baseplate-admin/Shiinobi/issues/new) or help us with an [existing one](https://github.com/baseplate-admin/Shiinobi/issues/).

- 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](https://github.com/baseplate-admin/Shiinobi/blob/master/LICENSE) file for details.