PyMaterials Manager
===================
|pyansys| |python| |pypi| |GH-CI| |codecov| |MIT| |black|
.. |pyansys| image:: https://img.shields.io/badge/Py-Ansys-ffc107.svg?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/badge/Python-%3E%3D3.10-blue
:target: https://pypi.org/project/pymaterials-manager/
:alt: Python
.. |pypi| image:: https://img.shields.io/pypi/v/ansys-materials-manager.svg?logo=python&logoColor=white
:target: https://pypi.org/project/ansys-materials-manager
:alt: PyPI
.. |codecov| image:: https://codecov.io/gh/pyansys/pymaterials-manager/branch/main/graph/badge.svg
:target: https://codecov.io/gh/pyansys/pymaterials-manager
:alt: Codecov
.. |GH-CI| image:: https://github.com/pyansys/pymaterials-manager/actions/workflows/ci_cd.yml/badge.svg
:target: https://github.com/pyansys/pymaterials-manager/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
PyMaterials Manager is a Python package for unifying material management across the Ansys portfolio.
Installation
------------
Two installation modes are provided: user and developer.
Install in user mode
^^^^^^^^^^^^^^^^^^^^
Before installing the ``ansys-materials-manager`` package, run this command to
ensure that you have the latest version of `pip`_:
.. code:: bash
python -m pip install -U pip
Then, install the latest package for use with this command:
.. code:: bash
poetry run python -m pip install ansys-materials-manager
Install in development mode
^^^^^^^^^^^^^^^^^^^^^^^^^^^
Installing the ``ansys-materials-manager`` package in developer mode allows
you to modify the source and enhance it.
Before contributing to PyMaterials Manager, see the `PyAnsys Developer's Guide`_.
To install PyMaterials Manager in developer mode, perform these steps:
#. Cloning the repository:
.. code:: bash
git clone https://github.com/pyansys/pymaterials-manager
#. Create a fresh-clean Python environment and activate it:
.. code:: bash
# Create a virtual environment
python -m venv .venv
# Activate it in a POSIX system
source .venv/bin/activate
# Activate it in Windows CMD environment
.venv\Scripts\activate.bat
# Activate it in Windows Powershell
.venv\Scripts\Activate.ps1
#. Make sure that you have the latest required build system and doc, testing,
and CI tools:
.. code:: bash
python -m pip install -U pip poetry tox
python -m pip install -r requirements/requirements_build.txt
python -m pip install -r requirements/requirements_doc.txt
python -m pip install -r requirements/requirements_tests.txt
#. Install the project in editable mode:
.. code:: bash
poetry run python -m pip install ansys-materials-manager
#. Verify your development installation:
.. code:: bash
tox
Testing
-------
This project takes advantage of `tox`_. This tool is used to automate common
development tasks (similar to Makefile), but it is oriented towards Python
development.
Use ``tox``
^^^^^^^^^^^
`tox`_ uses environments, which are similar to ``Makefile`` rules, to make it highly
customizable. In fact, this tool creates its own virtual environment so that anything
being tested is isolated from the project to guarantee the project's integrity.
Descriptions follow of some of the most widely used environments:
- **tox -e style**: Checks the code style of your project.
- **tox -e py**: Runs your test suite.
- **tox -e py-coverage**: Checks unit tests and code coverage.
- **tox -e doc**: Builds the documentation of your project.
Perform raw testing
^^^^^^^^^^^^^^^^^^^
If required, you can call style commands (such as `black`_, `isort`_,
and `flake8`_) or unit testing commands (such as `pytest`_) from the command
line. However, calling these commands does not guarantee that your project
is being tested in an isolated environment, which is the reason why tools
like `tox`_ exist.
Use pre-commit
^^^^^^^^^^^^^^
The style checks take advantage of `pre-commit`_. Developers are not forced but
encouraged to install this tool by running this command:
.. code:: bash
python -m pip install pre-commit && pre-commit install
Every time you stage some changes and try to commit them,
``pre-commit`` only allows them to be committed if all defined hooks succeed.
Documentation and issues
------------------------
For comprehensive information on PyMaterials Manager, see the latest release `documentation`_.
On the `PyMaterials Manager Issues`_ page, you can create issues to submit questions,
report bugs, and request new features. This is the best place to post questions and code.
Distribution
------------
If you want to create either source or wheel files, start by installing
the building requirements and then executing the build module:
.. code:: bash
python -m pip install -r requirements/requirements_build.txt
python -m build
python -m twine check dist/*
.. LINKS AND REFERENCES
.. _black: https://github.com/psf/black
.. _flake8: https://flake8.pycqa.org/en/latest/
.. _isort: https://github.com/PyCQA/isort
.. _pip: https://pypi.org/project/pip/
.. _pre-commit: https://pre-commit.com/
.. _PyAnsys Developer's Guide: https://dev.docs.pyansys.com/
.. _pytest: https://docs.pytest.org/en/stable/
.. _Sphinx: https://www.sphinx-doc.org/en/master/
.. _tox: https://tox.wiki/
.. _PyMaterials Manager Issues: https://github.com/pyansys/pymaterials-manager/issues
.. _documentation: https://manager.materials.docs.pyansys.com/
Raw data
{
"_id": null,
"home_page": "https://github.com/pyansys/pymaterials-manager",
"name": "ansys-materials-manager",
"maintainer": "PyAnsys developers",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "pyansys.core@ansys.com",
"keywords": "",
"author": "ANSYS, Inc.",
"author_email": "ansys.support@ansys.com",
"download_url": "https://files.pythonhosted.org/packages/5d/24/2ab58c8e825565bb5ba2c7d5f52b2d5786531c0fee83880ba900160f1d4d/ansys_materials_manager-0.2.3.tar.gz",
"platform": null,
"description": "PyMaterials Manager\n===================\n|pyansys| |python| |pypi| |GH-CI| |codecov| |MIT| |black|\n\n.. |pyansys| image:: https://img.shields.io/badge/Py-Ansys-ffc107.svg?logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAIAAACQkWg2AAABDklEQVQ4jWNgoDfg5mD8vE7q/3bpVyskbW0sMRUwofHD7Dh5OBkZGBgW7/3W2tZpa2tLQEOyOzeEsfumlK2tbVpaGj4N6jIs1lpsDAwMJ278sveMY2BgCA0NFRISwqkhyQ1q/Nyd3zg4OBgYGNjZ2ePi4rB5loGBhZnhxTLJ/9ulv26Q4uVk1NXV/f///////69du4Zdg78lx//t0v+3S88rFISInD59GqIH2esIJ8G9O2/XVwhjzpw5EAam1xkkBJn/bJX+v1365hxxuCAfH9+3b9/+////48cPuNehNsS7cDEzMTAwMMzb+Q2u4dOnT2vWrMHu9ZtzxP9vl/69RVpCkBlZ3N7enoDXBwEAAA+YYitOilMVAAAAAElFTkSuQmCC\n :target: https://docs.pyansys.com/\n :alt: PyAnsys\n\n.. |python| image:: https://img.shields.io/badge/Python-%3E%3D3.10-blue\n :target: https://pypi.org/project/pymaterials-manager/\n :alt: Python\n\n.. |pypi| image:: https://img.shields.io/pypi/v/ansys-materials-manager.svg?logo=python&logoColor=white\n :target: https://pypi.org/project/ansys-materials-manager\n :alt: PyPI\n\n.. |codecov| image:: https://codecov.io/gh/pyansys/pymaterials-manager/branch/main/graph/badge.svg\n :target: https://codecov.io/gh/pyansys/pymaterials-manager\n :alt: Codecov\n\n.. |GH-CI| image:: https://github.com/pyansys/pymaterials-manager/actions/workflows/ci_cd.yml/badge.svg\n :target: https://github.com/pyansys/pymaterials-manager/actions/workflows/ci_cd.yml\n :alt: GH-CI\n\n.. |MIT| image:: https://img.shields.io/badge/License-MIT-yellow.svg\n :target: https://opensource.org/licenses/MIT\n :alt: MIT\n\n.. |black| image:: https://img.shields.io/badge/code%20style-black-000000.svg?style=flat\n :target: https://github.com/psf/black\n :alt: Black\n\n\nPyMaterials Manager is a Python package for unifying material management across the Ansys portfolio.\n\n\nInstallation\n------------\n\nTwo installation modes are provided: user and developer.\n\nInstall in user mode\n^^^^^^^^^^^^^^^^^^^^\n\nBefore installing the ``ansys-materials-manager`` package, run this command to\nensure that you have the latest version of `pip`_:\n\n.. code:: bash\n\n python -m pip install -U pip\n\nThen, install the latest package for use with this command:\n\n.. code:: bash\n\n poetry run python -m pip install ansys-materials-manager\n \nInstall in development mode\n^^^^^^^^^^^^^^^^^^^^^^^^^^^\n\nInstalling the ``ansys-materials-manager`` package in developer mode allows\nyou to modify the source and enhance it.\n\nBefore contributing to PyMaterials Manager, see the `PyAnsys Developer's Guide`_.\n\nTo install PyMaterials Manager in developer mode, perform these steps:\n\n#. Cloning the repository:\n\n .. code:: bash\n\n git clone https://github.com/pyansys/pymaterials-manager\n\n#. Create a fresh-clean Python environment and activate it:\n\n .. code:: bash\n\n # Create a virtual environment\n python -m venv .venv\n\n # Activate it in a POSIX system\n source .venv/bin/activate\n\n # Activate it in Windows CMD environment\n .venv\\Scripts\\activate.bat\n\n # Activate it in Windows Powershell\n .venv\\Scripts\\Activate.ps1\n\n#. Make sure that you have the latest required build system and doc, testing,\n and CI tools:\n\n .. code:: bash\n\n python -m pip install -U pip poetry tox\n python -m pip install -r requirements/requirements_build.txt\n python -m pip install -r requirements/requirements_doc.txt\n python -m pip install -r requirements/requirements_tests.txt\n\n\n#. Install the project in editable mode:\n\n .. code:: bash\n \n poetry run python -m pip install ansys-materials-manager\n \n#. Verify your development installation:\n\n .. code:: bash\n \n tox\n\nTesting\n-------\n\nThis project takes advantage of `tox`_. This tool is used to automate common\ndevelopment tasks (similar to Makefile), but it is oriented towards Python\ndevelopment. \n\nUse ``tox``\n^^^^^^^^^^^\n\n`tox`_ uses environments, which are similar to ``Makefile`` rules, to make it highly\ncustomizable. In fact, this tool creates its own virtual environment so that anything\nbeing tested is isolated from the project to guarantee the project's integrity.\n\nDescriptions follow of some of the most widely used environments:\n\n- **tox -e style**: Checks the code style of your project.\n- **tox -e py**: Runs your test suite.\n- **tox -e py-coverage**: Checks unit tests and code coverage.\n- **tox -e doc**: Builds the documentation of your project.\n\n\nPerform raw testing\n^^^^^^^^^^^^^^^^^^^\n\nIf required, you can call style commands (such as `black`_, `isort`_,\nand `flake8`_) or unit testing commands (such as `pytest`_) from the command\nline. However, calling these commands does not guarantee that your project\nis being tested in an isolated environment, which is the reason why tools\nlike `tox`_ exist.\n\n\nUse pre-commit\n^^^^^^^^^^^^^^\n\nThe style checks take advantage of `pre-commit`_. Developers are not forced but\nencouraged to install this tool by running this command:\n\n.. code:: bash\n\n python -m pip install pre-commit && pre-commit install\n\nEvery time you stage some changes and try to commit them,\n``pre-commit`` only allows them to be committed if all defined hooks succeed.\n\nDocumentation and issues\n------------------------\n\nFor comprehensive information on PyMaterials Manager, see the latest release `documentation`_.\nOn the `PyMaterials Manager Issues`_ page, you can create issues to submit questions,\nreport bugs, and request new features. This is the best place to post questions and code.\n\nDistribution\n------------\n\nIf you want to create either source or wheel files, start by installing\nthe building requirements and then executing the build module:\n\n.. code:: bash\n\n python -m pip install -r requirements/requirements_build.txt\n python -m build\n python -m twine check dist/*\n\n\n.. LINKS AND REFERENCES\n.. _black: https://github.com/psf/black\n.. _flake8: https://flake8.pycqa.org/en/latest/\n.. _isort: https://github.com/PyCQA/isort\n.. _pip: https://pypi.org/project/pip/\n.. _pre-commit: https://pre-commit.com/\n.. _PyAnsys Developer's Guide: https://dev.docs.pyansys.com/\n.. _pytest: https://docs.pytest.org/en/stable/\n.. _Sphinx: https://www.sphinx-doc.org/en/master/\n.. _tox: https://tox.wiki/\n.. _PyMaterials Manager Issues: https://github.com/pyansys/pymaterials-manager/issues\n.. _documentation: https://manager.materials.docs.pyansys.com/\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Python package to unify material management across the ansys portfolio",
"version": "0.2.3",
"project_urls": {
"Documentation": "https://manager.materials.docs.pyansys.com",
"Homepage": "https://github.com/pyansys/pymaterials-manager",
"Repository": "https://github.com/pyansys/pymaterials-manager"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "7016eb9e2677e4dec6f8fea08406d9e3bda389f9e9b2341f9bbbf0a76d6ab0ee",
"md5": "4bb088332dc641958651cd6d0d5c5a3a",
"sha256": "3210b9126654eb49e66023b9e2ac0e498003105dacd304370de576186ccb7de0"
},
"downloads": -1,
"filename": "ansys_materials_manager-0.2.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4bb088332dc641958651cd6d0d5c5a3a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 36400,
"upload_time": "2023-05-03T15:35:09",
"upload_time_iso_8601": "2023-05-03T15:35:09.150772Z",
"url": "https://files.pythonhosted.org/packages/70/16/eb9e2677e4dec6f8fea08406d9e3bda389f9e9b2341f9bbbf0a76d6ab0ee/ansys_materials_manager-0.2.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5d242ab58c8e825565bb5ba2c7d5f52b2d5786531c0fee83880ba900160f1d4d",
"md5": "699e1d8b1ea0be5d8911963b9ce4358d",
"sha256": "2bebda492a32b01b69b205157110a1ddba61d5e3d33c0ad6d1c4e730f2bd2fad"
},
"downloads": -1,
"filename": "ansys_materials_manager-0.2.3.tar.gz",
"has_sig": false,
"md5_digest": "699e1d8b1ea0be5d8911963b9ce4358d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 25534,
"upload_time": "2023-05-03T15:35:12",
"upload_time_iso_8601": "2023-05-03T15:35:12.183940Z",
"url": "https://files.pythonhosted.org/packages/5d/24/2ab58c8e825565bb5ba2c7d5f52b2d5786531c0fee83880ba900160f1d4d/ansys_materials_manager-0.2.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-05-03 15:35:12",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "pyansys",
"github_project": "pymaterials-manager",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "ansys-materials-manager"
}
JSON
