ExampleProject

This is simple example of project in DevOpsHQ Community with basic functionality.

[](https://travis-ci.org/devopshq/tfs) [](https://www.codacy.com/app/tim55667757/tfs/dashboard) [](https://www.codacy.com/app/tim55667757/tfs/dashboard) [](https://pypi.python.org/pypi/dohq-tfs) [](https://github.com/devopshq/tfs/blob/master/LICENSE)

***Содержание:***

Подготовка любого нового проекта состоит из шагов, представленных на схеме ниже:


1. Обсудить и согласовать с [Timur Gilmullin](https://github.com/Tim55667757) или [Alexander Pazdnikov](https://github.com/apazdnikov) выкладку нового проекта в https://github.com/devopshq. После этого будет создан и настроен репозиторий и типовые группы доступа, выданы права owner на проект.

5. Юнит-тесты формата pytest должны располагаться в каталоге **./tests** в корне проекта.

1. Документация к проекту на английском языке должна вестись в файле **README.md** формата **markdown**, который должен располагаться в корне репозитория в каждой ветке. Версионирование и изменения в документацию вносятся как в обычный код, вместе с отдельными комитами в соответствующую ветку. Документация на русском ведётся аналогично в файле **README_RUS.md**.

**\[HEADER\](#anchor_name)**

2. Рядом с нужным местом (заголовком) в документе добавляем обычный html-якорь:

**\<a name="anchor_name"\>\</a\> HEADER**

Альтернативный вариант:

**\[Long Header\](#long-header)**

2. В тексте заголовок должен быть такой же, как в квадратных скобках выше:

**Long Header**

Качество кода автоматически отслеживается [сервисом Codacy](https://www.codacy.com/). Для его настройки:

Выделенное длинное число — это код проекта в Codacy (его можно узнать в настройках Settings — General — Codacy Badge), а выделенная часть ссылки — это ваш логин и имя проекта в Codacy.

Подготовка сборки python-кода в [Travis CI](https://travis-ci.org/devopshq) состоит из нескольких основных шагов:

Для начала работы с Travis CI включите интеграцию в вашем GitHub проекте: для этого перейдите в Travis CI по ссылке https://travis-ci.org/profile/devopshq и включите интеграцию вашего нового проекта с GitHub. Для этой операции необходимы админские права в сообществе DevOpsHQ.

Скрипт **setup.py** используется стандартным сборщиком python из библиотеки setuptools для обеспечения локальной сборки инструмента в пакет. Обычно, для локального билда и установки вашего инструмента в библиотеки локального python используют команду: python setup.py install. Этот же самый принцип использует Travis CI для обеспечения сборки и дальнейшей упаковки пакета, например, в .tar.gz или wheel-файл и загрузки в PyPI.

***Дополнение:*** *похоже, что это уже не требуется, т.к. PyPI выдаёт на попытку зарегистрировать проект: Server response (410): Project pre-registration is no longer required or supported, so continue directly to uploading files.*

Travis CI сервис ищет конфигурацию шагов сборки в стандартном файле **.travis.yml**. Описание его разделов подробно описано в родной документации: https://docs.travis-ci.com/user/customizing-the-build.

Ниже представлен пример файла конфигурации **.travis.yml** с минимальным набором типичных шагов сборки в Travis CI для небольших и простых проектов. Достаточно скопировать его к себе, добавить юнит-тесты в ./tests, заменить ключи secure и он должен подойти, либо с минимальными доработками:

После того, как в репозиторий был добавлен файл **.travis.yml** и включена интеграция с ним в Travis CI:

3. Для Package Name вашего нового проекта небходимо добавить минимальную роль **Maintainer** для пользователя **devopshq**, чтобы Travis CI мог аплоадить артефакты в PyPI-репозиторий.

Канал сообщества: https://t.me/devopshq. Для публикации в него новости о новой фича или релизной сборке существует чат-бот @devops_mega_bot. Отправлять в канал новости могут админы сообщества DevOpsHQ: