ansys-grantami-jobqueue 1.0.0rc0__tar.gz

ansys_grantami_jobqueue-1.0.0rc0/AUTHORS

@@ -0,0 +1,12 @@
+# This is the list of PyGranta JobQueue's significant contributors.
+#
+# This file does not necessarily list everyone who has contributed code.
+#
+# For contributions made under a Corporate CLA, the organization is
+# added to this file.
+#
+# If you have contributed to the repository and wish to be added to this file
+# please submit a request.
+#
+#
+ANSYS, Inc.

ansys_grantami_jobqueue-1.0.0rc0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 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.

ansys_grantami_jobqueue-1.0.0rc0/PKG-INFO

@@ -0,0 +1,119 @@
+Metadata-Version: 2.1
+Name: ansys-grantami-jobqueue
+Version: 1.0.0rc0
+Summary: A python wrapper for the Granta MI Job Queue API
+Home-page: https://github.com/ansys/grantami-jobqueue
+License: MIT
+Author: ANSYS, Inc.
+Author-email: pyansys.core@ansys.com
+Maintainer: ANSYS, Inc.
+Maintainer-email: pyansys.core@ansys.com
+Requires-Python: >=3.9,<4.0
+Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Dist: ansys-grantami-serverapi-openapi (==3.0.0)
+Requires-Dist: ansys-openapi-common (>=2.0.0,<3.0.0)
+Project-URL: Documentation, https://jobqueue.grantami.docs.pyansys.com
+Project-URL: Repository, https://github.com/ansys/grantami-jobqueue
+Description-Content-Type: text/x-rst
+
+|pyansys| |python| |pypi| |GH-CI| |codecov| |MIT| |black|
+
+.. |pyansys| image:: https://img.shields.io/badge/Py-Ansys-ffc107.svg?labelColor=black&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAIAAACQkWg2AAABDklEQVQ4jWNgoDfg5mD8vE7q/3bpVyskbW0sMRUwofHD7Dh5OBkZGBgW7/3W2tZpa2tLQEOyOzeEsfumlK2tbVpaGj4N6jIs1lpsDAwMJ278sveMY2BgCA0NFRISwqkhyQ1q/Nyd3zg4OBgYGNjZ2ePi4rB5loGBhZnhxTLJ/9ulv26Q4uVk1NXV/f///////69du4Zdg78lx//t0v+3S88rFISInD59GqIH2esIJ8G9O2/XVwhjzpw5EAam1xkkBJn/bJX+v1365hxxuCAfH9+3b9/+////48cPuNehNsS7cDEzMTAwMMzb+Q2u4dOnT2vWrMHu9ZtzxP9vl/69RVpCkBlZ3N7enoDXBwEAAA+YYitOilMVAAAAAElFTkSuQmCC
+   :target: https://docs.pyansys.com/
+   :alt: PyAnsys
+
+.. |python| image:: https://img.shields.io/pypi/pyversions/ansys-grantami-jobqueue?logo=pypi
+   :target: https://pypi.org/project/ansys-grantami-jobqueue/
+   :alt: Python
+
+.. |pypi| image:: https://img.shields.io/pypi/v/ansys-grantami-jobqueue.svg?logo=python&logoColor=white
+   :target: https://pypi.org/project/ansys-grantami-jobqueue
+   :alt: PyPI
+
+.. |codecov| image:: https://codecov.io/gh/ansys/grantami-jobqueue/branch/main/graph/badge.svg
+   :target: https://codecov.io/gh/ansys/grantami-jobqueue
+   :alt: Codecov
+
+.. |GH-CI| image:: https://github.com/ansys/grantami-jobqueue/actions/workflows/ci_cd.yml/badge.svg
+   :target: https://github.com/ansys/grantami-jobqueue/actions/workflows/ci_cd.yml
+   :alt: GH-CI
+
+.. |MIT| image:: https://img.shields.io/badge/License-MIT-yellow.svg
+   :target: https://opensource.org/licenses/MIT
+   :alt: MIT
+
+.. |black| image:: https://img.shields.io/badge/code%20style-black-000000.svg?style=flat
+   :target: https://github.com/psf/black
+   :alt: Black
+
+
+PyGranta JobQueue
+=================
+
+..
+   _after-badges
+
+
+PyGranta JobQueue allows you to import and export correctly formatted Excel and text files to and from
+Granta MI.
+
+
+Dependencies
+------------
+.. readme_software_requirements
+
+To use PyGranta JobQueue, you must have access to a Granta MI 2024 R2 deployment.
+
+The ``ansys.grantami.jobqueue`` package currently supports Python version 3.9 through 3.12.
+
+.. readme_software_requirements_end
+
+
+
+Installation
+------------
+.. readme_installation
+
+To install the latest PyGranta JobQueue release from `PyPI <https://pypi.org/project/ansys-grantami-jobqueue/>`_,
+run this command:
+
+.. code::
+
+    pip install ansys-grantami-jobqueue
+
+To install a release compatible with a specific version of Granta MI, install the
+`PyGranta <https://grantami.docs.pyansys.com/>`_ metapackage with a requirement specifier:
+
+.. code::
+
+    pip install pygranta==2024.2.0
+
+Alternatively, to install the latest release from the `PyGranta JobQueue repository <https://github.com/ansys/grantami-jobqueue>`_,
+run this command:
+
+.. code::
+
+    pip install git:https://github.com/ansys/grantami-jobqueue.git
+
+
+To install a local *development* version with Git and Poetry, run these commands:
+
+.. code::
+
+    git clone https://github.com/ansys/grantami-jobqueue
+    cd grantami-jobqueue
+    poetry install
+
+
+The preceding commands install the package in development mode so that you can modify
+it locally. Your changes are reflected in your Python setup after restarting the Python kernel.
+
+.. readme_installation_end
+

