| Name | poetry-snakemake-plugin JSON |
| Version |
0.4.0
JSON |
| download |
| home_page | |
| Summary | A plugin for poetry that adds Snakemake-specific functionality. |
| upload_time | 2024-02-16 21:46:26 |
| maintainer | |
| docs_url | None |
| author | Johannes Koester |
| requires_python | >=3.8.1,<4.0.0 |
| license | |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# poetry-snakemake-plugin
[](https://github.com/yte-template-engine/yte/blob/main/pyproject.toml#L30)
A plugin for poetry that adds Snakemake-specific functionality.
Currently it supports scaffolding the source code for new Snakemake [executor plugins](https://github.com/snakemake/snakemake-interface-executor-plugins)
and [storage plugins](https://github.com/snakemake/snakemake-interface-storage-plugins).
This works as follows.
## Scaffolding an executor plugin
Lets assume that you want to create a snakemake executor plugin with the name `snakemake-executor-plugin-myfancyexecutor`.
```bash
# Install poetry plugin via
poetry self add poetry-snakemake-plugin
# Create a new poetry project via
poetry new snakemake-executor-plugin-myfancyexecutor
cd snakemake-executor-plugin-myfancyexecutor
# Scaffold the project as a snakemake executor plugin
poetry scaffold-snakemake-executor-plugin
# Next, edit the scaffolded code according to your needs, and publish
# the resulting plugin into a github repository. The scaffold command also
# creates github actions workflows that will immediately start to check and test
# the plugin.
```
## Scaffolding a storage plugin
Lets assume that you want to create a snakemake storage plugin with the name `snakemake-storage-plugin-myfancystorage`.
```bash
# Install poetry plugin via
poetry self add poetry-snakemake-plugin
# Create a new poetry project via
poetry new snakemake-storage-plugin-myfancystorage
cd snakemake-storage-plugin-myfancystorage
# Scaffold the project as a snakemake executor plugin
poetry scaffold-snakemake-storage-plugin
# Next, edit the scaffolded code according to your needs, and publish
# the resulting plugin into a github repository. The scaffold command also
# creates github actions workflows that will immediately start to check and test
# the plugin.
```
## Scaffolding a report plugin
Lets assume that you want to create a snakemake report plugin with the name `snakemake-report-plugin-myfancyreport`.
```bash
# Install poetry plugin via
poetry self add poetry-snakemake-plugin
# Create a new poetry project via
poetry new snakemake-report-plugin-myfancyreport
cd snakemake-storage-plugin-myfancyreport
# Scaffold the project as a snakemake executor plugin
poetry scaffold-snakemake-report-plugin
# Next, edit the scaffolded code according to your needs, and publish
# the resulting plugin into a github repository. The scaffold command also
# creates github actions workflows that will immediately start to check and test
# the plugin.
```
Raw data
{
"_id": null,
"home_page": "",
"name": "poetry-snakemake-plugin",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8.1,<4.0.0",
"maintainer_email": "",
"keywords": "",
"author": "Johannes Koester",
"author_email": "johannes.koester@uni-due.de",
"download_url": "https://files.pythonhosted.org/packages/e8/1e/889a145ad7388b2895dc05a5573aa7ace69b74f0803e853aa8c76ab97868/poetry_snakemake_plugin-0.4.0.tar.gz",
"platform": null,
"description": "# poetry-snakemake-plugin\n\n[](https://github.com/yte-template-engine/yte/blob/main/pyproject.toml#L30)\n\nA plugin for poetry that adds Snakemake-specific functionality.\nCurrently it supports scaffolding the source code for new Snakemake [executor plugins](https://github.com/snakemake/snakemake-interface-executor-plugins)\nand [storage plugins](https://github.com/snakemake/snakemake-interface-storage-plugins).\nThis works as follows.\n\n## Scaffolding an executor plugin\n\nLets assume that you want to create a snakemake executor plugin with the name `snakemake-executor-plugin-myfancyexecutor`.\n\n```bash\n\n# Install poetry plugin via\npoetry self add poetry-snakemake-plugin\n\n# Create a new poetry project via\npoetry new snakemake-executor-plugin-myfancyexecutor\n\ncd snakemake-executor-plugin-myfancyexecutor\n\n# Scaffold the project as a snakemake executor plugin\npoetry scaffold-snakemake-executor-plugin\n\n# Next, edit the scaffolded code according to your needs, and publish\n# the resulting plugin into a github repository. The scaffold command also \n# creates github actions workflows that will immediately start to check and test\n# the plugin.\n```\n\n## Scaffolding a storage plugin\n\nLets assume that you want to create a snakemake storage plugin with the name `snakemake-storage-plugin-myfancystorage`.\n\n```bash\n\n# Install poetry plugin via\npoetry self add poetry-snakemake-plugin\n\n# Create a new poetry project via\npoetry new snakemake-storage-plugin-myfancystorage\n\ncd snakemake-storage-plugin-myfancystorage\n\n# Scaffold the project as a snakemake executor plugin\npoetry scaffold-snakemake-storage-plugin\n\n# Next, edit the scaffolded code according to your needs, and publish\n# the resulting plugin into a github repository. The scaffold command also \n# creates github actions workflows that will immediately start to check and test\n# the plugin.\n```\n\n## Scaffolding a report plugin\n\nLets assume that you want to create a snakemake report plugin with the name `snakemake-report-plugin-myfancyreport`.\n\n```bash\n\n# Install poetry plugin via\npoetry self add poetry-snakemake-plugin\n\n# Create a new poetry project via\npoetry new snakemake-report-plugin-myfancyreport\n\ncd snakemake-storage-plugin-myfancyreport\n\n# Scaffold the project as a snakemake executor plugin\npoetry scaffold-snakemake-report-plugin\n\n# Next, edit the scaffolded code according to your needs, and publish\n# the resulting plugin into a github repository. The scaffold command also \n# creates github actions workflows that will immediately start to check and test\n# the plugin.\n```",
"bugtrack_url": null,
"license": "",
"summary": "A plugin for poetry that adds Snakemake-specific functionality.",
"version": "0.4.0",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6755c4004a1fbd42023fba28f41760ee33b9f5a35e5ea84ef5d10852e8a1b35d",
"md5": "fc420d87acc1db87c2f7b8ec0912b8ba",
"sha256": "fdb400447592eeda384da7a2d06157d7624394c90656cd6e92e173d2024d345c"
},
"downloads": -1,
"filename": "poetry_snakemake_plugin-0.4.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "fc420d87acc1db87c2f7b8ec0912b8ba",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8.1,<4.0.0",
"size": 16067,
"upload_time": "2024-02-16T21:46:24",
"upload_time_iso_8601": "2024-02-16T21:46:24.524820Z",
"url": "https://files.pythonhosted.org/packages/67/55/c4004a1fbd42023fba28f41760ee33b9f5a35e5ea84ef5d10852e8a1b35d/poetry_snakemake_plugin-0.4.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e81e889a145ad7388b2895dc05a5573aa7ace69b74f0803e853aa8c76ab97868",
"md5": "b550272bea69b61933d1fdcd17e4679d",
"sha256": "631c079773e02088cd0dc961074bf60d488015854e75529e4c31d3bf8cbbbd1a"
},
"downloads": -1,
"filename": "poetry_snakemake_plugin-0.4.0.tar.gz",
"has_sig": false,
"md5_digest": "b550272bea69b61933d1fdcd17e4679d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8.1,<4.0.0",
"size": 9616,
"upload_time": "2024-02-16T21:46:26",
"upload_time_iso_8601": "2024-02-16T21:46:26.189105Z",
"url": "https://files.pythonhosted.org/packages/e8/1e/889a145ad7388b2895dc05a5573aa7ace69b74f0803e853aa8c76ab97868/poetry_snakemake_plugin-0.4.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-16 21:46:26",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "poetry-snakemake-plugin"
}
