updated README
This commit is contained in:
parent
4aa89a7256
commit
798681c47c
1 changed files with 14 additions and 4 deletions
18
README.md
18
README.md
|
@ -5,9 +5,10 @@ Určeno pro registraci organizátorů seminářů na MFF UK.
|
|||
## Build
|
||||
|
||||
Build má následující závislosti:
|
||||
* pipenv
|
||||
* [Pipenv](https://pipenv.readthedocs.io/en/latest/)
|
||||
|
||||
Spouští se prostým zavoláním `pipenv sync`
|
||||
Po každém `git pull` je potřeba zavolat `pipenv sync`. Tím se sesynchronizují závislosti a všude se pak používají
|
||||
správné verze.
|
||||
|
||||
## Spouštění
|
||||
|
||||
|
@ -17,12 +18,21 @@ Vyžaduje Python 3.5 a novější.
|
|||
pipenv run python register.py --help
|
||||
```
|
||||
|
||||
Zbytek by měl být samovysvětlující. Stačí vyměnit argumenty dle nápovědy z `--help`.
|
||||
## Použití
|
||||
|
||||
Snaha je, aby se co nejvíce dokumentace nacházelo v kódu. Vysvětlení proto získáte zavoláním programu s argumentem
|
||||
`--help`. Žádné další informace by k tomu neměly být potřeba.
|
||||
|
||||
## Dokumentace API Gitei
|
||||
|
||||
Gitea má specifikaci API popsanou dle specifikace OpenAPI 2.0 (dříve nazýváno Swagger). Pokud není explicitně řečeno
|
||||
jinak, je tato specifikace vystavena na každé běžící instanci a to na cestě `/api/swagger`. Přesněji, na této cestě je
|
||||
standardní vygenerovaný webový interface ke specifikaci. Specifikace samotná se nachází (alespoň v době psaní) na cestě
|
||||
`/swagger.v1.json`.
|
||||
`/swagger.v1.json`.
|
||||
|
||||
K tomuto API je vygenerován klient aktuálně se nacházející
|
||||
[zde](https://gitea-gimli.kam.mff.cuni.cz/vasek/gitea-swagger-client). Kód je v podstatě čistě vygenerovaný nástrojem
|
||||
`swagger-codegen` (link v repozitáři s klientem). Obsahuje akorát dva drobné patche, protože bez nich vůbec nejde
|
||||
naimportovat.
|
||||
|
||||
`Pipenv` si z tohoto repozitáře stáhne kód a používá ho jako knihovnu.
|
Loading…
Reference in a new issue