biocore/empress

Document Empress' existing python API

Open

#426 opened on Oct 16, 2020

View on GitHubContributor guide
 (0 comments) (0 reactions) (0 assignees)JavaScript (32 forks)auto 404
documentationgood first issue

Repository metrics

Stars
 (56 stars)
PR merge metrics
 (PR metrics pending)

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.

Contributor guide

Research direction
Examine the existing Python API in Empress, particularly the `make dev page.py` script, and create a Jupyter notebook demonstrating how to use Empress via Python. Then update the README to link to the notebook.
Tech stack
python
Domain
backend
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
PythonJupyter Notebook
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70