Okydoky

Okydoky е автоматизирана документация строител използване Сфинкса, разпространявате и GitHub (която беше setuptools) & Nbsp; Прави си затвори проект Python непрекъснато да се изгради документации, със следните предположения.:
1. Документация се извършва с помощта Сфинкс.
2. Проект е опакован чрез setuptools (не семки, нито каквито и да било други).
3. Изходният код се управлява по GitHub.
Да се ​​каже, скоро, това е просто ReadTheDocs.org за лично ползване.
<Силен> Как работи
Тя работи в следните инструкции:
1. Когато нови Ангажира се бутат, GitHub задейства Okydoky след получавате кука.
2. Okydoky сваляния архив, архивите на избута заявява ангажимента от GitHub.
3. Tarball архив получава екстрахира във временна директория.
4. Сфинкс изгражда документацията.
5. Когато Потребителите поискат от докторите, които използват своите уеб браузър, Okydoky пита потребителя за удостоверяване с помощта GitHub OAuth.
6. Ако те има разрешението, Okydoky сервира построени Docs.
<Силен> Как да използвате
Това е един обикновен Python пакет. Можете да го направите, като използвате easy_install:
& Nbsp; easy_install Okydoky
Този пакет предлага скрипт команден ред, наречена okydoky. Това е уеб приложение, а също и малък уеб сървър за себе си. Отнема конфигурационния файл.
Конфигурационни файлове трябва да съдържат необходимите ценности като GitHub ключово приложение и секретен ключ.
Трябва да се създаде приложение GitHub да използвате Okydoky. Нейната обр URL е много важно. Запълнете го с:
HTTP: // <хост> / AUTH / финализира
и заменя <хост> с името на домейна, това, което ще се използва. И след това, добави след получавате кука във вашия GitHub хранилището:
HTTP: // <хост> /
Ако направите конфигурационния файл, след това пуснете Okydoky сървър посредством okydoky скрипт:
& Nbsp; okydoky -Н 0.0.0.0 -p 8080 yourconfig.py
На последно място, трябва да се направи първоначална AUTH да завърши инсталацията. Open HTTP: // <хост> / във вашия уеб браузър и влезте с GitHub от там.
<Силен> Configuration
Файлът довереник е нормална Python скрипт. Той използва довереник система колбата. Прочетете Документи колбата за конфигурационни файлове.
ХРАНИЛИЩЕ
& Nbsp; Потребителското име и хранилище напр "Crosspop / okydoky".
CLIENT_ID
& Nbsp; ключов клиент Заявлението GitHub си.
CLIENT_SECRET
& Nbsp; секретен ключ Заявлението GitHub си.
SAVE_DIRECTORY
& Nbsp; Пътят на директория за съхранение на данни. Тази директория ще съхранява някои конфигурирани данни, архиви и построени документации.
SECRET_KEY
& Nbsp; таен ключ, за да подпише сесии. Вижте Документи колбата за сесии.
<Силен> Open източник
Okydoky е написана от Хонг Minhee за Crosspop. То се разпространява под лиценз MIT, и изходния код може да бъде намерена в хранилището GitHub. Тръгване на:
& Nbsp; Git клонинг Git: //github.com/crosspop/okydoky.git

Какво ново в тази версия:

<Ли > GitHub принудени състояние за OAuth. Следвайте това.

Какво ново във версия 0.9.4:

• Използвайте --upgrade опция за setup.py развият команда. Това предотвратява версия конфликти на зависимости.
• Изграждане на трупчета са оставени на файла build.txt.

Какво ново във версия 0.9.3:

• Сега главната страница показва списък на док.
• Сега Okydoky комплекти OKYDOKY = променлива 1 среда по време на неговото натрупване процес. [# 5]
• Add / главата специален код URL.
• Фиксирана бъг, че главата не е настроен на по-късно се ангажират.

Какво ново във версия 0.9.2:

• Фиксирана бъг сигурност: сега Потребителите трябва да имат разрешение за хранилището. [# 4]

<силни> Изисквания :

• Python