Skip to main content

A tool to perform upgrades of AiiDA plugins to new aiida-core versions.

Project description

aiida-upgrade

PyPI

In Development!

A tool to aide upgrades of plugins to new aiida-core versions

Usage

To use the command line tool, it is recommended to install via pipx:

$ pipx install aiida-upgrade

Once installed, you can simply run aiida-upgrade on any PATH, which can be a single file or a directory:

$ aiida-upgrade --help
Usage: aiida-upgrade [OPTIONS] PATH

  The command line interface of aiida-upgrade.

Options:
  --help  Show this message and exit.

In case PATH is a directory, aiida-upgrade will recursively update all .py files inside that directory.

Supported migrations

Currently, aiida-upgrade performs the following code refactoring:

  • Look for deprecated aiida-core entry points loaded by plugin factories and add the core. prefix, see the corresponding section in the plugin migration guide.
  • Similarly, find and correct full deprecated entry point strings e.g. 'aiida.data:structure'.
  • Remove dict and list keywords from the Dict and List node constructors, respectively. See PR #5165 on aiida-core, which removed the requirement of using these keywords.

Migration steps that are not (yet) supported are:

If you find any problems with the current refactoring, or any migration steps that are missing, please let us know by opening an issue.

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

aiida_upgrade-0.1.0.tar.gz (6.6 kB view hashes)

Uploaded Source

Built Distribution

aiida_upgrade-0.1.0-py2.py3-none-any.whl (6.6 kB view hashes)

Uploaded Python 2 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