axisvm

PyAxisVM - The official python package for AxisVM

Latest Release
License

Overview

The PyAxisVM project offers a high-level interface to AxisVM, making its operations available directly from Python. It builds on top of Microsoft's COM technology and supports all the features of the original AxisVM COM type library, making you able to

• build, manipulate and analyse AxisVM models

• find better solutions with iterative methods

• combine the power of AxisVM with third-party Python libraries

• build extension modules

On top of that, PyAxisVM enhances the type library with Python's slicing mechanism, context management and more, that enables writing clean, concise, and readable code.

Installation

This is optional, but we suggest you to create a dedicated virtual enviroment at all times to avoid conflicts with your other projects. Create a folder, open a command shell in that folder and use the following command

>>> python -m venv venv_name

Once the enviroment is created, activate it via typing

>>> .\venv_name\Scripts\activate

The AxisVM python package can be installed (either in a virtual enviroment or globally) from PyPI using pip on Python >= 3.7 <= 3.10:

>>> pip install axisvm

or chechkout with the following command over HTTPS via https://github.com/AxisVM/pyaxisvm.git or by using the GitHub CLI

gh repo clone AxisVM/pyaxisvm

and install from source by typing

>>> pip install .

If you want to run the tests, you can install the package along with the necessary optional dependencies like this

>>> pip install ".[test]"

Development mode

If you are a developer and want to install the library in development mode, the suggested way is by using this command:

>>> pip install "-e .[test, dev]"

If you plan to touch the docs, you can install the requirements for that as well:

>>> pip install "-e .[test, dev, docs]"

Documentation and Issues

The AxisVM API Reference Guide is available in pdf format, you can download it here.

The documentation of this library is available here.

Please feel free to post issues and other questions at PyAxisVM Issues. This is the best place to post questions and code related to issues with this project. If you are not familiar with GitHub, you can also reach out to us through the usual channels, but if you are, GitHub is preferred.

Dependencies

You will need a local licenced copy of AxisVM version >= 13r2. To get a copy of AxisVM, please visit our homepage.

License

PyAxisVM is licensed under the MIT license.

This module, PyAxisVM makes no commercial claim over AxisVM whatsoever. This tool extends the functionality of AxisVM by adding a Python interface to the AxisVM COM service without changing the core behavior or license of the original software. The use of PyAxisVM requires a legally licensed local copy of AxisVM.