Back to packageRELEASE DETAILS

0.2.0

PyPI

aiida-ssh2win

A transport plugin allowing AiiDA to run calculations on Windows machines.

Published17 Aug 2023

Direct dependencies14

Transitive dependenciesNot calculated

README

Version 0.2.0 documentation

aiida-ssh2win

A transport plugin allowing AiiDA to run calculations on Windows machines.

This plugin is the default output of the AiiDA plugin cutter, intended to help developers get started with their AiiDA plugins.

Repository contents

.github/: Github Actions configuration
- ci.yml: runs tests, checks test coverage and builds documentation at every new commit
- publish-on-pypi.yml: automatically deploy git tags to PyPI - just generate a PyPI API token for your PyPI account and add it to the pypi_token secret of your github repository
aiida_ssh2win/: The main source code of the plugin package
- transport.py: Contains SshToWindowsTransport - a concrete implementation of AiiDA's Transport interface
docs/: A documentation template ready for publication on Read the Docs
tests/: Unit testing using the pytest framework. Install pip install -e .[testing] and run pytest.
.gitignore: Telling git which files to ignore
.pre-commit-config.yaml: Configuration of pre-commit hooks that sanitize coding style and check for syntax errors. Enable via pip install -e .[pre-commit] && pre-commit install
.readthedocs.yml: Configuration of documentation build for Read the Docs
LICENSE: License for your plugin
README.md: This file
conftest.py: Configuration of fixtures for pytest
pyproject.toml: Python package metadata for registration on PyPI and the AiiDA plugin registry (including entry points)

Installation

pip install aiida-ssh2win
verdi quicksetup  # better to set up a new profile
verdi plugin list aiida.transports  # should now show the `ssh2win` plugins

Usage

License

MIT

Contact

edan.bainglass@gmail.com

Downloads & popularity

Awaiting observations

No metric observations yet

Download counts and popularity will appear here as the collector receives them.

Declared dependencies 14

Native requirements

14 direct targetsNot calculated transitive count

Package / target	Requirement	Relationship
aiida-core Environment { "extras": "", "marker": null, "requires_python": ">=3.7", "evaluation": "NOT_EVALUATED" }	`aiida-core>=2.0,<3`	runtime
sphinx Environment { "extras": "", "marker": "extra == \"docs\"", "requires_python": ">=3.7", "evaluation": "NOT_EVALUATED" }	`sphinx ; extra == "docs"`	runtime
sphinxcontrib-contentui Environment { "extras": "", "marker": "extra == \"docs\"", "requires_python": ">=3.7", "evaluation": "NOT_EVALUATED" }	`sphinxcontrib-contentui ; extra == "docs"`	runtime
sphinxcontrib-details-directive Environment { "extras": "", "marker": "extra == \"docs\"", "requires_python": ">=3.7", "evaluation": "NOT_EVALUATED" }	`sphinxcontrib-details-directive ; extra == "docs"`	runtime
furo Environment { "extras": "", "marker": "extra == \"docs\"", "requires_python": ">=3.7", "evaluation": "NOT_EVALUATED" }	`furo ; extra == "docs"`	runtime
markupsafe Environment { "extras": "", "marker": "extra == \"docs\"", "requires_python": ">=3.7", "evaluation": "NOT_EVALUATED" }	`markupsafe<2.1 ; extra == "docs"`	runtime
pre-commit Environment { "extras": "", "marker": "extra == \"pre-commit\"", "requires_python": ">=3.7", "evaluation": "NOT_EVALUATED" }	`pre-commit~=2.2 ; extra == "pre-commit"`	runtime
flake8 Environment { "extras": "", "marker": "extra == \"pre-commit\"", "requires_python": ">=3.7", "evaluation": "NOT_EVALUATED" }	`flake8~=6.0 ; extra == "pre-commit"`	runtime
yapf Environment { "extras": "", "marker": "extra == \"pre-commit\"", "requires_python": ">=3.7", "evaluation": "NOT_EVALUATED" }	`yapf==0.32 ; extra == "pre-commit"`	runtime
pgtest Environment { "extras": "", "marker": "extra == \"testing\"", "requires_python": ">=3.7", "evaluation": "NOT_EVALUATED" }	`pgtest~=1.3.1 ; extra == "testing"`	runtime
wheel Environment { "extras": "", "marker": "extra == \"testing\"", "requires_python": ">=3.7", "evaluation": "NOT_EVALUATED" }	`wheel~=0.31 ; extra == "testing"`	runtime
coverage Environment { "extras": "toml", "marker": "extra == \"testing\"", "requires_python": ">=3.7", "evaluation": "NOT_EVALUATED" }	`coverage[toml] ; extra == "testing"`	runtime
pytest Environment { "extras": "", "marker": "extra == \"testing\"", "requires_python": ">=3.7", "evaluation": "NOT_EVALUATED" }	`pytest~=6.0 ; extra == "testing"`	runtime
pytest-cov Environment { "extras": "", "marker": "extra == \"testing\"", "requires_python": ">=3.7", "evaluation": "NOT_EVALUATED" }	`pytest-cov ; extra == "testing"`	runtime