jmm

a cli tool for management of japanese adult media


Keywords
adults-only, crawler, python
License
MIT
Install
pip install jmm==0.0.2

Documentation

Japanese Media Manager

license pytest pylint flake8 mypy codecov Documentation Status

Japanese Media Manager (jMM) is a CLI tool for management of Japanese xxx media. The name of Japanese Media Manager pays tribute to tMM, which is short for tinyMediaManager.

Contents

Supported Crawlers

online database crawler name unit test
JavBus JavBusCrawler javbus
JavBooks JavBooksCrawler javbooks
JavDB JavDBCrawler javdb
AirAV AirAVCrawler airav
Arzon ArzonCrawler arzon
Avsox AvsoxCrawler avsox

Getting Started

Prerequisites

  • System OS: Windows, Linux, MacOS1.
  • Python: 3.7+.

Installing

pip install jmm

Running the tests

unit tests

If you want to run the tests, you need to install requirements first.

pip install -r testcases/requirements.txt

Then run all tests by following command.

pytest --app-id <app_id> --app-key <app_key>

where:

  • <app_id> is the APP ID of Baidu translation service2.
  • <app_key> is the APP Key of Baidu translation service.

If you does not specify the arguments <app_id> or <app_key>, the testcases about class Translator will be ignored.

coding style tests

  • pylint: you can check the quality of all code with pylint.

    # pip install pylint
    pylint japanese_media_manager testcases
  • flake8: it is a wrapper around these tools:

    • PyFlakes,
    • pycodestyle,
    • Ned Batchelder's McCabe script.

    You can run flake8 check by following command.

    # pip install flake8
    flake8 japanese_media_manager testcases
  • mypy: all code in directory japanese_media_manager observe PEP 484, you can use mypy to static type check.

    # pip install mypy
    python -m mypy japanese_media_manager

Contributing

I love your contribution! You can make contributing to this project as easy and transparent as possible, whether it's:

  • reporting a bug,
  • discussing the current state of the code,
  • submitting a fix,
  • proposing new features, or
  • becoming a maintainer.

License

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

Acknowledgments

Thanks to AVDC and Movie_Data_Capture. They are both excellent tools, and give a great inspiration to me.

ToDo

  • crawlers
    • javdb crawler
    • javbus crawler
    • javbooks crawler
    • airav crawler
    • arzon crawler
    • avsox crawler
  • utilities
    • translator
    • metadata
    • cache
    • router
    • crawler_group
    • logger
    • configuration
    • session
    • timer
  • scripts
    • generate configuration
    • scrape video
  • manual
    • autodoc
    • introduction
    • usage
    • framework
    • source code

Footnotes

  1. Theoretically, jMM can run on any OS, in which Python3 can be deployed. But, I just test jMM on these three OSs. ↩

  2. You need to regist Baidu account and request the service of translation, then you will get APP ID and APP Key. ↩