Getting started
===============

Installation
------------

Two installation modes of the ``pyconverter-xml2py`` package are provided: user and developer.

User installation
^^^^^^^^^^^^^^^^^

Install the latest release for use with this command:

.. code:: bash

    python -m pip install pyconverter-xml2py


For developers
^^^^^^^^^^^^^^

Installing the ``pyconverter-xml2py`` package in developer mode allows you to modify the source and enhance it.
For contribution guidelines, see :ref:`Contribute <ref_contributing>`.


Post issues
-----------

Use the `PyConverter-XML2Py Issues <pyconverter.xml2py_issues_>`_ page to submit questions,
report bug, and request new features. When possible, use these issue templates:

* `Bug, problem, error <https://github.com/ansys/pyconverter-xml2py/issues/new?assignees=&labels=bug&projects=&template=bug.yml&title=Bug+located+in+...>`_:
  For filing a bug report
* `Documentation issue <https://github.com/ansys/pyconverter-xml2py/issues/new?assignees=&labels=documentation&projects=&template=documentation.yml&title=Modify+...>`_:
  For requesting modifications to the documentation
* `Adding an example <https://github.com/ansys/pyconverter-xml2py/issues/new?assignees=&labels=example&projects=&template=examples.yml&title=Example+proposal%3A+...>`_:
  For proposing a new example
* `New feature <https://github.com/ansys/pyconverter-xml2py/issues/new?assignees=&labels=enhancement&projects=&template=feature.yml&title=Add+...>`_:
  For requesting enhancements to the code


If your issue does not fit into one of these categories, create your own issue.

To reach the PyAnsys support team, email `pyansys.core@ansys.com <pyansys.core@ansys.com>`_.