rewrote dependencies downloader

Author: mbdevpl

.travis.yml

@@ -82,7 +82,7 @@ install:
   - pip install -U pip
   - pip install -U -r dev_requirements.txt
   # Java
-  - python open_fortran_parser/dev_dependencies.py
+  - python -m open_fortran_parser --dev-deps
   - export CLASSPATH="${CLASSPATH}:$(pwd)/lib/*"
   - ant
   - export CLASSPATH="${CLASSPATH}:$(pwd)/dist/*"

README.rst

@@ -84,7 +84,8 @@ Get dependencies, either manually, or using the provided script:
 
 .. code:: bash
 
-    python3 open_fortran_parser/dev_dependencies.py
+    pip3 install -U -r requirements.txt
+    python3 -m open_fortran_parser --dev-deps
     export CLASSPATH="${CLASSPATH}:$(pwd)/lib/*"
 
 Build:
@@ -217,52 +218,78 @@ Python version >= 3.6.
 
 Python libraries as specified in `<requirements.txt>`_.
 
-Building and running tests additionally requires packages listed in `<dev_requirements.txt>`_.
+Building and running tests additionally requires packages listed in `<test_requirements.txt>`_.
 
 
 how to build
 ------------
 
 .. code:: bash
 
-    pip3 install -U -r dev_requirements.txt
+    pip3 install -U -r test_requirements.txt
     python3 setup.py sdist --formats=gztar,zip
     python3 setup.py bdist_wheel
 
+how to install
+--------------
+
+You can simply install from PyPI:
+
+.. code:: bash
+
+    pip3 install open_fortran parser
+
+Or using any of below commands, when installing from source:
+
+.. code:: bash
+
+    pip3 install .
+    pip3 install dist/<filename>.whl
+    pip3 install dist/<filename>.tar.gz
+    pip3 install dist/<filename>.zip
+
 
 how to run
 ----------
 
 The wrapper can be used as a script, or as a library.
 
-Before running, however, please make sure that dependencies are configured correctly.
-You can do that by either following the "how to build" section for Java implementation above,
-or by executing this:
+When running any installed version, even if installed from source, dependencies are automatically
+installed together with the wrapper.
+
+Before running from source (without installation), however, please follow "how to build" section
+for Java implementation above.
+You can make sure that dependencies are configured correctly by running:
 
 .. code:: bash
 
-    python3 open_fortran_parser/dependencies.py
-    export CLASSPATH="${CLASSPATH}:$(pwd)/lib/*"
+    python3 -m open_fortran_parser --deps
+
 
 as script
 ~~~~~~~~~
 
 .. code:: bash
 
     $ python3 -m open_fortran_parser -h
-    usage: open_fortran_parser [-h] [-v VERBOSITY] input [output]
+    usage: open_fortran_parser [-h] [--version] [-v VERBOSITY]
+                               [--get-dependencies]
+                               [input] [output]
 
-    Python wrapper around XML generator for Open Fortran Parser 0.8.4
+    Python wrapper around XML generator for Open Fortran Parser
 
     positional arguments:
-      input                 path to Fortran source code file
+      input                 path to Fortran source code file (default: None)
       output                writable path for where to store resulting XML,
                             defaults to stdout if no path provided (default: None)
 
     optional arguments:
       -h, --help            show this help message and exit
+      --version             show program's version number and exit
       -v VERBOSITY, --verbosity VERBOSITY
                             level of verbosity, from 0 to 100 (default: 100)
+      --get-dependencies, --deps
+                            download dependencies and exit (default: False)
 
     Copyright 2017 Mateusz Bysiek https://mbdevpl.github.io/, Apache License 2.0
 
@@ -285,6 +312,6 @@ testing
     python3 -m pylint --load-plugins=pylint.extensions.mccabe --docstring-min-length 5 \
       --no-docstring-rgx "^(test)?_|.*Tests$" --unsafe-load-any-extension y \
       --output-format colorized  --reports y $(find . -name "*.py")
