Okydoky

Okydoky è un costruttore di documentazione automatizzata utilizzando Sfinge, distribuire e GitHub (che era setuptools) & nbsp; Rende il progetto Python chiusa per costruire continuamente documentazione, con le seguenti ipotesi.:
1. La documentazione è fatto usando Sfinge.
2. Progetto è confezionato tramite setuptools (non pip né tutti gli altri).
3. Il codice sorgente è gestito sotto GitHub.
Per dire poco, è semplicemente una ReadTheDocs.org per uso privato.
Come funziona
Essa opera nei seguenti istruzioni:
1. Quando i nuovi commit sono spinti, GitHub innesca Okydoky post-ricezione gancio.
2. Download Okydoky tarball archivi di commit spinto da GitHub.
3. archivio tarball viene estratto in una directory temporanea.
4. Sfinge costruisce la documentazione.
5. Quando gli utenti richiedono i documenti utilizzando il proprio browser web, Okydoky chiede all'utente di autenticarsi tramite GitHub OAuth.
6. Se si ha l'autorizzazione, Okydoky serve una docs costruito.
Come utilizzare
Si tratta di un pacchetto di Python ordinario. È possibile installare utilizzando easy_install:
& Nbsp; easy_install Okydoky
Questo pacchetto fornisce uno script di riga di comando chiamato okydoky. Si tratta di un'applicazione web e anche un piccolo server web per sé. Ci vuole un file di configurazione.
I file di configurazione devono contenere alcuni valori richiesti, come chiave di applicazione GitHub e chiave segreta.
È necessario creare un'applicazione GitHub usare Okydoky. La richiamata URL è molto importante. Riempire con:
http: // / auth / finalize
e sostituisce con il nome di dominio quello che userete. E poi, aggiungere un-ricezione postale gancio nel repository GitHub:
http: // /
Se si fa un file di configurazione, quindi eseguire un server Okydoky utilizzando lo script okydoky:
& Nbsp; -H okydoky 0.0.0.0 -p 8080 yourconfig.py
Infine, è necessario effettuare una autenticazione iniziale per terminare l'installazione. Aprire http: // / nel browser Web ed effettuare il login con GitHub da lì.
Configurazione
Il file di configurazione è un normale script Python. Utilizza il sistema di configurazione di Flask. Leggi documentazione di Flask su file di configurazione.
REPOSITORY
& Nbsp; Il nome utente e la repository es 'Crosspop / okydoky'.
Client_id
& Nbsp; La chiave del client dell'applicazione GitHub.
CLIENT_SECRET
& Nbsp; La chiave segreta dell'applicazione GitHub.
Save_directory
& Nbsp; Il percorso della directory per memorizzare i dati. Questa directory memorizza alcuni dati, tarball, e documentazioni costruite configurati.
SECRET_KEY
& Nbsp; La chiave segreta per firmare le sessioni. Vedi documentazione di pallone circa sessioni anche.
Open source
Okydoky è scritto da Hong Minhee per Crosspop. È distribuito sotto licenza MIT, e il codice sorgente può essere trovato nel repository GitHub. Alla cassa:
& Nbsp; git clone git: //github.com/crosspop/okydoky.git

Cosa c'è di nuovo in questa versione:

• GitHub costretto Stato per OAuth. Seguire questo.

Cosa c'è di nuovo nella versione 0.9.4:

• Utilizza opzione --upgrade per setup.py sviluppare comando. Questo impedisce conflitti di versione delle dipendenze.
• Creare log vengono lasciati nel file build.txt.

Cosa c'è di nuovo nella versione 0.9.3:

• Ora la pagina indice mostra l'elenco dei arbitri.
• Ora set Okydoky OKYDOKY = variabile di 1 ambiente durante il suo processo di generazione. [# 5]
• Aggiungi / head speciale rif url.
• Risoluzione di un errore che la testa non è impostato per l'ultimo commesso.

Cosa c'è di nuovo nella versione 0.9.2:

• Risolto un bug di sicurezza: ora gli utenti devono avere un l'autorizzazione per il repository. [# 4]

Requisiti :

• Python