fix: web service instructions don't work (#40)

- moved web service into the inscriptis package.
- adjusted documentation and Dockerfile accordingly.

Author: AlbertWeichselbraun

Dockerfile

@@ -9,7 +9,6 @@ RUN pip install --no-cache-dir -r requirements.txt
 RUN pip install --no-cache-dir Flask
 RUN python setup.py install
 
-# RUN export FLASK_APP="web-service.py"
-# CMD ["python3", "-m", "flask", "run"]
+RUN export FLASK_APP="inscriptis.service.web"
+CMD ["python3", "-m", "flask", "run"]
 EXPOSE 5000
-CMD ["python3", "scripts/web-service.py"]

README.rst

@@ -57,7 +57,7 @@ Statement of need - why inscriptis?
 
    Conversion quality becomes a factor once you need to move beyond simple HTML snippets. Non-specialized approaches and less sophisticated libraries do not correctly interpret HTML semantics and, therefore, fail to properly convert constructs such as itemizations, enumerations, and tables.
 
-   Beautiful Soup's `get_text()` function, for example, converts the following HTML enumeration to the string `firstsecond`.
+   Beautiful Soup's `get_text()` function, for example, converts the following HTML enumeration to the string ``firstsecond``.
 
    .. code-block:: HTML
 
@@ -150,7 +150,7 @@ The inscript.py command line client supports the following parameters::
     -l, --display-link-targets
                           Display link targets (default:false).
     -a, --display-anchor-urls
-                          Display anchor urls (default:false).
+                          Display anchor URLs (default:false).
     -r ANNOTATION_RULES, --annotation-rules ANNOTATION_RULES
                           Path to an optional JSON file containing rules for annotating the retrieved text.
     -p POSTPROCESSOR, --postprocessor POSTPROCESSOR
@@ -310,7 +310,7 @@ Startup
 -------
 Start the inscriptis Web service with the following command::
 
-  $ export FLASK_APP="web-service.py"
+  $ export FLASK_APP="inscriptis.service.web"
   $ python3 -m flask run
 
 Usage

scripts/inscript.py

@@ -55,7 +55,7 @@ def get_parser():
                         help='Display link targets (default:false).')
     parser.add_argument('-a', '--display-anchor-urls',
                         action='store_true', default=False,
-                        help='Display anchor urls (default:false).')
+                        help='Display anchor URLs (default:false).')
     parser.add_argument('-r', '--annotation-rules', default=None,
                         help='Path to an optional JSON file containing rules '
                              'for annotating the retrieved text.')