-    python3 -m coverage run --branch -m unittest discover --verbose
+    python3 -m coverage run --branch --source . -m unittest discover --verbose
     python3 -m coverage report --show-missing
     python3 -m coverage html

appveyor.yml

@@ -38,7 +38,7 @@ install:
   - pip install -U pip
   - pip install -U -r dev_requirements.txt
   # Java
-  - python open_fortran_parser\\dev_dependencies.py
+  - python -m open_fortran_parser --dev-deps
   - set CLASSPATH=%cd%\\lib\\*;%CLASSPATH%
   - ant
   - set CLASSPATH=%cd%\\dist\\*;%CLASSPATH%

open_fortran_parser/config.py

@@ -2,9 +2,11 @@
 
 import pathlib
 
+from .dependencies import DEPENDENCIES_PATH
+
 JAVA = {
     'executable': pathlib.Path('java'),
-    'classpath': None,
+    'classpath': pathlib.Path(DEPENDENCIES_PATH, '*'),
     'options': None,
     'ofp_class': 'fortran.ofp.FrontEnd',
     'ofp_xml_class': 'fortran.ofp.XMLPrinter'}

open_fortran_parser/dependencies.py

@@ -2,25 +2,76 @@
 
 """Dependency downloader for open_fortran_parser."""
 
+import logging
+import os
 import pathlib
+import platform
+import typing as t
 import urllib
 
-if __name__ == '__main__':
-    try:
-        from .dev_dependencies import DEV_DEPENDENCIES, ensure_dependencies
-    except ImportError:
-        from dev_dependencies import DEV_DEPENDENCIES, ensure_dependencies
-else:
-    from .dev_dependencies import DEV_DEPENDENCIES, ensure_dependencies
+import wget
+
+try:
+    from ._version import VERSION
+except SystemError:
+    from _version import VERSION
+
+_LOG = logging.getLogger(__name__)
+
+DEV_DEPENDENCIES = {
+    'ANTLR 3.3': (
+        urllib.parse.urlparse(
+            'https://github.com/mbdevpl/open-fortran-parser/releases/download/v0.8.4-1/'),
+        pathlib.Path('antlr-3.3-complete.jar')),
+    'Open Fortran Parser 0.8.4-2': (
+        urllib.parse.urlparse(
+            'https://github.com/mbdevpl/open-fortran-parser/releases/download/v0.8.4-2/'),
+        pathlib.Path('OpenFortranParser-0.8.4-2.jar')),
+    'Apache Commons CLI 1.4': (
+        urllib.parse.urlparse(
+            'https://github.com/mbdevpl/open-fortran-parser-xml/releases/download/v0.1.0/'),
+        pathlib.Path('commons-cli-1.4.jar'))}
+
+DEV_DEPENDENCIES_PATH = pathlib.Path(os.getcwd(), 'lib')
 
 DEPENDENCIES = DEV_DEPENDENCIES.copy()
 
 DEPENDENCIES.update({
-    'Open Fortran Parser XML 0.2.0': (
+    'Open Fortran Parser XML {}'.format(VERSION): (
         urllib.parse.urlparse(
-            'https://github.com/mbdevpl/open-fortran-parser-xml/releases/download/v0.2.0/'),
-        pathlib.Path('OpenFortranParserXML-0.2.0.jar'))})
+            'https://github.com/mbdevpl/open-fortran-parser-xml/releases/download/v{}/'
+            .format(VERSION)),
+        pathlib.Path('OpenFortranParserXML-{}.jar'.format(VERSION)))})
+
+DEPENDENCIES_PATH = pathlib.Path(__file__).resolve().parent
+
+OUTDATED_DEPENDENCIES = {
+    'Open Fortran Parser 0.8.4-1': pathlib.Path('OpenFortranParser-0.8.4-2.jar')}
+
 
