Skip to content

FansDB tailored community scrapers for Stash application

License

Notifications You must be signed in to change notification settings

FansDB/metadata-scrapers

Repository files navigation

FansDB community metadata scrapers

These community scrapers are tailored towards FansDB data structure. To use you need to have stashapp/stash application.

Source index: https://fansdb.github.io/metadata-scrapers/main/index.yml

Install

  1. To add a new source go to Settings > Metadata Providers page.
  2. Under Available Scrapers click Add Source.
  3. Add the following details:
    • Name: FansDB
    • Source URL: https://fansdb.github.io/metadata-scrapers/main/index.yml
    • Local path: fansdb
  4. Click Confirm.
  5. Under Available Scrapers select FansDB package to expand it and see all available scrapers.
  6. Click the checkmark next to relevant scraper and click Install.

Contributing

Pull requests are welcome.

Repository structure

  • Each yaml scraper should be under proper folder based on the network name (./scrapers/<network>).
  • Multiple scrapers can be under the same <network> folder.
  • Scrapers with only yaml files should be in the root folder under the <network>.
  • Scrapers with files that have dependancies should have its own folder under the <network> root.
  • <network> folder name should reflect the network name used in FansDB.

Validation

The scrapers in this repository can be validated against a schema and checked for common errors.

First, install the validator's dependencies - inside the /validator folder, run: yarn.

Then, to run the validator, use node validate.js in the root of the repository. Specific scrapers can be checked using: node validate.js scrapers/folder/example.yml scrapers/folder2/example2.yml

Attributions

From https://github.com/stashapp/CommunityScrapers under AGPL-3.0:

  • ./validate.js
  • ./build-site.sh
  • ./validator/*
  • ./.github/workflows/validate.yml