{"id":19227930,"url":"https://github.com/snakemake/poetry-snakemake-plugin","last_synced_at":"2025-04-21T01:31:51.536Z","repository":{"id":192833589,"uuid":"687511138","full_name":"snakemake/poetry-snakemake-plugin","owner":"snakemake","description":"Plugin for poetry that adds snakemake specific functionality","archived":false,"fork":false,"pushed_at":"2025-04-08T07:48:21.000Z","size":147,"stargazers_count":5,"open_issues_count":1,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-08T08:42:09.212Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/snakemake.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-09-05T14:01:03.000Z","updated_at":"2025-04-08T07:47:53.000Z","dependencies_parsed_at":"2023-09-22T09:22:48.237Z","dependency_job_id":"a2c42c4a-d650-4a0c-b3a9-9c3e35132c2c","html_url":"https://github.com/snakemake/poetry-snakemake-plugin","commit_stats":null,"previous_names":["snakemake/poetry-snakemake-plugin"],"tags_count":19,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/snakemake%2Fpoetry-snakemake-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/snakemake%2Fpoetry-snakemake-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/snakemake%2Fpoetry-snakemake-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/snakemake%2Fpoetry-snakemake-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/snakemake","download_url":"https://codeload.github.com/snakemake/poetry-snakemake-plugin/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249982549,"owners_count":21355716,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-09T15:25:57.270Z","updated_at":"2025-04-21T01:31:51.531Z","avatar_url":"https://github.com/snakemake.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# poetry-snakemake-plugin\n\n[![test coverage: 100%](https://img.shields.io/badge/test%20coverage-100%25-green)](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), [storage plugins](https://github.com/snakemake/snakemake-interface-storage-plugins), and [report plugins](https://github.com/snakemake/snakemake-interface-report-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@latest\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@latest\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@latest\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```\n\n## Scaffold a software deployment plugin\n\nLets assume that you want to create a snakemake software deployment plugin with the name `snakemake-deployment-plugin-myfancydeployment`.\n\n```bash\n\n# Install poetry plugin via\npoetry self add poetry-snakemake-plugin@latest\n\n# Create a new poetry project via\npoetry new snakemake-software-deployment-plugin-myfancydeployment\n\ncd snakemake-software-deployment-plugin-myfancydeployment\n\n# Scaffold the project as a snakemake software deployment plugin\npoetry scaffold-snakemake-software-deployment-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","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsnakemake%2Fpoetry-snakemake-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsnakemake%2Fpoetry-snakemake-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsnakemake%2Fpoetry-snakemake-plugin/lists"}