+def ensure_dependencies(
+        dependencies: t.Mapping[str, t.Tuple[urllib.parse.ParseResult, pathlib.Path]],
+        target_dir: pathlib.Path, silent: bool = False) -> None:
+    """Download missing depenedencies."""
+    if not target_dir.exists():
+        _LOG.warning('Creating directory "%s"...', target_dir)
+        os.makedirs(str(target_dir), exist_ok=True)
+    for dependency, (url_root, filename) in dependencies.items():
+        path = target_dir.joinpath(filename)
+        if path.is_file():
+            _LOG.warning('%s is present already.', dependency)
+            continue
+        url = urllib.parse.urlunparse(url_root) + str(filename)
+        _LOG.warning('Downloading %s from URL "%s" to path "%s"...', dependency, url, path)
+        wget.download(url, str(path), bar=None if silent else wget.bar_adaptive)
+        if not silent:
+            print()
+    if not silent:
+        classpath = target_dir.joinpath('*')
+        _LOG.warning('If you wish to use the Open Fortran Parser XML generator directly,'
+                     ' please add "%s" to your Java classpath:', classpath)
+        if platform.system() != 'Windows':
+            _LOG.warning('export CLASSPATH="${CLASSPATH}:%s"', classpath)
 
 if __name__ == '__main__':
-    ensure_dependencies(DEPENDENCIES)
+    ensure_dependencies(DEPENDENCIES, DEPENDENCIES_PATH)

open_fortran_parser/dev_dependencies.py

@@ -3,8 +3,12 @@
 import argparse
 import logging
 import pathlib
+import sys
 
+from ._version import VERSION
 from .parser_wrapper import execute_parser
+from .dependencies import \
+    DEV_DEPENDENCIES, DEV_DEPENDENCIES_PATH, DEPENDENCIES, DEPENDENCIES_PATH, ensure_dependencies
 
 logging.basicConfig()
 
@@ -15,20 +19,42 @@ def main(args=None, namespace=None):
     """Launch Open Fortran Parser."""
     parser = argparse.ArgumentParser(
         prog='open_fortran_parser',
-        description='''Python wrapper around XML generator for Open Fortran Parser 0.8.4''',
+        description='''Python wrapper around XML generator for Open Fortran Parser''',
         epilog='''Copyright 2017 Mateusz Bysiek https://mbdevpl.github.io/, Apache License 2.0''',
         formatter_class=argparse.ArgumentDefaultsHelpFormatter)
 
-    parser.add_argument('input', type=pathlib.Path, help='''path to Fortran source code file''')
+    parser.version = VERSION
+    parser.add_argument('--version', action='version')
+
+    parser.add_argument(
+        'input', nargs='?', type=pathlib.Path, help='''path to Fortran source code file''')
     parser.add_argument(
         'output', nargs='?', type=pathlib.Path, default=None,
         help='''writable path for where to store resulting XML, defaults to stdout
             if no path provided''')
     parser.add_argument(
         '-v', '--verbosity', type=int, default=100, help='''level of verbosity, from 0 to 100''')
+    parser.add_argument(
+        '--get-dependencies', '--deps', action='store_true',
+        help='''download dependencies and exit''')
+    parser.add_argument(
+        '--get-development-dependencies', '--dev-deps', action='store_true',
+        help=argparse.SUPPRESS)
 
     args = parser.parse_args(args, namespace)
 
+    if args.get_development_dependencies:
+        ensure_dependencies(DEV_DEPENDENCIES, DEV_DEPENDENCIES_PATH)
+        return
+
+    if args.get_dependencies:
+        ensure_dependencies(DEPENDENCIES, DEPENDENCIES_PATH)
+        return
+
+    if not args.input:
+        parser.print_help(sys.stderr)
+        parser.exit(2)
+
     process = execute_parser(args.input, args.output, args.verbosity)
     if process.stderr:
         _LOG.warning(process.stderr.decode().rstrip())