Okydoky

Okydoky är en automatiserad dokumentation byggare använder Sphinx, Distribuera och GitHub (vilket var setuptools) & nbsp; Det gör din stängda Python-projektet att kontinuerligt bygga dokumentationer, med följande antaganden.:
1. Dokumentation sker med Sphinx.
2. Projekt är förpackad genom setuptools (inte pip eller några andra).
3. Källkod hanteras enligt GitHub.
Att säga inom kort, det är helt enkelt en ReadTheDocs.org för privat bruk.
Så här fungerar det
Det fungerar i följande instruktioner:
1. När nya åtar skjuts, GitHub utlöser Okydoky efter emot kroken.
2. Okydoky nedladdningar tarbollen arkiv drivit åtar från GitHub.
3. tarbollen arkiv blir heras i en tillfällig katalog.
4. Sphinx bygger dokumentationen.
5. När användare begär docs använder sin webbläsare, frågar Okydoky användaren att autentisera med hjälp GitHub OAuth.
6. Om de har tillstånd, Okydoky betjänar en inbyggd docs.
Så här använder
Det är en vanlig Python-paket. Du kan installera det med easy_install:
& Nbsp; easy_install Okydoky
Detta paket tillhandahåller ett kommandorad skript som heter okydoky. Det är en webbapplikation och även en liten webbserver för sig själv. Det tar en konfigurationsfil.
Konfigurationsfiler måste innehålla vissa nödvändiga värden som GitHub ansökan nyckel och hemlig nyckel.
Du måste skapa en GitHub programmet att använda Okydoky. Dess Callback URL är mycket viktigt. Fyll den med:
http: // / auth / Avsluta
och ersätter med domännamnet vad du ska använda. Och sedan, lägga till en post-emot krok i din GitHub förrådet:
http: // /
Om du gör en konfigurationsfil, kör sedan en Okydoky server med hjälp okydoky script:
& Nbsp; okydoky -H 0.0.0.0 -p 8080 yourconfig.py
Slutligen måste du göra en första auth att slutföra installationen. Öppna http: // / i din webbläsare och logga in med GitHub därifrån.
Konfiguration
Konfigurationsfilen är en normal Python-skript. Den använder Flask s config-system. Läs Flask s docs om konfigurationsfiler.
FÖRVARINGSPLATS
& Nbsp; Användarnamnet och förvars namn t.ex. 'Crosspop / okydoky'.
CLIENT_ID
& Nbsp; Den GitHub programmets klientnyckel.
CLIENT_SECRET
& Nbsp; Den GitHub ansökan hemliga nyckel.
SAVE_DIRECTORY
& Nbsp; Sökvägen till katalogen för att lagra data. Denna katalog kommer att lagra några konfigurerade data, tar-arkiv, och byggde dokumentationer.
SECRET_KEY
& Nbsp; Den hemliga nyckeln för att signera sessioner. Se Flask s docs om sessioner också.
Öppen källkod
Okydoky är skriven av Hong Minhee för Crosspop. Det distribueras under MIT-licens, och källkoden finns i GitHub förrådet. Checka ut:
& Nbsp; git clone git: //github.com/crosspop/okydoky.git

Vad är nytt i den här versionen:

• GitHub tvingade staten för OAuth. Följ den.

Vad är nytt i version 0.9.4:

• Använd --upgrade alternativ för setup.py utveckla kommandot. Detta förhindrar version konflikter av beroenden.
• Bygga loggar kvar i build.txt filen.

Vad är nytt i version 0.9.3:

• Nu indexsidan visar listan över refs.
• Nu Okydoky uppsättningar OKYDOKY = 1 miljövariabeln under dess byggprocessen. [# 5]
• Lägg till / head special ref url.
• Fixat en bugg som huvudet inte är inställd på den senaste commit.

Vad är nytt i version 0.9.2:

• Fixat en säkerhets bugg: Nu användare måste ha en tillstånd för förvaret. [# 4]

Krav :

• Python