Description
Batch summarize YouTube video comments using artificial intelligence (OpenAI, …).
Documentation
Documentation is available on https://dashstrom.github.io/youcomsum
Installation
You can install youcomsum using uv
from PyPI
pip install uv
uv tool install youcomsumUsage
Before use youcomsum, you must set your OPENAI_API_KEY following the Best Practices for API Key Safety.
youcomsum -v 'http://youtu.be/dQw4w9WgXcQ'Usage as module
from youcomsum import YouComSum
youcomsum = YouComSum()
text: str = youcomsum.summarize("http://youtu.be/dQw4w9WgXcQ")
print(text)Development
Contributing
Contributions are very welcome. Tests can be run with poe check, please
ensure the coverage at least stays the same before you submit a pull request.
Setup
You need to install Poetry and Git for work with this project.
git clone https://github.com/Dashstrom/youcomsum
cd youcomsum
poetry install --all-extras
poetry run poe setup
poetry shellPoe
Poe is available for help you to run tasks.
test Run test suite.
lint Run linters: ruff checker and ruff formatter and mypy.
format Run linters in fix mode.
check Run all checks: lint, test and docs.
check-tag Check if the current tag match the version.
cov Run coverage for generate report and html.
open-cov Open html coverage report in webbrowser.
docs Build documentation.
open-docs Open documentation in webbrowser.
setup Setup pre-commit.
pre-commit Run pre-commit.
commit Test, commit and push.
clean Clean cache files.Skip commit verification
If the linting is not successful, you can’t commit. For forcing the commit you can use the next command :
git commit --no-verify -m 'MESSAGE'Commit with commitizen
To respect commit conventions, this repository uses Commitizen.
cz cHow to add dependency
poetry add 'PACKAGE'Ignore illegitimate warnings
To ignore illegitimate warnings you can add :
# noqa: ERROR_CODE on the same line for ruff.
# type: ignore[ERROR_CODE] on the same line for mypy.
# pragma: no cover on the same line to ignore line for coverage.
# doctest: +SKIP on the same line for doctest.
Uninstall
pipx uninstall youcomsumLicense
This work is licensed under MIT.
1 maintainer
Metadata
1 maintainer
Release files for youcomsum 0.0.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| youcomsum-0.0.1.tar.gz | 12.3 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| youcomsum-0.0.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 22.9 kB
Release files / youcomsum-0.0.1.tar.gz
| Download URL | youcomsum-0.0.1.tar.gz |
|---|---|
| Size | 12.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
e95918f5a625b55dfd297f86bd6cab378b3d9332c38546fbc82607fe52a3a5e0
|
|
BLAKE2b-256 checksum How to use checksums |
d4233e033df117a6d8aa27a824fccf31d9f5435b389a91093b6289894a3d85f2
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.12.9
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Mar 22, 2025.
Transparency logRelease files / youcomsum-0.0.1-py3-none-any.whl
| Download URL | youcomsum-0.0.1-py3-none-any.whl |
|---|---|
| Size | 10.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
040b7dbf14837240d19c04cc907ea8fe3df64932faa91b43881e42a1f8f1c369
|
|
BLAKE2b-256 checksum How to use checksums |
b3ef0a560d50639fc54961b7ed2e5a20d347d5ed373749783c32de0e0be60ee9
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.12.9
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Mar 22, 2025.
Transparency log
