biocore/empress

Document Empress' existing python API

Aberta

#426 aberto em 16 de out. de 2020

Ver no GitHubGuia do colaborador
 (0 comentário) (0 reação) (0 responsável)JavaScript (32 forks)auto 404
documentationgood first issue

Métricas do repositório

Stars
 (56 estrelas)
Métricas de merge de PR
 (Métricas PR pendentes)

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.

Guia do colaborador

Direção de pesquisa
Examine a API Python existente no Empress, particularmente o script `make dev page.py`, e crie um Jupyter notebook demonstrando como usar o Empress via Python. Em seguida, atualize o README para linkar o notebook.
Pilha de tecnologia
python
Domain
backend
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Meio dia
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
PythonJupyter Notebook
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
70