Okydoky

Okydoky este un constructor de documentare automată folosind Sfinxul, distribui și GitHub (care a fost setuptools) & nbsp; Se face proiectul dumneavoastră Python închis pentru a construi continuu documentatii, cu următoarele ipoteze.:
1. Documentația se face folosind Sfinxul.
2. Proiectul este ambalat prin setuptools (nu pip și nici altele).
3. Codul sursă este gestionat în GitHub.
Pentru a spune pe scurt, este pur și simplu o ReadTheDocs.org pentru uz personal.
Cum funcționează
Acesta funcționează în următoarele instrucțiuni:
1. Atunci când noi comite sunt împinse, GitHub declanseaza Okydoky post-primi cârlig.
2. descărcări Okydoky tar arhive ale comite împins de la GitHub.
3. arhiva Tarball se extrage într-un director temporar.
4. Sfinxul construiește documentația.
5. Atunci când utilizatorii solicita docs folosind browser-ul lor web, Okydoky cere utilizatorului să se autentifice folosind GitHub OAuth.
6. În cazul în care are autorizația, Okydoky servește o construit documente.
Cum să utilizați
Este un pachet Python obișnuit. Puteți să-l instala folosind easy_install:
& Nbsp; easy_install Okydoky
Acest pachet oferă un script linie de comandă denumit okydoky. Este o aplicație web și, de asemenea, un server web mic de la sine. Este nevoie de un fișier de configurare.
Fișierele de configurare trebuie să conțină anumite valori necesare, cum ar fi cheie de aplicație GitHub și cheia secretă.
Trebuie să creați o aplicație GitHub pentru a utiliza Okydoky. Sa Callback URL-ul este foarte important. Umple-l cu:
http: // / autorizare / finalizare
și înlocuiește cu numele de domeniu ce veți folosi. Și apoi, se adaugă un mesaj primi cârlig în depozit ta GitHub:
http: // /
Dacă faceți un fișier de configurare, apoi executați un server Okydoky folosind script okydoky:
& Nbsp; H okydoky 0.0.0.0 -p 8080 yourconfig.py
În cele din urmă, va trebui să facă o autorizare inițială a termina instalarea. Deschis http: // / din browser-ul web și autentificati cu GitHub de acolo.
Configurare
Fișierul de configurare este un script Python obișnuit. Acesta utilizează sistemul de config Flask lui. Citește documente Flask despre fișiere de configurare.
MAGAZIE
& Nbsp; numele de utilizator și depozit de exemplu "Crosspop / okydoky".
CLIENT_ID
& Nbsp; cheie client Cererea GitHub lui.
CLIENT_SECRET
& Nbsp; cheie secretă Cererea GitHub lui.
SAVE_DIRECTORY
& Nbsp; Calea directorului pentru a stoca date. Acest director va stoca unele date, arhive tar, si documentatii construit configurate.
SECRET_KEY
& Nbsp; cheia secretă a semna sesiuni. Vezi docs Flask de aproximativ sesiuni, de asemenea.
Open source
Okydoky este scris de Hong Minhee pentru Crosspop. Este distribuit sub licenta MIT, iar codul sursă poate fi găsit în magazia GitHub. Verifică:
& Nbsp; git clone git: //github.com/crosspop/okydoky.git

Ce este nou în această versiune:

• GitHub forțat de stat pentru OAuth. Urmărește.

Ce este nou în versiunea 0.9.4:

• Utilizați opțiunea --upgrade pentru setup.py se dezvolta comandă. Acest lucru previne conflictele versiune de dependențe.
• Construiți busteni sunt lăsate în fișierul build.txt.

Ce este nou în versiunea 0.9.3:

• Acum pagina de index arată lista de ref.
• Acum seturi Okydoky OKYDOKY = variabila de mediu 1 în timpul procesului de construcție. [# 5]
• Adăugați / cap special url ref.
• Fixed un bug care capul nu este setat la cele mai recente comite.

Ce este nou în versiunea 0.9.2:

• Fixed un bug de securitate: acum utilizatorii trebuie să aibă o autorizație pentru magazia. [# 4]

Cerințe :

• Python