Commit 90299174 authored by TheTechRobo's avatar TheTechRobo
Browse files

Update some docs

parent 35727b64
Loading
Loading
Loading
Loading
+4 −2
Original line number Diff line number Diff line
# youtubevideofinder
# FindYouTubeVideo
Searches through various places for archived YouTube content.

Contributions are welcome!

## Usage as a module
There are docstrings included in the module (it is contained in `youtubevideofinder`), but no `setup.py` or PyPI package is currently included. This is because it is not yet 100% stable, and the API still isn't great.
There are docstrings included in the module (it is contained in `findyoutubevideo`), but no `setup.py` or PyPI package is currently included. This is because it is not yet 100% stable, and the API still isn't great.

## Frontend
### Running in Docker (recommended):
@@ -42,6 +42,8 @@ methods:
...
```

Some scrapers require further configuration (typically authentication) and are disabled by default.

## Contributing

If creating a new scraper, just make a new class in the finder.py file, and update the example config file.
+9 −2
Original line number Diff line number Diff line
@@ -38,18 +38,25 @@ methods:
    enabled: true

  filmot:
    # This is not the RapidAPI endpoint.
    title: Filmot
    enabled: false
    api_key:

  # Playboard's ratelimits are currently 1 per day, which is ridiculous, hence why this is disabled by default.
  # If anyone is actually paying money for a Playboard account, I would accept a PR to add login support, but I can't test it myself.
  playboard_co:
    title: Playboard.co
    enabled: false
    user_agent: "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/110.%s.0.0 Safari/537.36"

  removededm:
    title: Removed.edm
    enabled: true
    title: RemovedEDM
    enabled: false
    # These are not account usernames. Use Special:BotPasswords.
    # Only basic rights are necessary.
    username: null
    password: null

  odysee:
    title: Odysee