Package (#69)

* move tests
* add description
* add license
* add pyproject
* remove requirements.txt and replace by pyproject.toml
* add CLI command
* update pipe

.github/workflows/ci.yml

@@ -24,10 +24,10 @@ jobs:
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
-        python -m pip install -r requirements-dev.txt
+        python -m pip install .[test]
         
     - name: Unittests
       run: |
-        pytest unittests -v --disable-pytest-warnings
+        pytest tests/unittests -v
 
 

LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 ANSYS, Inc. All rights reserved.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

README.md

@@ -31,7 +31,7 @@ Current framework has the following features:
 ## Installation
 To install the package use:
 ```bash
-pip install
+pip install .
 ```
 
 ## Usage

aedttest/__init__.py

@@ -0,0 +1,8 @@
+"""
+Ansys Electronics Desktop Testing Framework.
+Current module allows to setup and run automated tests and validate results across multiple versions of
+Ansys Electronics Desktop products, eg HFSS, Maxwell, Icepak, Q3D, etc
+"""
+
+__version__ = "0.0.1"
+__authors__ = "Maksim Beliaev, Bo Yang"

aedttest/aedt_test_runner.py

@@ -31,7 +31,6 @@
 
 from pyaedt import __file__ as _py_aedt_path  # noreorder
 
-__authors__ = "Maksim Beliaev, Bo Yang"
 
 MODULE_DIR = Path(__file__).resolve().parent
 CWD_DIR = Path.cwd()
@@ -50,6 +49,33 @@
 PROJECT_PAGE_TEMPLATE = get_template("static/project-report.html")
 
 
+def main() -> None:
+    """
+    Main function that is executed by 'flit' CLI script and by executing this python file
+    Returns:
+        None
+    """
+    try:
+        cli_args = parse_arguments()
+    except ValueError as exc:
+        logger.error(str(exc))
+        raise SystemExit(1)
+    aedt_tester = ElectronicsDesktopTester(
+        version=cli_args.aedt_version,
+        max_cores=cli_args.max_cores,
+        max_tasks=cli_args.max_tasks,
+        config_file=cli_args.config_file,
+        out_dir=cli_args.out_dir,
+        save_projects=cli_args.save_sim_data,
+        only_reference=cli_args.only_reference,
+        reference_file=cli_args.reference_file,
+    )
+    try:
+        aedt_tester.run()
+    except Exception as exc:
+        logger.exception(str(exc))
+
+
 class ElectronicsDesktopTester:
     def __init__(
         self,
@@ -668,24 +694,4 @@ def parse_arguments() -> argparse.Namespace:
 
 
 if __name__ == "__main__":
-    try:
-        args_cli = parse_arguments()
-    except ValueError as exc:
-        logger.error(str(exc))
-        raise SystemExit(1)
-
-    aedt_tester = ElectronicsDesktopTester(
-        version=args_cli.aedt_version,
-        max_cores=args_cli.max_cores,
-        max_tasks=args_cli.max_tasks,
-        config_file=args_cli.config_file,
-        out_dir=args_cli.out_dir,
-        save_projects=args_cli.save_sim_data,
-        only_reference=args_cli.only_reference,
-        reference_file=args_cli.reference_file,
-    )
-
-    try:
-        aedt_tester.run()
-    except Exception as exc:
-        logger.exception(str(exc))
+    main()

docs/CONTRIBUTE.md

@@ -10,7 +10,7 @@
 ## Configure your enviornment
 Install all dependencies
 ```bash
-pip install -r requirements-dev.txt
+pip install .[test]
 ```
 
 Install pre-commit
@@ -20,5 +20,5 @@ pre-commit install
 
 ## Validate types
 ```bash
-mypy --config-file=./mypy.ini unittests\test_aedttest.py
+mypy --config-file=./mypy.ini tests
 ```

pyproject.toml

@@ -0,0 +1,44 @@
+# description if packaging system requirements
+[build-system]
+requires = [
+    "flit_core >=3.2,<4",
+]
+build-backend = "flit_core.buildapi"
+
+# desciption of current module
+[project]
+name = "aedttest"
+authors = [
+    {name = "Maksim Beliaev", email = "[email protected]"},
+    {name = "Bo Yang", email = "[email protected]"},
+]
+readme = "README.md"
+requires-python = ">=3.7"
+classifiers = ["License :: OSI Approved :: MIT License"]
+dynamic = ["version", "description"]
+
+dependencies = [
+    "pyaedt==0.4.7",
+    "Django==3.2.8",
+]
+
+# development dependencies
+[project.optional-dependencies]
+test = [
+    "black==21.9b0",
+    "pre-commit==2.15.0",
+    "mypy==0.910",
+    "pytest==6.2.5",
+    "pytest-cov==3.0.0",
+]
+
+deploy = [
+    "flit==3.4.0",
+]
+
+[project.urls]
+Home = "https://github.com/ansys/aedt-testing"
+
+# CLI script command
+[project.scripts]
+aedt_test_runner = "aedttest.aedt_test_runner:main"