biocore/empress

Document Empress' existing python API

Offen

#426 geöffnet am 16.10.2020

Auf GitHub ansehenContributor Guide
 (0 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)JavaScript (32 Forks)auto 404
documentationgood first issue

Repository-Metriken

Stars
 (56 Sterne)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

It's currently possible to use Empress through Python, even outside of QIIME 2 (so long as all needed dependencies are installed). This is already done in the make-dev-page.py test script. However, this isn't really advertised anywhere.

It'd be nice to add a Jupyter Notebook (similar to what Emperor has in its repository) that documents this API. Linking such a notebook from the README would, in tandem with #425, probably help expand the tool's user base a decent amount.

Contributor Guide

Research-Richtung
Untersuchen Sie die vorhandene Python API in Empress, insbesondere das Skript `make dev page.py`, und erstellen Sie ein Jupyter Notebook, das die Verwendung von Empress über Python demonstriert. Aktualisieren Sie dann die README, um auf das Notebook zu verlinken.
Tech Stack
python
Domain
backend
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Halber Tag
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
PythonJupyter Notebook
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
70