Okydoky

Okydoky is 'n outomatiese dokumentasie bouer behulp Sphinx, versprei en GitHub (wat setuptools) & nbsp; Dit maak jou gesluit Python projek om voortdurend bou dokumentasie, met die volgende aannames.:
1. Dokumentasie word gedoen met behulp van Sphinx.
2. Projek is verpak deur setuptools (nie neut of enige ander).
3. Bronkode word bestuur onder GitHub.
Te kort sê, dit is net 'n ReadTheDocs.org vir private gebruik.
Hoe dit werk
Dit werk in die volgende instruksies:
1. Wanneer nuwe pleeg gestoot, GitHub snellers Okydoky post-ontvang haak.
2. Okydoky downloads Tarball argiewe van gestoot pleeg van GitHub.
3. Tarball argief kry onttrek in 'n tydelike gids.
4. Sphinx bou die dokumentasie.
5. Wanneer gebruikers versoek om die dokumente met behulp van hul webblaaier, Okydoky vra die gebruiker om te kontroleer, met GitHub OAuth.
6. As hulle het die magtiging, Okydoky dien 'n gebou docs.
Hoe om te gebruik
Dit is 'n gewone Python pakket. Jy kan dit installeer met behulp van easy_install:
& Nbsp; easy_install Okydoky
Hierdie pakket bied 'n command line script genoem okydoky. Dit is 'n web-program en ook 'n klein web bediener vir homself. Dit neem 'n config lêer.
Konfigurasielêers het 'n paar nodig om waardes soos GitHub aansoek sleutel en geheime sleutel te bevat.
Jy het 'n GitHub aansoek Okydoky te gebruik om te skep. Die verifikasie-URL is baie belangrik. Vul dit met:
http: // / auth / finaliseer
en vervang met die domein naam wat jy sal gebruik. En dan, voeg 'n post-ontvang haak in jou GitHub bewaarplek:
http: // /
As jy 'n config lêer, dan hardloop 'n Okydoky bediener met okydoky script:
& Nbsp; okydoky -H 0.0.0.0 p 8080 yourconfig.py
Laastens, jy het 'n aanvanklike auth installering klaar te maak te maak. Oop http: // / in jou webleser en meld met GitHub van daar af.
Konfigurasie
Die opstelling lêer is 'n normale Python script. Dit maak gebruik van Fies se config stelsel. Lees Fies's dokumente oor konfigurasielêers.
Repository
& Nbsp; Die gebruiker en bewaarplek naam bv 'Crosspop / okydoky.
CLIENT_ID
& Nbsp; Die GitHub aansoek se kliënt sleutel.
CLIENT_SECRET
& Nbsp; Die GitHub aansoek se geheime sleutel.
SAVE_DIRECTORY
& Nbsp; Die pad van die gids data te stoor. Hierdie gids sal 'n paar ingestel data, tarballs, en gebou dokumentasie stoor.
SECRET_KEY
& Nbsp; Die geheime sleutel sessies aan te meld. Sien Fies's dokumente oor sessies ook.
Open source
Okydoky is geskryf deur Hong Minhee vir Crosspop. Dit is versprei onder die MIT lisensie, en die bron-kode kan gevind word in die GitHub repository. Check uit:
& Nbsp; git kloon git: //github.com/crosspop/okydoky.git

Wat is nuut in hierdie release:

• GitHub gedwing staat vir OAuth. Volg dit.

Wat is nuut in die weergawe 0.9.4:

• Gebruik --upgrade opsie vir setup.py ontwikkel opdrag. Dit verhoed weergawe konflikte van afhanklikhede.
• Bou logs links in die build.txt lêer.

Wat is nuut in die weergawe 0.9.3:

• Nou die indeks bladsy toon die lys van refs.
• Nou Okydoky stelle OKYDOKY = 1 omgewing veranderlike tydens die bou proses. [# 5]
• Voeg by / kop spesiale ref url.
• Vaste 'n fout wat die hoof is nie ingestel op die jongste pleeg.

Wat is nuut in die weergawe 0.9.2:

• Vaste 'n sekuriteit fout: nou gebruikers moet 'n magtiging vir die repository. [# 4]

Vereistes :

• Python