Как сделать свой модуль для CMS
Пошаговое руководство для разработчиков, которые хотят расширить Redsolution CMS собственным модулем и поделиться им с сообществом.
Как содействовать
Для того чтобы добавить свой модуль в Redsolution CMS, необходимо выполнить три шага:
- написать модуль;
- оформить код и опубликовать его в Python Package Index;
- создать модуль установки и опубликовать его.
1. Создание модуля для Django
Для тех, кто знаком с Django, эта часть может показаться скучной, поэтому смело пролистывайте её. Для тех, кто только интересуется, что за инструмент такой Django, мы написали краткое руководство Django модуль с нуля.
2. Оформление модуля и публикация в Python Package Index
Оформлять и публиковать модули нужно. Мы это поняли и даже написали отдельное руководство Подготовка и публикация модуля Django. Публикация модуля подразумевает наличие таких необходимых для библиотеки вещей, как документация, тесты и версии.
Приведём два аргумента в пользу правильной публикации модулей:
- писать в одиночку тяжело;
- хорошо оформленный, ухоженный модуль приносит ни с чем не сравнимое эстетическое удовольствие.
3. Добавление модуля в RedsolutionCMS
Если вам нравится Redsolution CMS и вы хотели бы, чтобы ваш модуль отображался в списке модулей при установке, то вам нужно написать установочный модуль. Как это сделать, описано в руководстве Интеграция модуля с RedsolutionCMS.
4. Напоследок
Наша Redsolution CMS ещё молодая и нежная. Любой непредвиденный поворот событий может поставить крест на сборке сайта. В наши дальнейшие планы входит сделать CMS более устойчивой к неожиданностям, однако без помощи других разработчиков и тестеров, думаем, это будет нескоро.
Мы будем очень признательны, если ошибки, трейсбеки либо вещи, которые вы знаете, как сделать лучше, вы будете присылать нам на почту src [at] redsolution.ru. Вы также можете создать обращение на github.com и запросить пул реквест. В любом случае нам будет очень приятно.