mirrors/yt-dlp
1
0
Fork 0
mirror of https://github.com/yt-dlp/yt-dlp.git synced 2024-11-27 10:31:29 +00:00
Code Issues Packages Projects Releases Wiki Activity

[Plugin Development] Fix links back to yt-dlp-sample-plugins

coletdjnz 2023-01-02 06:24:58 +00:00 committed by GitHub
parent faac433041
commit 1576244937
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
Plugin Development.md

@ -24,15 +24,15 @@ A template plugin package repository is available at [yt-dlp/yt-dlp-sample-plugi
---
## Configuring your plugin package
1. Modify [setup.cfg](setup.cfg) with your plugin's name and version. It is recommended to bump the version whenever you make changes or a new release.
2. Update the installation instructions in [README.md](README.md) to point to this repository.
1. Modify [setup.cfg](https://github.com/yt-dlp/yt-dlp-sample-plugins/blob/master/setup.cfg) with your plugin's name and version. It is recommended to bump the version whenever you make changes or a new release.
2. Update the installation instructions on [README.md](https://github.com/yt-dlp/yt-dlp-sample-plugins/blob/master/README.md) to point to this repository.
3. Add `yt-dlp-plugins` to the repository tags for discoverability.
4. Be sure to remove any of the sample extractors/post-processors.
## Run and debug configuration
1. Set your IDE's run configuration to point to the `yt_dlp` Python module.
2. Add your project's root directory containing `yt_dlp_plugins` to `PYTHONPATH` environment variable (this may not be necessary with some IDE run configurations)
3. The `yt_dlp_plugins` folder should be automatically picked up by yt-dlp (run with `-v` to check)
2. Add your project's root directory containing `yt_dlp_plugins` to `PYTHONPATH` environment variable (this may not be necessary with some IDE run configurations).
3. The `yt_dlp_plugins` folder should be automatically picked up by yt-dlp (run with `-v` to check).
## Importing extractors from other plugins
@ -58,4 +58,4 @@ packages = [{ include = "yt_dlp_plugins" }]
...
```
See the [Poetry documentation](https://python-poetry.org/docs/pyproject/#packages) for more details.
See the [Poetry documentation](https://python-poetry.org/docs/pyproject/#packages) for more details.