Skip to main content

A python wrapper for the Granta MI RecordLists API

Project description

PyAnsys Python PyPI GH-CI Codecov MIT Black

PyGranta RecordLists

A Python wrapper for the Granta MI Lists API.

To avoid ambiguity with the Python object list, lists available via the Granta MI Lists API are referred to as record lists. Granta MI users might also know the feature as Favorites Lists.

Using the Granta MI Lists API requires the user to have necessary permissions on the Granta MI Server. Some operations on record lists require additional permissions, specific to record lists. For more information, see the Help for the Favorites app in Granta MI.


To use the ansys.grantami.recordlists package you must have access to a Granta MI 2023 R2 deployment.

The ansys.grantami.recordlists package currently supports Python from version 3.9 to version 3.12.


To install the latest release from PyPI, use this code:

pip install ansys-grantami-recordlists

To install a release compatible with a specific version of Granta MI, use the PyGranta meta-package with a requirement specifier:

pip install pygranta==2023.2.0

Alternatively, to install the latest from ansys-grantami-recordlists GitHub, use this code:

pip install git:

To install a local development version with Git and Poetry, use this code:

git clone
cd grantami-recordlists
poetry install

The preceding code installs the package and allows you to modify it locally, with your changes reflected in your Python setup after restarting the Python kernel.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ansys_grantami_recordlists-1.1.0.tar.gz (15.2 kB view hashes)

Uploaded Source

Built Distribution

ansys_grantami_recordlists-1.1.0-py3-none-any.whl (15.0 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page