Skip to content

Open-source AI podcast clipper. Generate vertical clips with face tracking and burned-in captions. CLI, MCP server, web app.

Community health files, dependabot, and cross-platform CI (#78)

Nika Siradze8dc4395308ad
diff --git a/.editorconfig b/.editorconfig
new file mode 100644
index 0000000..585946c
--- /dev/null
+++ b/.editorconfig
@@ -0,0 +1,18 @@
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+indent_style = space
+indent_size = 2
+
+[*.py]
+indent_size = 4
+
+[*.md]
+trim_trailing_whitespace = false
+
+[Makefile]
+indent_style = tab
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml
new file mode 100644
index 0000000..a5a7900
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -0,0 +1,45 @@
+name: Bug report
+description: Something broke or behaved wrong.
+labels: ["bug"]
+body:
+ - type: markdown
+ attributes:
+ value: A clear repro gets it fixed faster. Thanks.
+ - type: input
+ id: version
+ attributes:
+ label: podcli version
+ description: Output of `podcli --version`.
+ placeholder: e.g. 2.4.5
+ validations:
+ required: true
+ - type: dropdown
+ id: os
+ attributes:
+ label: OS
+ options:
+ - macOS
+ - Windows
+ - Linux
+ validations:
+ required: true
+ - type: textarea
+ id: what
+ attributes:
+ label: What happened
+ description: What you did, what you expected, and what you got instead.
+ validations:
+ required: true
+ - type: textarea
+ id: repro
+ attributes:
+ label: Steps to reproduce
+ placeholder: |
+ 1. ...
+ 2. ...
+ - type: textarea
+ id: logs
+ attributes:
+ label: Logs or output
+ description: Paste any error output.
+ render: shell
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
new file mode 100644
index 0000000..163e080
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1,8 @@
+blank_issues_enabled: false
+contact_links:
+ - name: Docs
+ url: https://podcli.com/docs
+ about: Setup, CLI reference, and the studio guide.
+ - name: Report a security issue
+ url: https://github.com/nmbrthirteen/podcli/security/advisories/new
+ about: Please report vulnerabilities privately, not as a public issue.
diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml
new file mode 100644
index 0000000..a4a7dde
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/feature_request.yml
@@ -0,0 +1,21 @@
+name: Feature request
+description: Suggest something podcli should do.
+labels: ["enhancement"]
+body:
+ - type: textarea
+ id: problem
+ attributes:
+ label: The problem
+ description: What are you trying to do that podcli makes hard or can't do yet?
+ validations:
+ required: true
+ - type: textarea
+ id: idea
+ attributes:
+ label: What you'd like
+ description: How you picture it working.
+ - type: textarea
+ id: alternatives
+ attributes:
+ label: What you've tried
+ description: Workarounds or other tools you're using for this now.
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
new file mode 100644
index 0000000..93d3ec9
--- /dev/null
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,13 @@
+## What this does
+
+<!-- One or two lines. Link the issue it closes, e.g. Closes #123. -->
+
+## How I tested it
+
+<!-- What you ran to confirm it works. -->
+
+## Checklist
+
+- [ ] `npx tsc --noEmit` and `npm test` pass (plus `pytest tests/` if you touched the backend)
+- [ ] Docs updated if commands or behavior changed
+- [ ] No secrets, personal config, or generated output committed
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
new file mode 100644
index 0000000..66774bc
--- /dev/null
+++ b/.github/dependabot.yml
@@ -0,0 +1,16 @@
+version: 2
+updates:
+ - package-ecosystem: npm
+ directory: "/"
+ schedule:
+ interval: weekly
+ open-pull-requests-limit: 5
+ - package-ecosystem: pip
+ directory: "/backend"
+ schedule:
+ interval: weekly
+ open-pull-requests-limit: 5
+ - package-ecosystem: github-actions
+ directory: "/"
+ schedule:
+ interval: weekly
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
index e7babb6..e9ee2d4 100644
--- a/.github/workflows/ci.yml
+++ b/.github/workflows/ci.yml
@@ -9,7 +9,11 @@ on:
jobs:
typescript:
name: TypeScript build + typecheck
- runs-on: ubuntu-latest
+ runs-on: ${{ matrix.os }}
+ strategy:
+ fail-fast: false
+ matrix:
+ os: [ubuntu-latest, macos-latest, windows-latest]
steps:
- uses: actions/checkout@v4
- uses: actions/setup-node@v4
@@ -36,7 +40,11 @@ jobs:
python:
name: Python tests
- runs-on: ubuntu-latest
+ runs-on: ${{ matrix.os }}
+ strategy:
+ fail-fast: false
+ matrix:
+ os: [ubuntu-latest, macos-latest, windows-latest]
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
new file mode 100644
index 0000000..8246942
--- /dev/null
+++ b/CODE_OF_CONDUCT.md
@@ -0,0 +1,61 @@
+# Contributor Covenant Code of Conduct
+
+## Our pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our standards
+
+Examples of behavior that contributes to a positive environment:
+
+- Showing empathy and kindness toward other people.
+- Being respectful of differing opinions, viewpoints, and experiences.
+- Giving and gracefully accepting constructive feedback.
+- Accepting responsibility, apologizing to those affected by our mistakes, and
+ learning from the experience.
+- Focusing on what is best for the overall community.
+
+Examples of unacceptable behavior:
+
+- The use of sexualized language or imagery, and sexual attention or advances of
+ any kind.
+- Trolling, insulting or derogatory comments, and personal or political attacks.
+- Public or private harassment.
+- Publishing others' private information, such as a physical or email address,
+ without their explicit permission.
+- Other conduct which could reasonably be considered inappropriate in a
+ professional setting.
+
+## Enforcement responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the maintainer at [[email protected]](mailto:[email protected]).
+All complaints will be reviewed and investigated promptly and fairly. All
+community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org),
+version 2.1, available at
+https://www.contributor-covenant.org/version/2/1/code_of_conduct.html.
diff --git a/SECURITY.md b/SECURITY.md
new file mode 100644
index 0000000..6ad5203
--- /dev/null
+++ b/SECURITY.md
@@ -0,0 +1,27 @@
+# Security policy
+
+## Reporting
+
+Please don't open a public issue for a security problem.
+
+Report it privately through GitHub's [security advisory form](https://github.com/nmbrthirteen/podcli/security/advisories/new),
+or email me at [[email protected]](mailto:[email protected]) with "podcli
+security" in the subject.
+
+It helps if you include the version (`podcli --version`), your OS, what an
+attacker could do with it, and steps to reproduce.
+
+I'll reply within a few days. When a fix ships I'll credit you in the release
+notes, unless you'd rather I didn't.
+
+## Where to look
+
+podcli runs locally and keeps your media on your machine. The parts worth poking
+at: the local web UI and its HTTP endpoints, how it handles untrusted media and
+transcript files, the bundled binaries and the updater, and how API keys and
+config sit on disk.
+
+## Versions
+
+Fixes land on the latest release. Upgrade before reporting, since it might
+already be fixed.
diff --git a/backend/utils/prompt_files.py b/backend/utils/prompt_files.py
index 02d429f..e57ea7b 100644
--- a/backend/utils/prompt_files.py
+++ b/backend/utils/prompt_files.py
@@ -35,6 +35,7 @@ def write_prompt_file(prompt: str, suffix: str = ".txt") -> str:
"""
with tempfile.NamedTemporaryFile(
mode="w",
+ encoding="utf-8",
suffix=suffix,
delete=False,
dir=_tmp_dir(),
diff --git a/tests/test_ai_fallback.py b/tests/test_ai_fallback.py
index 968af0f..5282845 100644
--- a/tests/test_ai_fallback.py
+++ b/tests/test_ai_fallback.py
@@ -333,6 +333,7 @@ class AICliDiscoveryTests(unittest.TestCase):
found = cs._find_cli("claude", [os.path.join(tmp, "claude")])
self.assertEqual(found, shim)
+ @unittest.skipIf(os.name == "nt", "POSIX executable discovery; Windows uses .cmd/.exe shims")
def test_find_cli_uses_home_bin(self):
with tempfile.TemporaryDirectory() as home:
bin_dir = os.path.join(home, "bin")
@@ -345,6 +346,7 @@ class AICliDiscoveryTests(unittest.TestCase):
found = cs._find_cli("claude", [])
self.assertEqual(found, cli)
+ @unittest.skipIf(os.name == "nt", "POSIX executable discovery; Windows uses .cmd/.exe shims")
def test_npmrc_prefix_is_searched(self):
with tempfile.TemporaryDirectory() as home:
prefix = os.path.join(home, "npm-prefix")
diff --git a/tests/test_cli_output_dir.py b/tests/test_cli_output_dir.py
index 66f58b9..692b37e 100644
--- a/tests/test_cli_output_dir.py
+++ b/tests/test_cli_output_dir.py
@@ -22,7 +22,9 @@ class CliOutputDirTests(unittest.TestCase):
explicit_output_dir=None,
)
- self.assertEqual(output_dir, "/Users/nik/Downloads/clips/deeptech-show")
+ self.assertEqual(
+ output_dir, os.path.join("/Users/nik/Downloads", "clips", "deeptech-show")
+ )
def test_resolve_output_dir_uses_configured_root_with_preset_subfolder(self):
output_dir = cli_mod._resolve_output_dir(
@@ -32,7 +34,9 @@ class CliOutputDirTests(unittest.TestCase):
explicit_output_dir=None,
)
- self.assertEqual(output_dir, "/Users/nik/Downloads/renders/deeptech-show")
+ self.assertEqual(
+ output_dir, os.path.join("/Users/nik/Downloads/renders", "deeptech-show")
+ )
def test_resolve_output_dir_keeps_explicit_output_exact(self):
output_dir = cli_mod._resolve_output_dir(
diff --git a/tests/test_env_settings.py b/tests/test_env_settings.py
index dc72195..e5fb942 100644
--- a/tests/test_env_settings.py
+++ b/tests/test_env_settings.py
@@ -86,6 +86,7 @@ class EnvSettingsTests(unittest.TestCase):
with self.assertRaises(ValueError):
env_settings.set_setting("BOGUS_KEY", "x")
+ @unittest.skipIf(os.name == "nt", "Unix file modes are not enforced on Windows")
def test_mode_is_600(self):
env_settings.set_setting("HF_TOKEN", "hf_x")
self.assertEqual(oct(os.stat(self.env).st_mode & 0o777), "0o600")
diff --git a/tests/test_thumbnail_html.py b/tests/test_thumbnail_html.py
index fc0d82c..e6c43cc 100644
--- a/tests/test_thumbnail_html.py
+++ b/tests/test_thumbnail_html.py
@@ -36,6 +36,7 @@ class ThumbnailHtmlTests(unittest.TestCase):
self.assertLessEqual(len(line2), 24)
self.assertNotIn("EVERYONE", f"{line1} {line2}")
+ @unittest.skipIf(os.name == "nt", "POSIX node paths; Windows node discovery differs")
def test_build_remotion_screenshot_command(self):
script_suffix = os.path.join("backend", "scripts", "remotion_screenshot.cjs")
renderer_suffix = os.path.join("node_modules", "@remotion", "renderer", "package.json")
@@ -67,6 +68,7 @@ class ThumbnailHtmlTests(unittest.TestCase):
],
)
+ @unittest.skipIf(os.name == "nt", "POSIX binary paths; Windows playwright discovery differs")
def test_playwright_cli_candidates_prefers_local_then_global_then_npx(self):
local_suffix = os.path.join("node_modules", ".bin", "playwright")