From 3a709aa4d69c9d460a26cffec5d87f5bb18c41dc Mon Sep 17 00:00:00 2001 From: Augusto Gunsch Date: Sun, 21 Nov 2021 13:45:50 -0300 Subject: [PATCH] Update external API --- README.md | 9 +++++++++ src/fsub/__init__.py | 2 +- 2 files changed, 10 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index ce5efe3..e19b7cf 100644 --- a/README.md +++ b/README.md @@ -55,6 +55,15 @@ python -m unittest tests.unit python -m unittest tests.integration ``` +# Scripted API +An example of calling the program from Python: +``` +import fsub + +# Pass the arguments here +fsub.run(['-c', 'test.srt']) +``` + # Features - Fixes subtitle numbering - Converts files to UTF-8 encoding diff --git a/src/fsub/__init__.py b/src/fsub/__init__.py index 6b60bcf..a59b82e 100644 --- a/src/fsub/__init__.py +++ b/src/fsub/__init__.py @@ -1,4 +1,4 @@ -import fsub +import fsub.fsub as fsub # External interface