Okydoky

Okydoky er en automatisert dokumentasjon byggmester hjelp Sphinx, distribuere og GitHub (som var setuptools) & nbsp; Det gjør stengt Python prosjekt for å kontinuerlig bygge dokumentasjoner, med følgende forutsetninger.:
1. Dokumentasjon er gjort ved hjelp Sphinx.
2. Prosjekt er pakket gjennom setuptools (ikke pip eller noen andre).
3. Kildekode forvaltes etter GitHub.
Å si kort tid, er det rett og slett en ReadTheDocs.org for privat bruk.
Hvordan det fungerer
Det fungerer på følgende måte:
1. Når nye innlegginger er presset, utløser GitHub Okydoky etter motta kroken.
2. Okydoky nedlastinger tarball arkiver presset inger fra GitHub.
3. tarball arkiv blir hentet inn i en midlertidig katalog.
4. Sphinx bygger dokumentasjonen.
5. Når brukere be docs bruker deres nettleser, spør Okydoky brukeren å autentisere bruker GitHub OAuth.
6. Hvis de har autorisasjon, serverer Okydoky en inne docs.
Hvordan bruke
Det er en vanlig Python-pakken. Du kan installere det ved hjelp easy_install:
& Nbsp; easy_install Okydoky
Denne pakken inneholder en kommandolinje skript som heter okydoky. Det er en web-applikasjon, og også en liten webserver for seg selv. Det tar en config fil.
Config filer må inneholde noen nødvendige verdier som GitHub programtast og hemmelig nøkkel.
Du må opprette en GitHub program for å bruke Okydoky. Dens URL for tilbakeringing er svært viktig. Fyll den med:
http: // / auth / sluttføre
og erstatter med domenenavnet hva du vil bruke. Og deretter legge til en post-motta kroken inn din GitHub depotet:
http: // /
Hvis du gjør en config-fil, og deretter kjøre en Okydoky server ved hjelp okydoky skript:
& Nbsp; okydoky -H 0.0.0.0 -p 8080 yourconfig.py
Til slutt, du har å gjøre en innledende auth å fullføre installasjonen. Åpne http: // / i nettleseren og logg inn med GitHub derfra.
Konfigurasjon
Konfigurasjonsfilen er en normal Python-skript. Den bruker Flask er config system. Les Flask er docs om config filer.
Repository
& Nbsp; Brukeren og depotnavn f.eks 'Crosspop / okydoky'.
CLIENT_ID
& Nbsp; The GitHub programmets klient nøkkel.
CLIENT_SECRET
& Nbsp; The GitHub programmets hemmelige nøkkelen.
SAVE_DIRECTORY
& Nbsp; Banen til katalogen for å lagre data. Denne katalogen vil lagre noen prosjekterte data, tarballs, og bygget dokumentasjon.
SECRET_KEY
& Nbsp; Den hemmelige nøkkelen til å signere økter. Se Flask er docs om økter også.
Åpen kildekode
Okydoky er skrevet av Hong Minhee for Crosspop. Det er distribuert under MIT-lisensen, og kildekoden kan bli funnet i GitHub depotet. Sjekk ut:
& Nbsp; git clone git: //github.com/crosspop/okydoky.git

Hva er nytt i denne utgaven:

• GitHub tvunget staten for OAuth. Følg det.

Hva er nytt i versjon 0.9.4:

• Bruk --upgrade alternativ for setup.py utvikle kommando. Dette hindrer versjon konflikter av avhengigheter.
• Bygg loggene er igjen i build.txt fil.

Hva er nytt i versjon 0.9.3:

• Nå indeksen siden viser listen over refs.
• Nå Okydoky sett OKYDOKY = en miljøvariabel i løpet av sin byggeprosessen. [# 5]
• Legg til / hode spesiell ref url.
• Fikset en bug at hodet ikke er satt til den nyeste begå.

Hva er nytt i versjon 0.9.2:

• Fikset en sikkerhet bug: nå brukerne må ha en autorisasjon for depotet. [# 4]

Krav :

• Python