https://github.com/aiidateam/aiida-upgrade
A tool to aide upgrades of plugins to new aiida-core version
https://github.com/aiidateam/aiida-upgrade
Last synced: about 2 months ago
JSON representation
A tool to aide upgrades of plugins to new aiida-core version
- Host: GitHub
- URL: https://github.com/aiidateam/aiida-upgrade
- Owner: aiidateam
- License: mit
- Created: 2022-02-23T16:06:02.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-04-07T21:10:15.000Z (about 2 months ago)
- Last Synced: 2025-04-13T04:03:59.026Z (about 2 months ago)
- Language: Python
- Size: 15.6 KB
- Stars: 1
- Watchers: 3
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# aiida-upgrade
[![PyPI][pypi-badge]][pypi-link]
**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](https://pypa.github.io/pipx/):
```console
$ pipx install aiida-upgrade
```
Once installed, you can simply run `aiida-upgrade` on any `PATH`, which can be a single file or a directory:
```console
$ 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](https://github.com/aiidateam/aiida-core/wiki/AiiDA-2.0-plugin-migration-guide#entry-points).
* 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`](https://github.com/aiidateam/aiida-core/pull/5165), which removed the requirement of using these keywords.
Migration steps that are not (yet) supported are:
* Adding the `core.` prefix in shell scripts.
* [Update `'name'` to `'label'` when querying for a `Computer` with the `QueryBuilder`](https://github.com/aiidateam/aiida-core/wiki/AiiDA-2.0-plugin-migration-guide#querybuilder).
* Small changes in the API of [Transport](https://github.com/aiidateam/aiida-core/wiki/AiiDA-2.0-plugin-migration-guide#transport-plugins) and [Scheduler](https://github.com/aiidateam/aiida-core/wiki/AiiDA-2.0-plugin-migration-guide#schedulers) plugins.
* [Removal of the `PluginTestCase` class.](https://github.com/aiidateam/aiida-core/wiki/AiiDA-2.0-plugin-migration-guide#unit-tests)
If you find any problems with the current refactoring, or any migration steps that are missing, please let us know by opening an issue.
[pypi-badge]: https://img.shields.io/pypi/v/aiida_upgrade.svg
[pypi-link]: https://pypi.org/project/aiida_upgrade