0.2.0.0 (#22)

* remove old tests

Author: jsonzilla

.github/workflows/python-package.yml

@@ -5,36 +5,35 @@ name: Python package
 
 on:
  push:
- branches: [ master ]
+ branches: [master]
  pull_request:
- branches: [ master ]
+ branches: [master]
 
 jobs:
  build:
-
  runs-on: ubuntu-latest
  strategy:
  fail-fast: false
  matrix:
  python-version: ["3.8", "3.9", "3.10", "3.11"]
 
  steps:
- - uses: actions/checkout@v3
- - name: Set up Python ${{ matrix.python-version }}
- uses: actions/setup-python@v3
- with:
- python-version: ${{ matrix.python-version }}
- - name: Install dependencies
- run: |
- python -m pip install --upgrade pip
- python -m pip install flake8 pytest
- if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
- - name: Lint with flake8
- run: |
- # stop the build if there are Python syntax errors or undefined names
- flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
- # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
- flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
- - name: Test with pytest
- run: |
- pytest
+  - uses: actions/checkout@v3
+  - name: Set up Python ${{ matrix.python-version }}
+  uses: actions/setup-python@v3
+  with:
+  python-version: ${{ matrix.python-version }}
+  - name: Install dependencies
+  run: |
+  python -m pip install --upgrade pip
+  python -m pip install flake8 pytest
+  if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+  - name: Lint with flake8
+  run: |
+  # stop the build if there are Python syntax errors or undefined names
+  flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
+  # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
+  flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
+  - name: Test with pytest
+  run: |
+  pytest

README.md

@@ -1,6 +1,8 @@
-# vtt_to_srt.py
+# vtt_to_srt3
 Convert vtt files to srt subtitle format
 
+
+
 ## Note
 For Python 3.x [you can get version for Python 2.7 here](https://github.com/jansenicus/vtt-to-srt.py)
 
@@ -33,15 +35,36 @@ options:
 ## Usage as a lib
 
 Convert vtt file
-```shell
-from vtt_to_srt.vtt_to_srt import vtt_to_srt
-path = '/path/to/file.vtt'
-vtt_to_srt(path)
+```python
+from vtt_to_srt.vtt_to_srt import ConvertFile
+
+convert_file = ConvertFile("input_utf8.vtt", "utf-8")
+convert_file.convert()
 ```
 
 Recursively convert all vtt files in directory
+```python
+from vtt_to_srt.vtt_to_srt import ConvertDirectories
+
+recursive = False
+convert_file = ConvertDirectories(".", recursive, "utf-8")
+convert_file.convert()
+```
+
+## Manual build
+
+Generate wheel
 ```shell
-from vtt_to_srt.vtt_to_srt import vtt_to_srt
-path = '/path/to/directory'
-vtt_to_srt(path, rec = True)
+python -m pip install --upgrade setuptools wheel build
+python -m build
 ```
+
+## Generate documentation
+
+Generate documentation
+```shell
+python -m pip install pdoc3
+pdoc --html vtt_to_srt/vtt_to_srt.py -o docs
+mv docs/vtt_to_srt.html docs/index.html
+rm -rm docs/vtt_to_srt
+```