Index: DamClients/DamPythonInterface/src/README.rst =================================================================== diff -u --- DamClients/DamPythonInterface/src/README.rst (revision 0) +++ DamClients/DamPythonInterface/src/README.rst (revision 3468) @@ -0,0 +1 @@ \ No newline at end of file Index: DamClients/DamPythonInterface/src/pyproject.toml =================================================================== diff -u --- DamClients/DamPythonInterface/src/pyproject.toml (revision 0) +++ DamClients/DamPythonInterface/src/pyproject.toml (revision 3468) @@ -0,0 +1,14 @@ +[tool.poetry] +name = "dampythoninterface" +version = "0.1.0" +description = "Python API that creates DAM xml file." +authors = ["EleniSmyrniou "] + +[tool.poetry.dependencies] +python = "^3.8" + +[tool.poetry.dev-dependencies] + +[build-system] +requires = ["poetry-core>=1.0.0"] +build-backend = "poetry.core.masonry.api" Index: DamClients/DamPythonInterface/src/tests/test_dampythonframework.py =================================================================== diff -u --- DamClients/DamPythonInterface/src/tests/test_dampythonframework.py (revision 0) +++ DamClients/DamPythonInterface/src/tests/test_dampythonframework.py (revision 3468) @@ -0,0 +1,7 @@ +from dampythoninterface import __version__ + +import pytest + +@pytest.mark.acceptance +def test_version(): + assert __version__ == "0.1.0" Index: DamClients/DamPythonInterface/src/tests/__init__.py =================================================================== diff -u --- DamClients/DamPythonInterface/src/tests/__init__.py (revision 0) +++ DamClients/DamPythonInterface/src/tests/__init__.py (revision 3468) @@ -0,0 +1 @@ \ No newline at end of file Index: DamClients/DamPythonInterface/src/dampythoninterface/__init__.py =================================================================== diff -u --- DamClients/DamPythonInterface/src/dampythoninterface/__init__.py (revision 0) +++ DamClients/DamPythonInterface/src/dampythoninterface/__init__.py (revision 3468) @@ -0,0 +1 @@ +__version__ = "0.1.0" \ No newline at end of file Index: DamClients/DamPythonInterface/docs/Makefile =================================================================== diff -u --- DamClients/DamPythonInterface/docs/Makefile (revision 0) +++ DamClients/DamPythonInterface/docs/Makefile (revision 3468) @@ -0,0 +1,20 @@ +# Minimal makefile for Sphinx documentation +# + +# You can set these variables from the command line, and also +# from the environment for the first two. +SPHINXOPTS ?= +SPHINXBUILD ?= sphinx-build +SOURCEDIR = source +BUILDDIR = build + +# Put it first so that "make" without argument is like "make help". +help: + @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + +.PHONY: help Makefile + +# Catch-all target: route all unknown targets to Sphinx using the new +# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). +%: Makefile + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) Index: DamClients/DamPythonInterface/docs/make.bat =================================================================== diff -u --- DamClients/DamPythonInterface/docs/make.bat (revision 0) +++ DamClients/DamPythonInterface/docs/make.bat (revision 3468) @@ -0,0 +1,35 @@ +@ECHO OFF + +pushd %~dp0 + +REM Command file for Sphinx documentation + +if "%SPHINXBUILD%" == "" ( + set SPHINXBUILD=sphinx-build +) +set SOURCEDIR=source +set BUILDDIR=build + +if "%1" == "" goto help + +%SPHINXBUILD% >NUL 2>NUL +if errorlevel 9009 ( + echo. + echo.The 'sphinx-build' command was not found. Make sure you have Sphinx + echo.installed, then set the SPHINXBUILD environment variable to point + echo.to the full path of the 'sphinx-build' executable. Alternatively you + echo.may add the Sphinx directory to PATH. + echo. + echo.If you don't have Sphinx installed, grab it from + echo.http://sphinx-doc.org/ + exit /b 1 +) + +%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% +goto end + +:help +%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% + +:end +popd Index: DamClients/DamPythonInterface/docs/source/index.rst =================================================================== diff -u --- DamClients/DamPythonInterface/docs/source/index.rst (revision 0) +++ DamClients/DamPythonInterface/docs/source/index.rst (revision 3468) @@ -0,0 +1,20 @@ +.. DamPythonInterface documentation master file, created by + sphinx-quickstart on Mon Sep 13 15:34:22 2021. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Welcome to DamPythonInterface's documentation! +============================================== + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` Index: DamClients/DamPythonInterface/docs/source/conf.py =================================================================== diff -u --- DamClients/DamPythonInterface/docs/source/conf.py (revision 0) +++ DamClients/DamPythonInterface/docs/source/conf.py (revision 3468) @@ -0,0 +1,62 @@ +# Configuration file for the Sphinx documentation builder. +# +# This file only contains a selection of the most common options. For a full +# list see the documentation: +# https://www.sphinx-doc.org/en/master/usage/configuration.html + +# -- Path setup -------------------------------------------------------------- + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +# +# import os +# import sys +# sys.path.insert(0, os.path.abspath('.')) + + +# -- Project information ----------------------------------------------------- + +project = 'DamPythonInterface' +copyright = '2021, Eleni Smyrniou' +author = 'Eleni Smyrniou' + +# The full version, including alpha/beta/rc tags +release = '0.1.0' + + +# -- General configuration --------------------------------------------------- + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = [ +] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# +# This is also used if you do content translation via gettext catalogs. +# Usually you set "language" from the command line for these cases. +language = '[en]' + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +# This pattern also affects html_static_path and html_extra_path. +exclude_patterns = [] + + +# -- Options for HTML output ------------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +# +html_theme = 'alabaster' + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['_static'] \ No newline at end of file Index: DamClients/DamPythonInterface/src/tests/utils.py =================================================================== diff -u --- DamClients/DamPythonInterface/src/tests/utils.py (revision 0) +++ DamClients/DamPythonInterface/src/tests/utils.py (revision 3468) @@ -0,0 +1,112 @@ +import os +import sys +from pathlib import Path +from typing import List + +import pytest +from teamcity import is_running_under_teamcity + +try: + from pip import main as pipmain +except: + from pip._internal import main as pipmain + +only_teamcity = pytest.mark.skipif( + not (is_running_under_teamcity() or "FORCE_TEAMCITY" in os.environ), + reason="Console test only installed on TC.", +) + + +class TestUtils: + + _name_external = "external_test_data" + _name_local = "test_data" + _name_output = "test_output" + + @staticmethod + def install_package(package: str): + """Installs a package that is normally only used + by a test configuration. + + Arguments: + package {str} -- Name of the PIP package. + """ + pipmain(["install", package]) + + @staticmethod + def get_test_files_from_local_test_dir( + dir_name: str, glob_filter: str + ) -> List[Path]: + """Returns all the files that need to be used as test input parameters from a given directory. + + Args: + dir_name (str): Name of the local test data directory. + glob_filter (str): Filter that will be applied with the glob function. + + Returns: + List[Path]: List of files matching the above criteria. + """ + return [ + input_file + for input_file in Path(TestUtils.get_local_test_data_dir(dir_name)).glob( + glob_filter + ) + if input_file.is_file() + ] + + @staticmethod + def get_output_test_data_dir(dir_name: str): + """ + Returns the full path of a directory containing generated + data from the tests. If it does not exist it creates it. + """ + directory = TestUtils.get_test_data_dir(dir_name, TestUtils._name_output) + if not os.path.exists(directory): + os.makedirs(directory) + return directory + + @staticmethod + def get_local_test_data_dir(dir_name: str): + """ + Returns the desired directory relative to the test data. + Avoiding extra code on the tests. + """ + directory = TestUtils.get_test_data_dir(dir_name, TestUtils._name_local) + return directory + + @staticmethod + def get_external_test_data_dir(dir_name: str): + """ + Returns the desired directory relative to the test external data. + Avoiding extra code on the tests. + """ + directory = TestUtils.get_test_data_dir(dir_name, TestUtils._name_external) + return directory + + @staticmethod + def get_test_data_dir(dir_name: str, test_data_name: str): + """ + Returns the desired directory relative to the test external data. + Avoiding extra code on the tests. + """ + test_dir = os.path.dirname(__file__) + try: + dir_path = os.path.join(test_data_name, dir_name) + test_dir = os.path.join(test_dir, dir_path) + except: + print("An error occurred trying to find {}".format(dir_name)) + return test_dir + + @staticmethod + def get_test_dir(dir_name: str): + """Returns the desired directory inside the Tests folder + + Arguments: + dir_name {str} -- Target directory. + + Returns: + {str} -- Path to the target directory. + """ + test_dir = os.path.dirname(__file__) + dir_path = os.path.join(test_dir, dir_name) + return dir_path