ansys_grantami_jobqueue-1.0.0rc0/README.rst

@@ -0,0 +1,93 @@
+|pyansys| |python| |pypi| |GH-CI| |codecov| |MIT| |black|
+
+.. |pyansys| image:: https://img.shields.io/badge/Py-Ansys-ffc107.svg?labelColor=black&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAIAAACQkWg2AAABDklEQVQ4jWNgoDfg5mD8vE7q/3bpVyskbW0sMRUwofHD7Dh5OBkZGBgW7/3W2tZpa2tLQEOyOzeEsfumlK2tbVpaGj4N6jIs1lpsDAwMJ278sveMY2BgCA0NFRISwqkhyQ1q/Nyd3zg4OBgYGNjZ2ePi4rB5loGBhZnhxTLJ/9ulv26Q4uVk1NXV/f///////69du4Zdg78lx//t0v+3S88rFISInD59GqIH2esIJ8G9O2/XVwhjzpw5EAam1xkkBJn/bJX+v1365hxxuCAfH9+3b9/+////48cPuNehNsS7cDEzMTAwMMzb+Q2u4dOnT2vWrMHu9ZtzxP9vl/69RVpCkBlZ3N7enoDXBwEAAA+YYitOilMVAAAAAElFTkSuQmCC
+   :target: https://docs.pyansys.com/
+   :alt: PyAnsys
+
+.. |python| image:: https://img.shields.io/pypi/pyversions/ansys-grantami-jobqueue?logo=pypi
+   :target: https://pypi.org/project/ansys-grantami-jobqueue/
+   :alt: Python
+
+.. |pypi| image:: https://img.shields.io/pypi/v/ansys-grantami-jobqueue.svg?logo=python&logoColor=white
+   :target: https://pypi.org/project/ansys-grantami-jobqueue
+   :alt: PyPI
+
+.. |codecov| image:: https://codecov.io/gh/ansys/grantami-jobqueue/branch/main/graph/badge.svg
+   :target: https://codecov.io/gh/ansys/grantami-jobqueue
+   :alt: Codecov
+
+.. |GH-CI| image:: https://github.com/ansys/grantami-jobqueue/actions/workflows/ci_cd.yml/badge.svg
+   :target: https://github.com/ansys/grantami-jobqueue/actions/workflows/ci_cd.yml
+   :alt: GH-CI
+
+.. |MIT| image:: https://img.shields.io/badge/License-MIT-yellow.svg
+   :target: https://opensource.org/licenses/MIT
+   :alt: MIT
+
+.. |black| image:: https://img.shields.io/badge/code%20style-black-000000.svg?style=flat
+   :target: https://github.com/psf/black
+   :alt: Black
+
+
+PyGranta JobQueue
+=================
+
+..
+   _after-badges
+
+
+PyGranta JobQueue allows you to import and export correctly formatted Excel and text files to and from
+Granta MI.
+
+
+Dependencies
+------------
+.. readme_software_requirements
+
+To use PyGranta JobQueue, you must have access to a Granta MI 2024 R2 deployment.
+
+The ``ansys.grantami.jobqueue`` package currently supports Python version 3.9 through 3.12.
+
+.. readme_software_requirements_end
+
+
+
+Installation
+------------
+.. readme_installation
+
+To install the latest PyGranta JobQueue release from `PyPI <https://pypi.org/project/ansys-grantami-jobqueue/>`_,
+run this command:
+
+.. code::
+
+    pip install ansys-grantami-jobqueue
+
+To install a release compatible with a specific version of Granta MI, install the
+`PyGranta <https://grantami.docs.pyansys.com/>`_ metapackage with a requirement specifier:
+
+.. code::
+
+    pip install pygranta==2024.2.0
+
+Alternatively, to install the latest release from the `PyGranta JobQueue repository <https://github.com/ansys/grantami-jobqueue>`_,
+run this command:
+
+.. code::
+
+    pip install git:https://github.com/ansys/grantami-jobqueue.git
+
+
+To install a local *development* version with Git and Poetry, run these commands:
+
+.. code::
+
+    git clone https://github.com/ansys/grantami-jobqueue
+    cd grantami-jobqueue
+    poetry install
+
+
+The preceding commands install the package in development mode so that you can modify
+it locally. Your changes are reflected in your Python setup after restarting the Python kernel.
+
+.. readme_installation_end

