snakemake-report-plugin-nanopub 0.1.0__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- snakemake_report_plugin_nanopub-0.1.0/.github/dependabot.yml +11 -0
- snakemake_report_plugin_nanopub-0.1.0/.github/workflows/announce-release.yml +54 -0
- snakemake_report_plugin_nanopub-0.1.0/.github/workflows/ci.yml +65 -0
- snakemake_report_plugin_nanopub-0.1.0/.github/workflows/codespell.yml +26 -0
- snakemake_report_plugin_nanopub-0.1.0/.github/workflows/conventional-prs.yml +16 -0
- snakemake_report_plugin_nanopub-0.1.0/.github/workflows/release-please.yml +50 -0
- snakemake_report_plugin_nanopub-0.1.0/.github/workflows/stale.yml +42 -0
- snakemake_report_plugin_nanopub-0.1.0/.gitignore +162 -0
- snakemake_report_plugin_nanopub-0.1.0/CHANGELOG.md +69 -0
- snakemake_report_plugin_nanopub-0.1.0/LICENSE +21 -0
- snakemake_report_plugin_nanopub-0.1.0/PKG-INFO +47 -0
- snakemake_report_plugin_nanopub-0.1.0/README.md +33 -0
- snakemake_report_plugin_nanopub-0.1.0/docs/further.md +87 -0
- snakemake_report_plugin_nanopub-0.1.0/docs/intro.md +3 -0
- snakemake_report_plugin_nanopub-0.1.0/images/example_knowledgegraph.png +0 -0
- snakemake_report_plugin_nanopub-0.1.0/pixi.toml +29 -0
- snakemake_report_plugin_nanopub-0.1.0/pr_logo/logo_dark.png +0 -0
- snakemake_report_plugin_nanopub-0.1.0/pyproject.toml +99 -0
- snakemake_report_plugin_nanopub-0.1.0/setup.cfg +7 -0
- snakemake_report_plugin_nanopub-0.1.0/src/snakemake_report_plugin_nanopub/__init__.py +562 -0
- snakemake_report_plugin_nanopub-0.1.0/src/snakemake_report_plugin_nanopub/extraction.py +180 -0
- snakemake_report_plugin_nanopub-0.1.0/src/snakemake_report_plugin_nanopub/validation.py +14 -0
- snakemake_report_plugin_nanopub-0.1.0/src/snakemake_report_plugin_nanopub_cli.py +158 -0
- snakemake_report_plugin_nanopub-0.1.0/src/snakemake_report_plugin_nanopub_graph.py +356 -0
- snakemake_report_plugin_nanopub-0.1.0/tests/test_cli_plot.py +265 -0
- snakemake_report_plugin_nanopub-0.1.0/tests/test_extraction.py +290 -0
- snakemake_report_plugin_nanopub-0.1.0/tests/test_plugin.py +16 -0
- snakemake_report_plugin_nanopub-0.1.0/tests/test_reporter.py +735 -0
- snakemake_report_plugin_nanopub-0.1.0/tests/test_validation.py +27 -0
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
# To get started with Dependabot version updates, you'll need to specify which
|
|
2
|
+
# package ecosystems to update and where the package manifests are located.
|
|
3
|
+
# Please see the documentation for all configuration options:
|
|
4
|
+
# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
|
|
5
|
+
|
|
6
|
+
version: 2
|
|
7
|
+
updates:
|
|
8
|
+
- package-ecosystem: "github-actions" # See documentation for possible values
|
|
9
|
+
directory: "/" # Location of package manifests
|
|
10
|
+
schedule:
|
|
11
|
+
interval: "monthly"
|
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
name: Announce Release on Mastodon
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
push:
|
|
5
|
+
branches:
|
|
6
|
+
- main
|
|
7
|
+
paths:
|
|
8
|
+
- 'CHANGELOG.md'
|
|
9
|
+
|
|
10
|
+
permissions:
|
|
11
|
+
pull-requests: read
|
|
12
|
+
|
|
13
|
+
jobs:
|
|
14
|
+
post_to_mastodon:
|
|
15
|
+
if: "${{ contains(github.event.head_commit.message, 'chore(main): release') }}"
|
|
16
|
+
runs-on: ubuntu-latest
|
|
17
|
+
steps:
|
|
18
|
+
- name: Checkout repository
|
|
19
|
+
uses: actions/checkout@v6
|
|
20
|
+
|
|
21
|
+
- name: Verify logo file exists
|
|
22
|
+
run: |
|
|
23
|
+
ls -la ${{ github.workspace }}/pr_logo/
|
|
24
|
+
if [ ! -f "${{ github.workspace }}/pr_logo/logo_dark.png" ]; then
|
|
25
|
+
echo "ERROR: Logo file not found!"
|
|
26
|
+
exit 1
|
|
27
|
+
fi
|
|
28
|
+
echo "Logo file found at: ${{ github.workspace }}/pr_logo/logo_dark.png"
|
|
29
|
+
|
|
30
|
+
- name: Post to Mastodon
|
|
31
|
+
uses: snakemake/mastodon-release-post-action@main # == latest
|
|
32
|
+
with:
|
|
33
|
+
access-token: ${{ secrets.MASTODONBOT }}
|
|
34
|
+
pr-title: ${{ github.event.head_commit.message }}
|
|
35
|
+
image: "logo_dark.png"
|
|
36
|
+
image-description: "Snakemake Logo"
|
|
37
|
+
repotitle: "Snakemake Reporter PLugin for Nanopubs"
|
|
38
|
+
message: |
|
|
39
|
+
Beep, Beep - I am your friendly #Snakemake release announcement bot.
|
|
40
|
+
|
|
41
|
+
There is a new release of the {{ repotitle }} systems. Its version now is {{ version }}!
|
|
42
|
+
|
|
43
|
+
Give us some time, and you will automatically find the plugin on #Bioconda and #Pypi.
|
|
44
|
+
|
|
45
|
+
This plugin is relevant for Snakemake users willing to publish
|
|
46
|
+
Software Metadata easyly.
|
|
47
|
+
The maintainer is here on Mastodon @rupdecat.
|
|
48
|
+
|
|
49
|
+
If you discover any issues, please report them on {{ issue_url }}.
|
|
50
|
+
|
|
51
|
+
See {{ changelog }} for details. Here is the header of the changelog:
|
|
52
|
+
|
|
53
|
+
${{ steps.extract-release-notes.outputs.release_notes }}
|
|
54
|
+
|
|
@@ -0,0 +1,65 @@
|
|
|
1
|
+
name: CI
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
push:
|
|
5
|
+
branches:
|
|
6
|
+
- main
|
|
7
|
+
pull_request:
|
|
8
|
+
|
|
9
|
+
env:
|
|
10
|
+
TEST_ENV_DIR: /tmp/test-env
|
|
11
|
+
|
|
12
|
+
jobs:
|
|
13
|
+
formatting:
|
|
14
|
+
runs-on: ubuntu-latest
|
|
15
|
+
steps:
|
|
16
|
+
- name: Check out the code
|
|
17
|
+
uses: actions/checkout@v6
|
|
18
|
+
|
|
19
|
+
- name: Setup pixi
|
|
20
|
+
uses: prefix-dev/setup-pixi@v0
|
|
21
|
+
|
|
22
|
+
- name: Check formatting
|
|
23
|
+
run: pixi run format --check .
|
|
24
|
+
|
|
25
|
+
linting:
|
|
26
|
+
runs-on: ubuntu-latest
|
|
27
|
+
steps:
|
|
28
|
+
- name: Check out the code
|
|
29
|
+
uses: actions/checkout@v6
|
|
30
|
+
|
|
31
|
+
- name: Setup pixi
|
|
32
|
+
uses: prefix-dev/setup-pixi@v0
|
|
33
|
+
|
|
34
|
+
- name: Check code
|
|
35
|
+
run: pixi run lint
|
|
36
|
+
|
|
37
|
+
testing:
|
|
38
|
+
runs-on: ubuntu-latest
|
|
39
|
+
# only run if commit message does not start with "chore(main): release"
|
|
40
|
+
if: >-
|
|
41
|
+
!startsWith(github.event.head_commit.message, 'chore(main): release')
|
|
42
|
+
steps:
|
|
43
|
+
- uses: actions/checkout@v6
|
|
44
|
+
|
|
45
|
+
- name: Setup pixi
|
|
46
|
+
uses: prefix-dev/setup-pixi@v0
|
|
47
|
+
|
|
48
|
+
- uses: conda-incubator/setup-miniconda@v3
|
|
49
|
+
with:
|
|
50
|
+
channels: conda-forge,nodefaults
|
|
51
|
+
|
|
52
|
+
- name: Deploy external test env
|
|
53
|
+
shell: bash -el {0}
|
|
54
|
+
run: |
|
|
55
|
+
conda create -n test-env stress-ng
|
|
56
|
+
conda create -p $TEST_ENV_DIR stress-ng
|
|
57
|
+
|
|
58
|
+
- name: Run pytest
|
|
59
|
+
env:
|
|
60
|
+
TEST_NAMED_ENV: "1"
|
|
61
|
+
TEST_DIRECTORY_ENV: "1"
|
|
62
|
+
run: pixi run test -v
|
|
63
|
+
|
|
64
|
+
- name: Run Coverage
|
|
65
|
+
run: pixi run coverage-report
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# Codespell configuration is within pyproject.toml
|
|
2
|
+
---
|
|
3
|
+
name: Codespell
|
|
4
|
+
|
|
5
|
+
on:
|
|
6
|
+
push:
|
|
7
|
+
branches: [main]
|
|
8
|
+
pull_request:
|
|
9
|
+
branches: [main]
|
|
10
|
+
|
|
11
|
+
permissions:
|
|
12
|
+
contents: read
|
|
13
|
+
|
|
14
|
+
jobs:
|
|
15
|
+
codespell:
|
|
16
|
+
if: github.event.pull_request.merged != true || github.ref != 'refs/heads/main'
|
|
17
|
+
name: Check for spelling errors
|
|
18
|
+
runs-on: ubuntu-latest
|
|
19
|
+
|
|
20
|
+
steps:
|
|
21
|
+
- name: Checkout
|
|
22
|
+
uses: actions/checkout@v6
|
|
23
|
+
- name: Codespell
|
|
24
|
+
uses: codespell-project/actions-codespell@v2
|
|
25
|
+
with:
|
|
26
|
+
ignore_words_list: Crate,crate
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
name: PR
|
|
2
|
+
on:
|
|
3
|
+
pull_request_target:
|
|
4
|
+
types:
|
|
5
|
+
- opened
|
|
6
|
+
- reopened
|
|
7
|
+
- edited
|
|
8
|
+
- synchronize
|
|
9
|
+
|
|
10
|
+
jobs:
|
|
11
|
+
title-format:
|
|
12
|
+
runs-on: ubuntu-latest
|
|
13
|
+
steps:
|
|
14
|
+
- uses: amannn/action-semantic-pull-request@v6
|
|
15
|
+
env:
|
|
16
|
+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
on:
|
|
2
|
+
push:
|
|
3
|
+
branches:
|
|
4
|
+
- main
|
|
5
|
+
|
|
6
|
+
name: release-please
|
|
7
|
+
|
|
8
|
+
jobs:
|
|
9
|
+
release-please:
|
|
10
|
+
runs-on: ubuntu-latest
|
|
11
|
+
outputs:
|
|
12
|
+
release_created: ${{ steps.release.outputs.release_created }}
|
|
13
|
+
steps:
|
|
14
|
+
- uses: googleapis/release-please-action@v4
|
|
15
|
+
id: release
|
|
16
|
+
with:
|
|
17
|
+
release-type: python
|
|
18
|
+
token: ${{ secrets.RELEASE_PLEASE_PR_CI_TOKEN }}
|
|
19
|
+
|
|
20
|
+
publish:
|
|
21
|
+
runs-on: ubuntu-latest
|
|
22
|
+
needs: release-please
|
|
23
|
+
if: ${{ needs.release-please.outputs.release_created }}
|
|
24
|
+
steps:
|
|
25
|
+
- uses: actions/checkout@v6
|
|
26
|
+
|
|
27
|
+
- uses: actions/setup-python@v6
|
|
28
|
+
with:
|
|
29
|
+
python-version: "3.12"
|
|
30
|
+
|
|
31
|
+
- name: Install poetry
|
|
32
|
+
run: pip install poetry
|
|
33
|
+
|
|
34
|
+
- name: Determine dependencies
|
|
35
|
+
run: poetry lock
|
|
36
|
+
|
|
37
|
+
- uses: actions/setup-python@v6
|
|
38
|
+
with:
|
|
39
|
+
python-version: "3.12"
|
|
40
|
+
cache: poetry
|
|
41
|
+
|
|
42
|
+
- name: Install dependencies
|
|
43
|
+
run: |
|
|
44
|
+
poetry install
|
|
45
|
+
|
|
46
|
+
- name: Publish to PyPi
|
|
47
|
+
env:
|
|
48
|
+
PYPI_USERNAME: __token__
|
|
49
|
+
PYPI_PASSWORD: ${{ secrets.PYPI_TOKEN }}
|
|
50
|
+
run: poetry publish --build --username $PYPI_USERNAME --password $PYPI_PASSWORD
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
name: Close inactive issues
|
|
2
|
+
on:
|
|
3
|
+
schedule:
|
|
4
|
+
- cron: "1 1 * * 1"
|
|
5
|
+
|
|
6
|
+
jobs:
|
|
7
|
+
close-issues:
|
|
8
|
+
runs-on: ubuntu-latest
|
|
9
|
+
permissions:
|
|
10
|
+
issues: write
|
|
11
|
+
pull-requests: write
|
|
12
|
+
steps:
|
|
13
|
+
- uses: actions/stale@v10
|
|
14
|
+
with:
|
|
15
|
+
days-before-issue-stale: 180
|
|
16
|
+
days-before-issue-close: 365
|
|
17
|
+
stale-issue-label: "stale"
|
|
18
|
+
stale-issue-message: >-
|
|
19
|
+
This issue was marked as stale because it has been open for 6 months
|
|
20
|
+
with no activity. First, we apologize for not (yet) being active as
|
|
21
|
+
human beings on this issue. If there is still interest in this issue, please
|
|
22
|
+
comment and remove the 'stale' label. Also note that this does not
|
|
23
|
+
mean that we do not value your contribution. We do, but development
|
|
24
|
+
on Snakemake is a community effort, and that means that we can always
|
|
25
|
+
miss something due to the sheer amount of activity.
|
|
26
|
+
Also consider contacting us via Discord (see the docs).
|
|
27
|
+
close-issue-message: >-
|
|
28
|
+
This issue was closed because it has been inactive for 1 year since
|
|
29
|
+
being marked as stale. Feel free to re-open it if you have any further
|
|
30
|
+
comments."
|
|
31
|
+
days-before-pr-stale: 180
|
|
32
|
+
days-before-pr-close: -1
|
|
33
|
+
stale-pr-message: >-
|
|
34
|
+
This issue was marked as stale because it has been open for 6 months
|
|
35
|
+
with no activity. First, we apologize for not (yet) being active as
|
|
36
|
+
human beings on this issue. If there is still interest in this issue, please
|
|
37
|
+
comment and remove the 'stale' label. Also note that this does not
|
|
38
|
+
mean that we do not value your contribution. We do, but development
|
|
39
|
+
on Snakemake is a community effort, and that means that we can always
|
|
40
|
+
miss something due to the sheer amount of activity.
|
|
41
|
+
Also consider contacting us via Discord (see the docs).
|
|
42
|
+
repo-token: ${{ secrets.GITHUB_TOKEN }}
|
|
@@ -0,0 +1,162 @@
|
|
|
1
|
+
# Byte-compiled / optimized / DLL files
|
|
2
|
+
__pycache__/
|
|
3
|
+
*.py[cod]
|
|
4
|
+
*$py.class
|
|
5
|
+
|
|
6
|
+
# C extensions
|
|
7
|
+
*.so
|
|
8
|
+
|
|
9
|
+
# Distribution / packaging
|
|
10
|
+
.Python
|
|
11
|
+
build/
|
|
12
|
+
develop-eggs/
|
|
13
|
+
dist/
|
|
14
|
+
downloads/
|
|
15
|
+
eggs/
|
|
16
|
+
.eggs/
|
|
17
|
+
lib/
|
|
18
|
+
lib64/
|
|
19
|
+
parts/
|
|
20
|
+
sdist/
|
|
21
|
+
var/
|
|
22
|
+
wheels/
|
|
23
|
+
share/python-wheels/
|
|
24
|
+
*.egg-info/
|
|
25
|
+
.installed.cfg
|
|
26
|
+
*.egg
|
|
27
|
+
MANIFEST
|
|
28
|
+
|
|
29
|
+
# PyInstaller
|
|
30
|
+
# Usually these files are written by a python script from a template
|
|
31
|
+
# before PyInstaller builds the exe, so as to inject date/other infos into it.
|
|
32
|
+
*.manifest
|
|
33
|
+
*.spec
|
|
34
|
+
|
|
35
|
+
# Installer logs
|
|
36
|
+
pip-log.txt
|
|
37
|
+
pip-delete-this-directory.txt
|
|
38
|
+
|
|
39
|
+
# Unit test / coverage reports
|
|
40
|
+
htmlcov/
|
|
41
|
+
.tox/
|
|
42
|
+
.nox/
|
|
43
|
+
.coverage
|
|
44
|
+
.coverage.*
|
|
45
|
+
.cache
|
|
46
|
+
nosetests.xml
|
|
47
|
+
coverage.xml
|
|
48
|
+
*.cover
|
|
49
|
+
*.py,cover
|
|
50
|
+
.hypothesis/
|
|
51
|
+
.pytest_cache/
|
|
52
|
+
cover/
|
|
53
|
+
|
|
54
|
+
# Translations
|
|
55
|
+
*.mo
|
|
56
|
+
*.pot
|
|
57
|
+
|
|
58
|
+
# Django stuff:
|
|
59
|
+
*.log
|
|
60
|
+
local_settings.py
|
|
61
|
+
db.sqlite3
|
|
62
|
+
db.sqlite3-journal
|
|
63
|
+
|
|
64
|
+
# Flask stuff:
|
|
65
|
+
instance/
|
|
66
|
+
.webassets-cache
|
|
67
|
+
|
|
68
|
+
# Scrapy stuff:
|
|
69
|
+
.scrapy
|
|
70
|
+
|
|
71
|
+
# Sphinx documentation
|
|
72
|
+
docs/_build/
|
|
73
|
+
|
|
74
|
+
# PyBuilder
|
|
75
|
+
.pybuilder/
|
|
76
|
+
target/
|
|
77
|
+
|
|
78
|
+
# Jupyter Notebook
|
|
79
|
+
.ipynb_checkpoints
|
|
80
|
+
|
|
81
|
+
# IPython
|
|
82
|
+
profile_default/
|
|
83
|
+
ipython_config.py
|
|
84
|
+
|
|
85
|
+
# pyenv
|
|
86
|
+
# For a library or package, you might want to ignore these files since the code is
|
|
87
|
+
# intended to run in multiple environments; otherwise, check them in:
|
|
88
|
+
# .python-version
|
|
89
|
+
|
|
90
|
+
# pipenv
|
|
91
|
+
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
|
|
92
|
+
# However, in case of collaboration, if having platform-specific dependencies or dependencies
|
|
93
|
+
# having no cross-platform support, pipenv may install dependencies that don't work, or not
|
|
94
|
+
# install all needed dependencies.
|
|
95
|
+
#Pipfile.lock
|
|
96
|
+
|
|
97
|
+
# poetry
|
|
98
|
+
# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
|
|
99
|
+
# This is especially recommended for binary packages to ensure reproducibility, and is more
|
|
100
|
+
# commonly ignored for libraries.
|
|
101
|
+
# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
|
|
102
|
+
poetry.lock
|
|
103
|
+
|
|
104
|
+
# pdm
|
|
105
|
+
# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
|
|
106
|
+
#pdm.lock
|
|
107
|
+
# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
|
|
108
|
+
# in version control.
|
|
109
|
+
# https://pdm.fming.dev/#use-with-ide
|
|
110
|
+
.pdm.toml
|
|
111
|
+
|
|
112
|
+
# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
|
|
113
|
+
__pypackages__/
|
|
114
|
+
|
|
115
|
+
# Celery stuff
|
|
116
|
+
celerybeat-schedule
|
|
117
|
+
celerybeat.pid
|
|
118
|
+
|
|
119
|
+
# SageMath parsed files
|
|
120
|
+
*.sage.py
|
|
121
|
+
|
|
122
|
+
# Environments
|
|
123
|
+
.env
|
|
124
|
+
.venv
|
|
125
|
+
env/
|
|
126
|
+
venv/
|
|
127
|
+
ENV/
|
|
128
|
+
env.bak/
|
|
129
|
+
venv.bak/
|
|
130
|
+
|
|
131
|
+
# Spyder project settings
|
|
132
|
+
.spyderproject
|
|
133
|
+
.spyproject
|
|
134
|
+
|
|
135
|
+
# Rope project settings
|
|
136
|
+
.ropeproject
|
|
137
|
+
|
|
138
|
+
# mkdocs documentation
|
|
139
|
+
/site
|
|
140
|
+
|
|
141
|
+
# mypy
|
|
142
|
+
.mypy_cache/
|
|
143
|
+
.dmypy.json
|
|
144
|
+
dmypy.json
|
|
145
|
+
|
|
146
|
+
# Pyre type checker
|
|
147
|
+
.pyre/
|
|
148
|
+
|
|
149
|
+
# pytype static type analyzer
|
|
150
|
+
.pytype/
|
|
151
|
+
|
|
152
|
+
# Cython debug symbols
|
|
153
|
+
cython_debug/
|
|
154
|
+
|
|
155
|
+
# PyCharm
|
|
156
|
+
# JetBrains specific template is maintained in a separate JetBrains.gitignore that can
|
|
157
|
+
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
|
|
158
|
+
# and can be added to the global gitignore or merged into this file. For a more nuclear
|
|
159
|
+
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
|
|
160
|
+
#.idea/
|
|
161
|
+
|
|
162
|
+
.aider*
|
|
@@ -0,0 +1,69 @@
|
|
|
1
|
+
# Changelog
|
|
2
|
+
|
|
3
|
+
## 0.1.0 (2026-04-21)
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
### Features
|
|
7
|
+
|
|
8
|
+
* added announcement CI plus logo image ([8124fc7](https://github.com/snakemake/snakemake-report-plugin-nanopub/commit/8124fc72793ee390222cff9a0df80c1a9706ced2))
|
|
9
|
+
* added basic code (automatic scaffold by poetry) ([a81a92f](https://github.com/snakemake/snakemake-report-plugin-nanopub/commit/a81a92f6fc699f0054bd992d27579513d01cce33))
|
|
10
|
+
* added basic test code (auto generated by poetry ([5858e76](https://github.com/snakemake/snakemake-report-plugin-nanopub/commit/5858e7632e4efbddf8834f759b5a3278648e2aa2))
|
|
11
|
+
* added cli script for plotting dependency graphs ([d887696](https://github.com/snakemake/snakemake-report-plugin-nanopub/commit/d88769659066e4c442ce85f7c0af6d8f8f6f7aa6))
|
|
12
|
+
* added coverage tests for pixi ([21488dc](https://github.com/snakemake/snakemake-report-plugin-nanopub/commit/21488dcd807d5d0a127d6f85fcdbe7a274c55e21))
|
|
13
|
+
* added dependencies ([179d86f](https://github.com/snakemake/snakemake-report-plugin-nanopub/commit/179d86f0724c87b3fdf58a8f0329fc5a80a3860e))
|
|
14
|
+
* added example knowledge graph image ([792f6db](https://github.com/snakemake/snakemake-report-plugin-nanopub/commit/792f6dba43ff52159e3a48d39acacaed0682bb7e))
|
|
15
|
+
* cli now considering workflow metadata ([2ad0f1b](https://github.com/snakemake/snakemake-report-plugin-nanopub/commit/2ad0f1b8e6b6d42cc0d7a9c4f139b615344ddac5))
|
|
16
|
+
* coded skeleton - untested ([aa4f0ec](https://github.com/snakemake/snakemake-report-plugin-nanopub/commit/aa4f0ec4364f8507c39969b4d8a9ee79e46c9ed7))
|
|
17
|
+
* consider testing the graph file, too ([cfc2496](https://github.com/snakemake/snakemake-report-plugin-nanopub/commit/cfc2496bebfec14671537fbf9baa65773ebd524c))
|
|
18
|
+
* documenting --workflow-configuration-id ([5e60c84](https://github.com/snakemake/snakemake-report-plugin-nanopub/commit/5e60c846e08be9b5cf4b533ce66495a19e382416))
|
|
19
|
+
* first working version ([75d6821](https://github.com/snakemake/snakemake-report-plugin-nanopub/commit/75d68212077e06939fcf8582e0e6bc8812e8c861))
|
|
20
|
+
* improved balance between published quads and limits ([db8d18b](https://github.com/snakemake/snakemake-report-plugin-nanopub/commit/db8d18bb3fba523f640813fa4ba2eec4884665f2))
|
|
21
|
+
* included nanopub py as a dependency ([37ae247](https://github.com/snakemake/snakemake-report-plugin-nanopub/commit/37ae247e628274875c488d09a65b236d81a432cb))
|
|
22
|
+
* shrinking content size by stripping comments ([a4089cf](https://github.com/snakemake/snakemake-report-plugin-nanopub/commit/a4089cf1f74df31f8a0420b677c2dd35d6dc6878))
|
|
23
|
+
* signedby attribute was added ([1a7511c](https://github.com/snakemake/snakemake-report-plugin-nanopub/commit/1a7511cb40a2d141a411a5441b1c9cc4da866309))
|
|
24
|
+
* stabilized plotting ([7bab5c1](https://github.com/snakemake/snakemake-report-plugin-nanopub/commit/7bab5c158e8e42a5a5c6aac259c6fecb66f9b17e))
|
|
25
|
+
* version 1 ([9bb126e](https://github.com/snakemake/snakemake-report-plugin-nanopub/commit/9bb126e617dc3b51c1066cf4805f3c52bf050d66))
|
|
26
|
+
* working version ([c85ecd7](https://github.com/snakemake/snakemake-report-plugin-nanopub/commit/c85ecd78498a42d90b7e0e2498fc4f5957ba83ce))
|
|
27
|
+
* working version - needs polishing ([0ba4c51](https://github.com/snakemake/snakemake-report-plugin-nanopub/commit/0ba4c51dfe4dd152e9f45897b966236472224651))
|
|
28
|
+
* working version - not yet structured ([7ef3899](https://github.com/snakemake/snakemake-report-plugin-nanopub/commit/7ef38992ee2f86bf6e40845a27594ba0e0f10d1f))
|
|
29
|
+
|
|
30
|
+
|
|
31
|
+
### Bug Fixes
|
|
32
|
+
|
|
33
|
+
* added pixi information to toml files ([22b70e6](https://github.com/snakemake/snakemake-report-plugin-nanopub/commit/22b70e6c2d1b7c6eaf9401bf0267d27711f3eed5))
|
|
34
|
+
* attempt 2 - should fail in tests, as no nanopub-py is installed, waiting for the new version ([0b85a68](https://github.com/snakemake/snakemake-report-plugin-nanopub/commit/0b85a68cff6c7960f26febe40cc0d1edd0aaa4e6))
|
|
35
|
+
* bumped python dep in CI to 3.12 for compatibility checks ([a6c4f0e](https://github.com/snakemake/snakemake-report-plugin-nanopub/commit/a6c4f0e7e4c99dc29acca7545db6a8687239f2a5))
|
|
36
|
+
* bumped snakemake version to something recent ([136e003](https://github.com/snakemake/snakemake-report-plugin-nanopub/commit/136e00367efe87ee325df971bd81a389506fbd87))
|
|
37
|
+
* corrected description handling ([c747028](https://github.com/snakemake/snakemake-report-plugin-nanopub/commit/c7470285f9e671d94b5b5ed9404e3151c45bfdec))
|
|
38
|
+
* docstring typo ([ca1f853](https://github.com/snakemake/snakemake-report-plugin-nanopub/commit/ca1f853f9aa84667a36f5360e1de8c21bce31003))
|
|
39
|
+
* fixes the pixi CI issue - hopefully ([a426c98](https://github.com/snakemake/snakemake-report-plugin-nanopub/commit/a426c9820b9c33213320d2f441ed8cbf55cbcba5))
|
|
40
|
+
* formatting ([b65d1a0](https://github.com/snakemake/snakemake-report-plugin-nanopub/commit/b65d1a0bcc9c213d508e3d27c802c215dbf359ef))
|
|
41
|
+
* formatting ([dbdd216](https://github.com/snakemake/snakemake-report-plugin-nanopub/commit/dbdd216bd492ff33e7971f52ba07726a5f4ff370))
|
|
42
|
+
* formatting ([2f62d66](https://github.com/snakemake/snakemake-report-plugin-nanopub/commit/2f62d6699f786115600cc1925c3b217927ec9a35))
|
|
43
|
+
* formatting ([e12b70c](https://github.com/snakemake/snakemake-report-plugin-nanopub/commit/e12b70c0238271c51e97fc4f30fa2ee334d4816a))
|
|
44
|
+
* formatting ([4dd16a4](https://github.com/snakemake/snakemake-report-plugin-nanopub/commit/4dd16a4a5479b86b2e5787b9462e05a40944fe2c))
|
|
45
|
+
* formatting ([e4004ba](https://github.com/snakemake/snakemake-report-plugin-nanopub/commit/e4004ba70b8beadd92c0aa3b741e2bf10cd67933))
|
|
46
|
+
* formatting ([e99f991](https://github.com/snakemake/snakemake-report-plugin-nanopub/commit/e99f991ea544391b37c9758802f820d494c59557))
|
|
47
|
+
* formatting ([be4dbf2](https://github.com/snakemake/snakemake-report-plugin-nanopub/commit/be4dbf2e82e129537eb80b27c6fbdc0326314e6c))
|
|
48
|
+
* linint - removed unused import ([30f4dd2](https://github.com/snakemake/snakemake-report-plugin-nanopub/commit/30f4dd2f84d906b1dd53051c58041a10cf5e7635))
|
|
49
|
+
* linting ([54148e8](https://github.com/snakemake/snakemake-report-plugin-nanopub/commit/54148e8740e7e183f6ca7d0f70202810d0200bba))
|
|
50
|
+
* merge conflict ([d793fd4](https://github.com/snakemake/snakemake-report-plugin-nanopub/commit/d793fd46fa4ebe54d53ab83d49f70ac53e211c2c))
|
|
51
|
+
* name ([696215c](https://github.com/snakemake/snakemake-report-plugin-nanopub/commit/696215c31ee1f1bf2aee2055fe7a25648607537b))
|
|
52
|
+
* nanopub-py is a pypi not a conda dep ([a291029](https://github.com/snakemake/snakemake-report-plugin-nanopub/commit/a291029da2207360018cd6272de8500a0a4542e6))
|
|
53
|
+
* relaxing system requirements to work on cluster envs ([04c4276](https://github.com/snakemake/snakemake-report-plugin-nanopub/commit/04c4276e353c9f7e6488487f615d2efe5169c6ac))
|
|
54
|
+
* removed unused import ([405caf0](https://github.com/snakemake/snakemake-report-plugin-nanopub/commit/405caf088f92f6e6c47a936d217f8c63b45fd48a))
|
|
55
|
+
* reverting to snakemake's global logger, added comments ([a245dc3](https://github.com/snakemake/snakemake-report-plugin-nanopub/commit/a245dc3d26a4a1efb615df7ace092d5806b24b98))
|
|
56
|
+
* somewhat improved string handling to comply with all tests ([716deb1](https://github.com/snakemake/snakemake-report-plugin-nanopub/commit/716deb10d14f7fc8e00dfd26825744b2466de5d2))
|
|
57
|
+
* spelling ([55f4a49](https://github.com/snakemake/snakemake-report-plugin-nanopub/commit/55f4a499f59dddfd4e8b3b92f4e886106453b46d))
|
|
58
|
+
* stripping html tags from workflow description ([8e49dce](https://github.com/snakemake/snakemake-report-plugin-nanopub/commit/8e49dcee0641f81a0246198fef9bd967b9db4007))
|
|
59
|
+
* switching to 'Dataset() from 'ConjunctiveGraph()' to avoid deprecation warnings ([1604bfb](https://github.com/snakemake/snakemake-report-plugin-nanopub/commit/1604bfb5096c2a82b515ac538692ac7dea9c50fd))
|
|
60
|
+
* test dependencies ([e32da0f](https://github.com/snakemake/snakemake-report-plugin-nanopub/commit/e32da0fe7a15566f05ccf49f98d86eddde3f2c2e))
|
|
61
|
+
* testing ([c07a189](https://github.com/snakemake/snakemake-report-plugin-nanopub/commit/c07a18900dd71fd612f97f3f25d033335d62bc4d))
|
|
62
|
+
* typo ([66b19a2](https://github.com/snakemake/snakemake-report-plugin-nanopub/commit/66b19a2eba0754e48074b0a231130515a91baf4c))
|
|
63
|
+
|
|
64
|
+
|
|
65
|
+
### Documentation
|
|
66
|
+
|
|
67
|
+
* added actual documentation ([0a6a619](https://github.com/snakemake/snakemake-report-plugin-nanopub/commit/0a6a619245e06a4be8d4393d813c633c8066d413))
|
|
68
|
+
* added intro section about nanopublications ([21fe950](https://github.com/snakemake/snakemake-report-plugin-nanopub/commit/21fe950d50a706aa2dd70bfc0fb65890ece30ad5))
|
|
69
|
+
* first rough README ([94853a2](https://github.com/snakemake/snakemake-report-plugin-nanopub/commit/94853a28ebae76d29c0261b2f6f3fa85f898a60f))
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2025 Snakemake
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: snakemake-report-plugin-nanopub
|
|
3
|
+
Version: 0.1.0
|
|
4
|
+
Summary: Reporter plugin for Snakemake using nanopub-py to create workflow metadata nanopubs
|
|
5
|
+
Project-URL: repository, https://github.com/snakemake/snakemake-report-plugin-nanopub
|
|
6
|
+
Project-URL: documentation, https://snakemake.github.io/snakemake-plugin-catalog/plugins/report/nanopub.html
|
|
7
|
+
Author-email: Christian Meesters <meesters@uni-mainz.de>
|
|
8
|
+
License-File: LICENSE
|
|
9
|
+
Requires-Python: <4.0,>=3.12
|
|
10
|
+
Requires-Dist: nanopub>=2.2.0
|
|
11
|
+
Requires-Dist: snakemake-interface-common<2.0.0,>=1.17.4
|
|
12
|
+
Requires-Dist: snakemake-interface-report-plugins<2.0.0,>=1.1.0
|
|
13
|
+
Description-Content-Type: text/markdown
|
|
14
|
+
|
|
15
|
+
[](https://snakemake.github.io)
|
|
16
|
+
[](https://conventionalcommits.org)
|
|
17
|
+
|
|
18
|
+
**Please note**: This plugin is work in progress and NOT ready to use.
|
|
19
|
+
|
|
20
|
+
**Its intention**:
|
|
21
|
+
|
|
22
|
+
- users will be enabled to automatically create a [nanopub](https://nanopub.net/) using a workflow's metadata
|
|
23
|
+
- this nanopub can subsequently be referenced in publications and thereby covering __all__ metadata necessary to scrutinize an analysis (all too often crucial data are missing from publications)
|
|
24
|
+
|
|
25
|
+
## CLI: plot nanopub knowledge graph
|
|
26
|
+
|
|
27
|
+
After installation, run:
|
|
28
|
+
|
|
29
|
+
```bash
|
|
30
|
+
plot-nanopub-knowledge-graph \
|
|
31
|
+
--dataset-nanopub-id <dataset_nanopub_url> \
|
|
32
|
+
--workflow-nanopub-id <workflow_nanopub_url> \
|
|
33
|
+
--workflow-configuration-id <workflow_configuration_nanopub_url> \
|
|
34
|
+
--report-nanopub-id <report_nanopub_url> \
|
|
35
|
+
-o graph.png
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
This generates a Graphviz plot with four rounded boxes (`Dataset`, `Workflow`, `Workflow Configuration`, `Workflow Report`) and arrows labeled `used by`, `used this configuration`, `produces`, and `based upon`.
|
|
39
|
+
|
|
40
|
+
Optional settings:
|
|
41
|
+
|
|
42
|
+
- `--line-color "dark brick red"` (default) for node border and arrow color
|
|
43
|
+
- `--format svg|png|pdf` to override output format
|
|
44
|
+
- `--verbose` to print debug logs for nanopub description extraction
|
|
45
|
+
- `--text-width 60` to control line wrapping width in box text
|
|
46
|
+
|
|
47
|
+
Default output format is `png`.
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
[](https://snakemake.github.io)
|
|
2
|
+
[](https://conventionalcommits.org)
|
|
3
|
+
|
|
4
|
+
**Please note**: This plugin is work in progress and NOT ready to use.
|
|
5
|
+
|
|
6
|
+
**Its intention**:
|
|
7
|
+
|
|
8
|
+
- users will be enabled to automatically create a [nanopub](https://nanopub.net/) using a workflow's metadata
|
|
9
|
+
- this nanopub can subsequently be referenced in publications and thereby covering __all__ metadata necessary to scrutinize an analysis (all too often crucial data are missing from publications)
|
|
10
|
+
|
|
11
|
+
## CLI: plot nanopub knowledge graph
|
|
12
|
+
|
|
13
|
+
After installation, run:
|
|
14
|
+
|
|
15
|
+
```bash
|
|
16
|
+
plot-nanopub-knowledge-graph \
|
|
17
|
+
--dataset-nanopub-id <dataset_nanopub_url> \
|
|
18
|
+
--workflow-nanopub-id <workflow_nanopub_url> \
|
|
19
|
+
--workflow-configuration-id <workflow_configuration_nanopub_url> \
|
|
20
|
+
--report-nanopub-id <report_nanopub_url> \
|
|
21
|
+
-o graph.png
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
This generates a Graphviz plot with four rounded boxes (`Dataset`, `Workflow`, `Workflow Configuration`, `Workflow Report`) and arrows labeled `used by`, `used this configuration`, `produces`, and `based upon`.
|
|
25
|
+
|
|
26
|
+
Optional settings:
|
|
27
|
+
|
|
28
|
+
- `--line-color "dark brick red"` (default) for node border and arrow color
|
|
29
|
+
- `--format svg|png|pdf` to override output format
|
|
30
|
+
- `--verbose` to print debug logs for nanopub description extraction
|
|
31
|
+
- `--text-width 60` to control line wrapping width in box text
|
|
32
|
+
|
|
33
|
+
Default output format is `png`.
|