markdown-it-reporter

0.0.2 verified Fri May 01 auth: no python

A library to convert Galaxy Workflow Format 2 (GWF2) descriptions to Markdown reports. Current version: 0.0.2. Pre-release, low cadence.

pip install markdown-it-reporter

Common errors

error ModuleNotFoundError: No module named 'markdown-it-reporter' ↓

cause Trying to import using hyphens instead of underscores.

fix

Install with pip install markdown-it-reporter but import as markdown_it_reporter.

error AttributeError: module 'markdown_it_reporter' has no attribute 'M2RT' ↓

cause Typo or wrong case for the class name.

fix

Use from markdown_it_reporter import M2RT (uppercase).

gotcha Very early stage (0.0.2): API is unstable and likely incomplete. Expect breaking changes. ↓

fix Pin to exact version if depending on it. Check GitHub for updates.

gotcha The correct import uses underscores in module name: `from markdown_it_reporter import M2RT`. Do not use hyphens. ↓

fix Use `import markdown_it_reporter` not `markdown-it-reporter`.

M2RT

wrong

from markdown_it_reporter import m2rt

correct

from markdown_it_reporter import M2RT

Exact class name is uppercase M2RT

GWF2

from markdown_it_reporter.gwf2 import GWF2

Basic instantiation and markdown output.

from markdown_it_reporter import M2RT

# minimal usage
report = M2RT()
# report.load(...) # see docs for actual API
print(report.md)