biocore/empress

Document Empress' existing python API

Ouverte

#426 ouverte le 16 oct. 2020

Voir sur GitHubGuide contributeur
 (0 commentaire) (0 réaction) (0 personne assignée)JavaScript (32 forks)auto 404
documentationgood first issue

Métriques du dépôt

Stars
 (56 étoiles)
Métriques de merge PR
 (Métriques PR en attente)

Description

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.

Guide contributeur

Direction de recherche
Examinez l'API Python existante dans Empress, en particulier le script `make dev page.py`, et créez un notebook Jupyter démontrant comment utiliser Empress via Python. Mettez ensuite à jour le README pour lier le notebook.
Stack technique
python
Domaine
backend
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Une demi journée
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
PythonJupyter Notebook
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
70