Okydoky

Okydoky er en automatiseret dokumentation builder hjælp Sphinx, distribuere og GitHub (som var setuptools) & nbsp; Det gør din lukket Python projekt til løbende at opbygge dokumentation, med følgende forudsætninger.:
1. Dokumentation sker ved hjælp Sphinx.
2. Projekt er pakket gennem setuptools (ikke pip eller nogen andre).
3. Kildekode forvaltes under GitHub.
At sige om kort tid, det er simpelthen en ReadTheDocs.org til privat brug.
Sådan virker
Det virker i følgende instruktioner:
1. Når nye begår skubbes, GitHub udløser Okydoky post-modtager krog.
2. Okydoky downloads tar-arkiv arkiver skubbes begår fra GitHub.
3. tarball arkiv bliver ekstraheret i en midlertidig mappe.
4. Sphinx bygger dokumentationen.
5. Når brugere anmode docs ved hjælp af deres webbrowser, Okydoky beder brugeren om at godkende at bruge GitHub OAuth.
6. Hvis de har tilladelsen, Okydoky serverer en indbygget docs.
Sådan bruger
Det er en almindelig Python-pakke. Du kan installere den ved hjælp easy_install:
& Nbsp; easy_install Okydoky
Denne pakke indeholder en kommandolinje script kaldet okydoky. Det er en web-applikation, og også en lille webserver for sig selv. Det tager en konfigurationsfil.
Konfig filerne skal indeholde nogle nødvendige værdier som GitHub ansøgning nøgle og hemmelig nøgle.
Du er nødt til at oprette en GitHub program til at bruge Okydoky. Dens tilbagekaldswebadresse er meget vigtigt. Fyld den med:
http: // / auth / Afslut
og erstatter med domænenavnet, hvad du vil bruge. Og så tilføjer en post-modtager krog i din GitHub repository:
http: // /
Hvis du laver en config fil, derefter køre en Okydoky server ved hjælp okydoky script:
& Nbsp; okydoky -H 0.0.0.0 -p 8080 yourconfig.py
Endelig er du nødt til at foretage en indledende auth at afslutte installationen. Åbent http: // / i din browser og login med GitHub derfra.
Konfiguration
Den config fil er en normal Python script. Det bruger Flask config system. Læs kolbens docs om config filer.
Repository
& Nbsp; Brugeren og repository navn f.eks »Crosspop / okydoky«.
Client_id
& Nbsp; Den GitHub applikationens klient nøgle.
CLIENT_SECRET
& Nbsp; Den GitHub programmets hemmelige nøgle.
SAVE_DIRECTORY
& Nbsp; Stien til mappen til at gemme data. Denne mappe vil gemme nogle konfigurerede data, tarballs og byggede dokumentationer.
SECRET_KEY
& Nbsp; Den hemmelige nøgle til at underskrive sessioner. Se kolbens docs om sessioner også.
Open source
Okydoky er skrevet af Hong Minhee for Crosspop. Det er distribueret under MIT licens, og kildekoden kan findes i GitHub repository. Tjek:
& Nbsp; git klon git: //github.com/crosspop/okydoky.git

Hvad er nyt i denne udgivelse:

• GitHub tvungen tilstand for OAuth. Følg det.

Hvad er nyt i version 0.9.4:

• Brug --upgrade mulighed for setup.py udvikle kommando. Dette forhindrer udgave konflikter afhængigheder.
• Byg logs tilbage i build.txt filen.

Hvad er nyt i version 0.9.3:

• Nu indekssiden viser en liste over dommere.
• Nu Okydoky sæt OKYDOKY = 1 miljøvariabel under dets byggeprocessen. [# 5]
• Tilføj / hoved særlige ref url.
• Rettet en fejl, at hovedet ikke er indstillet til den seneste begå.

Hvad er nyt i version 0.9.2:

• Rettet en sikkerhed bug: nu brugere skal have en tilladelse til lageret. [# 4]

Krav :

• Python