Update README.md
This commit is contained in:
parent
acd27044dc
commit
2b83e386dd
1 changed files with 0 additions and 50 deletions
50
README.md
50
README.md
|
@ -2,56 +2,6 @@
|
|||
|
||||
YouTube2PeerTube is a bot written in Python3 that mirrors YouTube channels to PeerTube channels as videos are released in a YouTube channel.
|
||||
|
||||
It checks YouTube channels periodically, when new videos are found, it downloads them with metadata and uploads them to PeerTube instances.
|
||||
|
||||
This tool supports multiple channels, and supports mirroring each YouTube channel to a user defined PeerTube channel and instance that can be different for each YouTube channel being mirrored.
|
||||
|
||||
This tool does not use YouTube APIs. Instead, it subscribes to channels via RSS. This is a primary feature, this tool will always avoid the YouTube API, and no features will be implemented that require the YouTube API.
|
||||
|
||||
If you need to archive a YouTube channel with lots of existing videos, this tool is not for you. This tool starts mirroring channels from the time they are added to the config and will not mirror all historical videos that exist in a YouTube channel. A tool that provides this functionality is available https://github.com/Chocobozzz/PeerTube/blob/develop/support/doc/tools.md#peertube-import-videosjs
|
||||
|
||||
## Dependencies
|
||||
|
||||
This tool depends on:
|
||||
|
||||
- pafy https://github.com/mps-youtube/pafy for downloading of YouTube content.
|
||||
|
||||
- feedparser for parsing of RSS data
|
||||
|
||||
- TOML for the configuration file
|
||||
|
||||
- MultipartEncoder from requests_toolbelt
|
||||
|
||||
- urllib.request, requests, mimetypes, time, json and os from the Python standard library
|
||||
|
||||
It also contains heavily modified components from prismedia https://git.lecygnenoir.info/LecygneNoir/prismedia for uploading videos and metadata to PeerTube.
|
||||
|
||||
## Configuration
|
||||
|
||||
IMPORTANT: If you are updating this tool be sure to check the new example configuration against your configuration, as some parameters may be added or removed or otherwise changed.
|
||||
|
||||
An example configuration file is found at example_config.toml. Copy this to config.toml and replace the fields with your information, and add channels as necessary.
|
||||
|
||||
The configuration file is found at config.toml. It allows you to configure the poll frequency for all YouTube channels, download directory for videos and metadata, whether to keep the videos after upload (for archiving purposes) as well as per channel options such as YouTube channel info, corresponding PeerTube channel info and auth, and appendable tags and descriptions.
|
||||
|
||||
If you set <use_pt_http_import> to "true", the bot will not download videos at all. It will simply pass the YT video URL to PeerTube directly. Because of this, if you choose to use this option, you will not be able to locally transcode videos, nor will you be able to archive them.
|
||||
|
||||
Each channel is capable of mirroring to a different PeerTube account and instance, and is capable of appending tags and description information on a per channel basis.
|
||||
|
||||
All videos and metadata are stored in <video_download_dir> as defined in the config, in a subdirectory with the same name as the channel <name> in the config, one directory per channel. All videos and metadata are named after the YouTube video ID. For each video, there should be 3 files: a video file, a thumbnail (jpg) and a text file containing metadata.
|
||||
|
||||
If <delete_videos> is set to True, videos and metadata will be deleted from the download directory after upload.
|
||||
|
||||
## Running the bot
|
||||
|
||||
To run the bot, simply run youtube2peertube.py. The bot will run indefinitely until stopped.
|
||||
|
||||
You will need to make sure all dependencies are met.
|
||||
|
||||
# YouTube2PeerTube
|
||||
|
||||
YouTube2PeerTube is a bot written in Python3 that mirrors YouTube channels to PeerTube channels as videos are released in a YouTube channel.
|
||||
|
||||
It checks YouTube channels periodically, when new videos are found, it mirrors them with metadata to PeerTube corresponding peertube channels.
|
||||
|
||||
This tool supports multiple channels, and supports mirroring each YouTube channel to a user defined PeerTube channel and instance that can be different for each YouTube channel being mirrored.
|
||||
|
|
Loading…
Reference in a new issue