| Name | aiida-ssh2win JSON |
| Version |
0.2.0
JSON |
| download |
| home_page | None |
| Summary | A transport plugin allowing AiiDA to run calculations on Windows machines. |
| upload_time | 2023-08-17 11:00:57 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.7 |
| license | None |
| keywords |
aiida
plugin
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
[![Build Status][ci-badge]][ci-link]
[![Coverage Status][cov-badge]][cov-link]
[![Docs status][docs-badge]][docs-link]
[![PyPI version][pypi-badge]][pypi-link]
# aiida-ssh2win
A transport plugin allowing AiiDA to run calculations on Windows machines.
This plugin is the default output of the
[AiiDA plugin cutter](https://github.com/aiidateam/aiida-plugin-cutter),
intended to help developers get started with their AiiDA plugins.
## Repository contents
- [`.github/`](.github/): [Github Actions](https://github.com/features/actions) configuration
- [`ci.yml`](.github/workflows/ci.yml): runs tests, checks test coverage and builds documentation at every new commit
- [`publish-on-pypi.yml`](.github/workflows/publish-on-pypi.yml): automatically deploy git tags to PyPI - just generate a [PyPI API token](https://pypi.org/help/#apitoken) for your PyPI account and add it to the `pypi_token` secret of your github repository
- [`aiida_ssh2win/`](aiida_ssh2win/): The main source code of the plugin package
- [`transport.py`](aiida_ssh2win/transport.py): Contains `SshToWindowsTransport` - a concrete implementation of AiiDA's `Transport` interface
- [`docs/`](docs/): A documentation template ready for publication on [Read the Docs](http://aiida-ssh2win.readthedocs.io/en/latest/)
- [`tests/`](tests/): Unit testing using the [pytest](https://docs.pytest.org/en/latest/) framework. Install `pip install -e .[testing]` and run `pytest`.
- [`.gitignore`](.gitignore): Telling git which files to ignore
- [`.pre-commit-config.yaml`](.pre-commit-config.yaml): Configuration of [pre-commit hooks](https://pre-commit.com/) that sanitize coding style and check for syntax errors. Enable via `pip install -e .[pre-commit] && pre-commit install`
- [`.readthedocs.yml`](.readthedocs.yml): Configuration of documentation build for [Read the Docs](https://readthedocs.org/)
- [`LICENSE`](LICENSE): License for your plugin
- [`README.md`](README.md): This file
- [`conftest.py`](conftest.py): Configuration of fixtures for [pytest](https://docs.pytest.org/en/latest/)
- [`pyproject.toml`](setup.json): Python package metadata for registration on [PyPI](https://pypi.org/) and the [AiiDA plugin registry](https://aiidateam.github.io/aiida-registry/) (including entry points)
## Installation
```shell
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
[ci-badge]: https://github.com/edan-bainglass/aiida-ssh2win/workflows/ci/badge.svg?branch=master
[ci-link]: https://github.com/edan-bainglass/aiida-ssh2win/actions
[cov-badge]: https://coveralls.io/repos/github/edan-bainglass/aiida-ssh2win/badge.svg?branch=master
[cov-link]: https://coveralls.io/github/edan-bainglass/aiida-ssh2win?branch=master
[docs-badge]: https://readthedocs.org/projects/aiida-ssh2win/badge
[docs-link]: http://aiida-ssh2win.readthedocs.io/
[pypi-badge]: https://badge.fury.io/py/aiida-ssh2win.svg
[pypi-link]: https://badge.fury.io/py/aiida-ssh2win
Raw data
{
"_id": null,
"home_page": null,
"name": "aiida-ssh2win",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "aiida,plugin",
"author": null,
"author_email": "Edan Bainglass <edan.bainglass@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/ad/e5/d751dc3e81a808c692fad59a5919362dc16b3917ccfa7fa44855a8b30f2f/aiida_ssh2win-0.2.0.tar.gz",
"platform": null,
"description": "[![Build Status][ci-badge]][ci-link]\n[![Coverage Status][cov-badge]][cov-link]\n[![Docs status][docs-badge]][docs-link]\n[![PyPI version][pypi-badge]][pypi-link]\n\n# aiida-ssh2win\n\nA transport plugin allowing AiiDA to run calculations on Windows machines.\n\nThis plugin is the default output of the\n[AiiDA plugin cutter](https://github.com/aiidateam/aiida-plugin-cutter),\nintended to help developers get started with their AiiDA plugins.\n\n## Repository contents\n\n- [`.github/`](.github/): [Github Actions](https://github.com/features/actions) configuration\n - [`ci.yml`](.github/workflows/ci.yml): runs tests, checks test coverage and builds documentation at every new commit\n - [`publish-on-pypi.yml`](.github/workflows/publish-on-pypi.yml): automatically deploy git tags to PyPI - just generate a [PyPI API token](https://pypi.org/help/#apitoken) for your PyPI account and add it to the `pypi_token` secret of your github repository\n- [`aiida_ssh2win/`](aiida_ssh2win/): The main source code of the plugin package\n - [`transport.py`](aiida_ssh2win/transport.py): Contains `SshToWindowsTransport` - a concrete implementation of AiiDA's `Transport` interface\n- [`docs/`](docs/): A documentation template ready for publication on [Read the Docs](http://aiida-ssh2win.readthedocs.io/en/latest/)\n- [`tests/`](tests/): Unit testing using the [pytest](https://docs.pytest.org/en/latest/) framework. Install `pip install -e .[testing]` and run `pytest`.\n- [`.gitignore`](.gitignore): Telling git which files to ignore\n- [`.pre-commit-config.yaml`](.pre-commit-config.yaml): Configuration of [pre-commit hooks](https://pre-commit.com/) that sanitize coding style and check for syntax errors. Enable via `pip install -e .[pre-commit] && pre-commit install`\n- [`.readthedocs.yml`](.readthedocs.yml): Configuration of documentation build for [Read the Docs](https://readthedocs.org/)\n- [`LICENSE`](LICENSE): License for your plugin\n- [`README.md`](README.md): This file\n- [`conftest.py`](conftest.py): Configuration of fixtures for [pytest](https://docs.pytest.org/en/latest/)\n- [`pyproject.toml`](setup.json): Python package metadata for registration on [PyPI](https://pypi.org/) and the [AiiDA plugin registry](https://aiidateam.github.io/aiida-registry/) (including entry points)\n\n## Installation\n\n```shell\npip install aiida-ssh2win\nverdi quicksetup # better to set up a new profile\nverdi plugin list aiida.transports # should now show the `ssh2win` plugins\n```\n\n## Usage\n\n## License\n\nMIT\n\n## Contact\n\nedan.bainglass@gmail.com\n\n[ci-badge]: https://github.com/edan-bainglass/aiida-ssh2win/workflows/ci/badge.svg?branch=master\n[ci-link]: https://github.com/edan-bainglass/aiida-ssh2win/actions\n[cov-badge]: https://coveralls.io/repos/github/edan-bainglass/aiida-ssh2win/badge.svg?branch=master\n[cov-link]: https://coveralls.io/github/edan-bainglass/aiida-ssh2win?branch=master\n[docs-badge]: https://readthedocs.org/projects/aiida-ssh2win/badge\n[docs-link]: http://aiida-ssh2win.readthedocs.io/\n[pypi-badge]: https://badge.fury.io/py/aiida-ssh2win.svg\n[pypi-link]: https://badge.fury.io/py/aiida-ssh2win\n",
"bugtrack_url": null,
"license": null,
"summary": "A transport plugin allowing AiiDA to run calculations on Windows machines.",
"version": "0.2.0",
"project_urls": {
"Source": "https://github.com/edan-bainglass/aiida-ssh2win"
},
"split_keywords": [
"aiida",
"plugin"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "e79496e692b0873b6d1f0f8fad89d92fe6decb021e060e138385ade44ab60369",
"md5": "eeb0ce58f822b04bd6a9d921e180a4a3",
"sha256": "27b343265896981462d3e3a98ddb0f7aefa3cfd17b3070f446c1a61a1c8c8627"
},
"downloads": -1,
"filename": "aiida_ssh2win-0.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "eeb0ce58f822b04bd6a9d921e180a4a3",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 4916,
"upload_time": "2023-08-17T11:00:49",
"upload_time_iso_8601": "2023-08-17T11:00:49.962285Z",
"url": "https://files.pythonhosted.org/packages/e7/94/96e692b0873b6d1f0f8fad89d92fe6decb021e060e138385ade44ab60369/aiida_ssh2win-0.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "ade5d751dc3e81a808c692fad59a5919362dc16b3917ccfa7fa44855a8b30f2f",
"md5": "dcb67d78e8f7135461df58d0734815f4",
"sha256": "f9e6051bdbd0ffddc1cb6bbd9dcc11effe4017a54ffdd57da87147ff27f1fa88"
},
"downloads": -1,
"filename": "aiida_ssh2win-0.2.0.tar.gz",
"has_sig": false,
"md5_digest": "dcb67d78e8f7135461df58d0734815f4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 87612,
"upload_time": "2023-08-17T11:00:57",
"upload_time_iso_8601": "2023-08-17T11:00:57.698425Z",
"url": "https://files.pythonhosted.org/packages/ad/e5/d751dc3e81a808c692fad59a5919362dc16b3917ccfa7fa44855a8b30f2f/aiida_ssh2win-0.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-08-17 11:00:57",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "edan-bainglass",
"github_project": "aiida-ssh2win",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "aiida-ssh2win"
}
