Okydoky

Okydoky ist eine automatisierte Dokumentation Bauer mit Sphinx, Verteilen und GitHub (die Setuptools war) & nbsp; Es macht Ihre geschlossen Python Projekt stetig ausbauen Dokumentationen, mit den folgenden Annahmen.:
1. Dokumentation wird mit Sphinx getan.
2. Projekt wird durch Setuptools verpackt (nicht pip noch irgendwelche andere).
3. Der Quellcode wird unter GitHub verwaltet.
Um kurz zu sagen, es ist einfach ein ReadTheDocs.org für den privaten Gebrauch.
Wie es funktioniert
Es funktioniert in den folgenden Anweisungen:
1. Wenn neue Commits geschoben werden, GitHub löst Okydoky post erhalten Haken.
2. Okydoky Downloads Tarball Archiven geschoben Commits von GitHub.
3. Tarball-Archiv wird in ein temporäres Verzeichnis extrahiert.
4. Sphinx baut die Dokumentation.
5. Wenn Benutzer die Dokumentation mit ihren Web-Browser, fragt Okydoky den Benutzer zur Authentifizierung mittels OAuth GitHub.
6. Wenn Sie die Berechtigung, Okydoky dient eine integrierte Dokumentation.
Wie zu verwenden
Es ist ein gewöhnlicher Python-Paket. Sie können es mit easy_install installieren:
& Nbsp; easy_install Okydoky
Dieses Paket enthält eine Befehlszeile-Skript namens okydoky. Es ist eine Web-Anwendung und auch eine kleine Web-Server für sich. Es dauert eine Config-Datei.
Config-Dateien müssen einige erforderlichen Werte wie GitHub Anwendungsschlüssel und geheimen Schlüssel enthalten.
Sie müssen einen Antrag auf GitHub Okydoky verwenden können. Sein Callback URL ist sehr wichtig. Füllen Sie es mit:
http: // / auth / finalize
und ersetzt mit dem Domain-Namen, was Sie verwenden werde. Und dann, fügen Sie einen Post-Empfangshaken in Ihre GitHub-Repository:
http: // /
Wenn Sie eine Konfigurationsdatei zu machen, dann führen Sie eine Okydoky Server mit okydoky Skript:
& Nbsp; okydoky -H 0.0.0.0 -p 8080 yourconfig.py
Schließlich haben Sie, um eine erste auth um die Installation abzuschließen machen. Öffnen Sie http: // / in Ihren Webbrowser und melden Sie sich mit GitHub von dort.
Konfiguration
Die Konfigurationsdatei ist eine normale Python-Skript. Es verwendet Flask der Konfigurationssystem. Lesen Flask der docs über Konfigurationsdateien.
REPOSITORY
& Nbsp; Der Benutzer und Repository-Namen z 'Crosspop / okydoky'.
CLIENT_ID
& Nbsp; Client Schlüssel des GitHub Anwendung.
CLIENT_SECRET
& Nbsp; geheimen Schlüssel des GitHub Anwendung.
SAVE_DIRECTORY
& Nbsp; Der Pfad des Verzeichnisses zum Speichern von Daten. Dieses Verzeichnis wird einige konfigurierten Daten, Tarballs und baute Dokumentationen speichern.
Secret_key
& Nbsp; Der geheime Schlüssel, um Sitzungen zu unterzeichnen. Siehe Flask der docs zu Sitzungen auch.
Open source
Okydoky durch Hong Minhee für Crosspop geschrieben. Es ist unter der MIT-Lizenz vertrieben, und der Quellcode in der GitHub-Repository. Auschecken:
& Nbsp; git clone git: //github.com/crosspop/okydoky.git

Was ist neu in dieser Pressemitteilung:

• GitHub gezwungen Zustand für OAuth. Folgen Sie, dass.

Was ist neu in Version 0.9.4:

• Verwenden Sie --upgrade Option für setup.py entwickeln Befehl. Dadurch wird verhindert, Versionskonflikte von Abhängigkeiten.
• Bau-Protokolle werden in der Datei build.txt verlassen.

Was ist neu in Version 0.9.3:

• Nun ist die Index-Seite zeigt die Liste der Ref.
• Jetzt Okydoky Sätze OKYDOKY = 1 Umgebungsvariable während des Build-Prozesses. [# 5]
• Hinzufügen / Kopfsonder ref url.
• Ein Fehler wurde behoben, dass der Kopf nicht auf die neueste gesetzt begehen.

Was ist neu in Version 0.9.2:

• ein Sicherheits Fehler behoben: ein jetzt-Benutzer müssen Genehmigung für das Repository. [# 4]

Anforderungen :

• Python