Parse srt file content into well-formed structures
Project description
Installation from pip3
pip3 install --verbose subtitlecore
python -m spacy download en_core_web_trf
python -m spacy download es_dep_news_trf
Usage
Please refer to api docs.
Excutable usage
- Get subtitle content
subtitlecore_content --srtfile test.srt --lang en
- Parse srtfile into sentences with timestamp
subtitlecore_parse2sens --srtfile test.srt --lang en
- Parse srtfile into plain text
subtitlecore_parse2text --srtfile test.srt --lang en
Package usage
from subtitlecore import Subtitle
def get_subtitle_content(srtfile, lang):
st = Subtitle(srtfile, lang)
for line_info in st.content:
print(line_info)
def parse2sens(srtfile, lang):
st = Subtitle(srtfile, lang)
content_sens = st.sentenize()
for e in content_sens:
print(e)
def parse2text(srtfile, lang):
st = Subtitle(srtfile, lang)
text = st.plaintext()
print(text)
Development
Clone project
git clone https://github.com/qishe-nlp/subtitlecore.git
Install poetry
Install dependencies
poetry update
Test
poetry run pytest -rP
which run tests under tests/*
Execute
poetry run subtitlecore_content --help
poetry run subtitlecore_parse2sens --help
poetry run subtitlecore_parse2text --help
Create sphinx docs
poetry shell
cd apidocs
sphinx-apidoc -f -o source ../subtitlecore
make html
python -m http.server -d build/html
Host docs on github pages
cp -rf apidocs/build/html/* docs/
Build
- Change
version
inpyproject.toml
andsubtitlecore/__init__.py
- Build python package by
poetry build
Git commit and push
Publish from local dev env
- Set pypi test environment variables in poetry, refer to poetry doc
- Publish to pypi test by
poetry publish -r test
Publish through CI
- Github action build and publish package to test pypi repo
git tag [x.x.x]
git push origin master
- Manually publish to pypi repo through github action
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
subtitlecore-0.1.12.tar.gz
(3.8 kB
view hashes)
Built Distribution
Close
Hashes for subtitlecore-0.1.12-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | fb24e8dadd43341a320aeb8e242fb787f029a692a79c5797f6cdcbd3aa578c0d |
|
MD5 | a52da20f832ab66512c4ebe1620ae3b1 |
|
BLAKE2b-256 | 16f3308e2565886c520d4af427ebe761cfbfd4152d47f6509385669101a03cf1 |