yogiliu / podmaker

Convert online media into podcast feeds.

Podmaker

Read this document in other languages: English, 简体中文

Convert online media into podcast feeds.

Features

• Extract audio from online videos.
• No need to deploy web services.
• Generate podcast feeds.
• Deploy with watch mode to keep feeds up-to-date.

Dependencies

This tool uses ffmpeg to extract audio from videos. Ensure it's installed within $PATH before using this tool.

Additionally, you should install extra dependencies according to your requirements:

• podmaker[all]: Install all extra dependencies.
• podmaker[s3]: Install dependencies for S3 storage.
• podmaker[youtube]: Install dependencies for YouTube.

Install multiple extra dependencies simultaneously using podmaker[extra1,extra2,...].

Configuration

Before diving into this tool, craft a configuration file, a TOML file to be precise. By default, the file resides at ${WORK_DIR}/config.toml. Customize the path using the -c or --config option. An example configuration file can be found at config.example.toml.

Usage

Systemd

Deploy this tool in the background with systemd (requires root privileges):

# create virtual environment
apt install python3 python3-venv
mkdir -p /opt/podmaker && cd /opt/podmaker
python3 -m venv venv

# install podmaker
./venv/bin/pip install "podmaker[all]"

# create and edit config file
curl -o config.toml https://raw.githubusercontent.com/YogiLiu/podmaker/main/config.example.toml
vim config.toml

# create systemd service
curl -o /etc/systemd/system/podmaker.service https://raw.githubusercontent.com/YogiLiu/podmaker/main/systemd/podmaker.service
systemctl daemon-reload

# enable and start service
systemctl enable podmaker
systemctl start podmaker

Manual

Using pip

For the optimal experience, we recommend installing this tool within a virtual environment.

pip install "podmaker[all]"

Using pipx

pipx install "podmaker[all]"

Run

podmaker -c path/to/config.toml

or

python -m podmaker -c path/to/config.toml

Roadmap

Platforms

• YouTube
  • Playlist
  • Channel
• BiliBili

Resource Hosting

• S3
• Local

Contributing

Your contributions are invaluable. Feel free to submit pull requests. Before committing, ensure your changes pass unit tests and autohooks.

To activate autohooks, use the following command:

poetry run autohooks activate --mode poetry

This process will automatically lint, format, and sort code imports.

When introducing new features, remember to provide corresponding tests.

License

For licensing details, refer to LICENSE.

podmaker's Issues

Move execution to Task class, and support task hook

podmaker/podmaker/processor/core.py

Lines 32 to 51 in a228237

	def _execute(self, source: SourceConfig) -> None:
	logger.info(f'execute: {source.id}')
	try:
	key = source.get_storage_key('feed.rss')
	task = self._get_task(source)
	with ThreadPoolExecutor() as executor:
	original_f = executor.submit(self._fetch_original, key)
	new_f = executor.submit(task.start)
	original = original_f.result() # type: Podcast | None
	new = new_f.result()
	if original:
	has_changed = original.merge(new)
	else:
	has_changed = True
	original = new
	if has_changed:
	buf = BytesIO(original.bytes)
	self._storage.put(buf, key, content_type='application/rss+xml')
	except Exception as e:
	logger.error(f'{source.id}: {e}')

Meanwhile, implement before_hook and after_hook for task object.

Stylesheet for xml file.

Detail: https://www.w3.org/TR/xslt-30/

如何 部署，谢谢，然后如何运行。

RT；有没有详细的过程或者文档啊