add an HTTP API
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 5/5
- Tempo stimato
- Più di una settimana
- Idoneità per principianti
- 42/100
Direzione di ricerca
Inizia tracciando l’endpoint /explain esistente e il modo in cui analizza i comandi e produce le corrispondenze della guida. Definisci la risposta di GET /api/explain?cmd=... usando i campi proposti help, cmd e matches, incluso il testo della guida duplicato e le modifiche ai comandi come la gestione di Unicode. Il lavoro è completato quando un endpoint HTTP restituisce il JSON documentato per l’esempio echo -n e test di integrazione adeguati coprono il suo comportamento.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
It might be time to add an HTTP API for tools/websites that want to integrate with explainshell (issue #4 is one).
My current thought is to add a GET endpoint at /api/explain with a cmd parameter, similar to /explain. The response could be a JSON that looks something like this:
{
'help' : ['help text 0', 'help text 1', ..],
'cmd' : <parsed command>
'matches' : [{'startindex' : x,
'endindex' : y,
'helpindex' : <index into help array, or -1 if unknown>], [..]]
}
The rationale for not inlining the help text into matches is that there can be duplicates. The reason for including cmd in the response is that it's possible for explainshell to change it, e.g. due to unicode which is not supported yet.
Example:
GET /api/explain?cmd=echo -n
{
'help' : ['display a line of text',
'-n do not output the trailing newline'],
'cmd' : 'echo -n'
'matches' : [{'startindex' : 0, 'endindex' : 4, 'helpindex' : 0},
{'startindex' : 5, 'endindex' : 7, 'helpindex' : 1}]
}
- Lingua principale
- Python
- Stelle
- 14.2k
- Fork
- 851
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Preparare l'ambiente
Non abbiamo ancora controllato i file di configurazione di questo progetto. Parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di idank/explainshell
-
`test -s` shows all optionsAperta
Difficoltà 2/5 1-3 ore Idoneità per principianti 75/100
idank/explainshell#367 ·
-
Difficoltà 3/5 1-2 giorni Idoneità per principianti 65/100
idank/explainshell#365 · 2 commenti ·
-
Difficoltà 4/5 3-5 giorni Idoneità per principianti 35/100
idank/explainshell#354 · 2 commenti · 4 reazioni ·
-
Difficoltà 3/5 1-2 giorni Idoneità per principianti 45/100
idank/explainshell#343 ·
-
Difficoltà 5/5 Più di una settimana Idoneità per principianti 25/100
idank/explainshell#327 ·
Tutte le issue di idank/explainshell
Issue simili
-
pydanty:is-working
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
pydantic/pydantic-ai#8843 ·
I maintainer di solito rispondono entro 1 giorno
-
breaking change enhancement server
Difficoltà 2/5 1-3 ore Idoneità per principianti 72/100
I maintainer di solito rispondono entro 1 giorno
-
bug
Difficoltà 2/5 1-3 ore Idoneità per principianti 88/100
sktime/sktime#11310 · 1 commento ·
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 72/100
I maintainer di solito rispondono entro 1 giorno
-
needs-triage
Difficoltà 2/5 1-3 ore Idoneità per principianti 85/100
I maintainer di solito rispondono entro 1 giorno