ansys_grantami_jobqueue-1.0.0rc0/pyproject.toml

@@ -0,0 +1,123 @@
+[build-system]
+requires = ["poetry-core>=1.0.0"]
+build-backend = "poetry.core.masonry.api"
+
+[tool.poetry]
+# Check https://python-poetry.org/docs/pyproject/ for all available sections
+name = "ansys-grantami-jobqueue"
+version = "1.0.0rc0"
+description = "A python wrapper for the Granta MI Job Queue API"
+license = "MIT"
+authors = ["ANSYS, Inc. <pyansys.core@ansys.com>"]
+maintainers = ["ANSYS, Inc. <pyansys.core@ansys.com>"]
+readme = "README.rst"
+repository = "https://github.com/ansys/grantami-jobqueue"
+documentation = "https://jobqueue.grantami.docs.pyansys.com"
+classifiers = [
+    "Development Status :: 2 - Pre-Alpha",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+]
+packages = [
+    { include = "ansys", from = "src" },
+]
+
+[tool.poetry.dependencies]
+python = ">=3.9,<4.0"
+ansys-openapi-common = "^2.0.0"
+ansys-grantami-serverapi-openapi = "3.0.0"
+
+# Optional documentation dependencies
+[tool.poetry.group.doc]
+optional = true
+
+[tool.poetry.group.doc.dependencies]
+sphinx = "^7.0.1"
+numpydoc = "^1.4.0"
+ansys-sphinx-theme = "^0.15.0"
+sphinx-copybutton = "^0.5.0"
+jupytext = "^1.14.4"
+nbsphinx = "^0.9.0"
+ipykernel = "^6.21.2" # required by nbsphinx to run notebooks.
+sphinx-jinja = "^2.0.2"
+enum-tools = "^0.12.0"
+sphinx-toolbox = "^3.5.0"
+sphinx-design = "^0.5.0"
+sphinx-autoapi = "^3.1.0a2"
+sphinxcontrib-napoleon = "^0.7.0"
+
+[tool.poetry.group.dev.dependencies]
+pytest = "^8.0.2"
+pytest-cov = "^5.0.0"
+requests-mock = "^1.10.0"
+pre-commit = "^3.2.2"
+mypy = "^1.8.0"
+
+[tool.black]
+line-length = 100
+
+[tool.isort]
+profile = "black"
+force_sort_within_sections = true
+line_length = 100
+default_section = "THIRDPARTY"
+src_paths = ["doc", "src", "tests"]
+
+[tool.coverage.run]
+source = ["ansys.grantami"]
+
+[tool.coverage.report]
+show_missing = true
+
+[tool.pytest.ini_options]
+filterwarnings = "error"
+markers = [
+    """integration: test requires a real database (deselect with '-m \"not integration\"')"""
+]
+
+[tool.pydocstyle]
+convention = "numpy"
+
+[tool.mypy]
+strict = true
+warn_return_any = true
+warn_unused_configs = true
+warn_redundant_casts = true
+warn_unused_ignores = true
+disallow_untyped_defs = true
+no_implicit_optional = true
+check_untyped_defs = true
+show_error_codes = true
+files = "src"
+explicit_package_bases = true
+mypy_path = "$MYPY_CONFIG_FILE_DIR/src"
+namespace_packages = true
+
+[tool.numpydoc_validation]
+checks = [
+    "all",   # report on all checks, except the below
+    "EX01",
+    "SA01",
+    "ES01",
+]
+
+override_PR02 = [  # numpydoc_validation doesn't support dataclasses
+    'Provides a read\-only configuration of the job queue on the server',  # JobQueueProcessingConfiguration
+    'Defines a record to include in an export job',  # ExportRecord
+]
+
+override_PR01 = [  # User does not need to instantiate these objects and parameter types are not local to this package
+    'Represents a job on the server',  # AsyncJob
+    'Communicates with Granta MI'  # JobQueueApiClient
+]
+
+exclude = [  # don't report on objects that match any of these regexes
+    '\.__repr__$',
+    '\.__new__$',
+    '\.__init__$',
+]

ansys_grantami_jobqueue-1.0.0rc0/src/ansys/grantami/jobqueue/__init__.py

@@ -0,0 +1,53 @@
+# Copyright (C) 2024 ANSYS, Inc. and/or its affiliates.
+# SPDX-License-Identifier: MIT
+#
+#
+# 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.
+
+"""Python client for Granta MI Server API Job Queue."""
+
+import importlib.metadata as importlib_metadata
+
+from ._connection import Connection, JobQueueApiClient
+from ._models import (
+    AsyncJob,
+    ExcelExportJobRequest,
+    ExcelImportJobRequest,
+    ExportRecord,
+    JobQueueProcessingConfiguration,
+    JobRequest,
+    JobStatus,
+    JobType,
+    TextImportJobRequest,
+)
+
+__all__ = [
+    "AsyncJob",
+    "Connection",
+    "ExcelExportJobRequest",
+    "ExcelImportJobRequest",
+    "ExportRecord",
+    "JobQueueApiClient",
+    "JobQueueProcessingConfiguration",
+    "JobRequest",
+    "JobStatus",
+    "JobType",
+    "TextImportJobRequest",
+]
+__version__ = importlib_metadata.version(__name__.replace(".", "-"))