Projekt slouží k vytvoření receptáře nejenom pro účastníky kurzů a workshopů PyLadies a jejich organizátory.
Pro instalaci receptáře není nic specifického potřeba krom několika bodů:
- Mít nainstalovaný Python (např. z těchto stránek), ideálně ve verzi 3.6
- Stáhnout si poslední verzi repozitáře z Githubu v zabaleném souboru ZIP nebo si jej můžete naklonovat (git clone) z adresy https://github.com/hroncok/receptar
- V případě stažení souboru ZIP je potřeba jej rozbalit do vámi zvolené vybrané složky
- Pro klonovaný repozitář pomocí clone rozbalování není nutné
Pro spuštění Receptáře potřebujete:
- V příkazové řádce změnit aktuální složku na takovou, do níž jste rozbalili stažený ZIP či v níž naklonovaný repozitář z Githubu pomocí clone
- V příkazové řádce či terminálu spustit příkaz máte-li nainstalovaný Python ve verzi 3.6 a vyšší
$ python3 receptar.py
Aktuální verzi Pythonu, který máte nainstalovaný, můžete určit spuštěním
$ python3 --version
Po spuštění programu a vypsání všech receptů si je můžete postupně projít a pokud je to alespoň trochu možné, tak dodržovat doporučené postupy uvedené v receptech. Autoři receptáře nenesou zodpovědnost za újmu způsobenou nedodržením doporučených postupů.
Jak spustit testy:
$ python3 -m pytest tests
Testování by bylo fajn, nicméně nemáme na něj dostatečnou lidskou kapacitu. Můžeš se zapojit do rozvoje projektu a testy nám pomoci připravit.
Pokud byste měli zájem se podílet na spolutvorbě tohoto Receptáře, napište prosím soukromou zprávu autorovi projektu @hroncok či proveďte u sebe lokální změny a zašlete Pull request na původní projekt. Autoři budou velmi rádi za jakékoliv kontruktivní návrhy, které vylepší stávající úroveň Receptáře k lepšímu ✨.
Původním autorem a majitelem projektu je @hroncok, pod jehož dohledem je receptář udržován. Dalšími autorkami a autory jsou účastníci workshopů a různých eventů od PyLadies.
Protože samozřejmě víme jak moc je důležité duševní vlastnictví a jeho ochrana, tak i tento projekt je chráněn licencí. Používáme licenci MIT (více na odkaz)