Merge pull request devopshq#6 from devopshq/develop

Tim55667757 · web-flow · commit 10d57798868a · 2017-07-17T18:43:03.000+03:00
Version added. Example of project testing is added.
diff --git a/README.md b/README.md
@@ -15,6 +15,7 @@ See english instruction here: https://github.com/devopshq/ExampleProject/blob/ma
      - [Настройка конфигурации в .travis.yml](#Configuration)
      - [Подготовка и настройка репозитория в PyPI](#PyPI)
 - [Публикация новости о релизе в Telegram-канале DevOpsHQ](#News)
+- [Проверка тестового проекта](#Testing)
 
 
 # Введение <a name="Introduction"></a>
@@ -355,3 +356,60 @@ env:
     @devops_mega_bot [название вашего инструмента]
 
 3. После этого можно в канале сообщества опубликовать запись о новой версии и добавить информацию в произвольном виде: что вошло в новую сборку, какие фичи добавлены, какие баги исправлены и т.п.
+
+
+# Проверка тестового проекта <a name="Testing"></a>
+
+Чтобы убедиться, что данный тестовый проект **ExampleProject** работает, попробуйте установить его из PyPI:
+
+    pip install dohq-example-project [--upgrade] [--pre]
+
+В случае успеха установки вы увидите что-то вроде:
+
+```Shell
+pip install dohq-example-project --upgrade
+
+Collecting dohq-example-project
+  Downloading dohq_example_project-1.0.11-py3-none-any.whl
+Installing collected packages: dohq-example-project
+  Found existing installation: dohq-example-project 1.0.dev3
+    Uninstalling dohq-example-project-1.0.dev3:
+      Successfully uninstalled dohq-example-project-1.0.dev3
+Successfully installed dohq-example-project-1.0.11
+```
+
+Запустите тестовый проект:
+
+    exampleproject
+
+или
+
+    [python_directory]/Scripts/exampleproject
+
+и вы должны увидеть что-то вроде:
+
+```Shell
+This is Main module for ExampleProject that do nothing.
+Read more about DevOpsHQ Community here: https://github.com/devopshq/ExampleProject
+Version of ExampleProject is [ 1.0.11 ]
+```
+
+Также можно проверить информацию в pip:
+
+    pip show dohq-example-project
+
+после чего вы должны увидеть что-то вроде:
+
+```Shell
+Name: dohq-example-project
+Version: 1.0.11
+Summary: About Example Project: https://github.com/devopshq/ExampleProject
+Home-page: https://devopshq.github.io/ExampleProject/
+Author: Open DevOps Community
+Author-email: tim55667757@gmail.com
+License: MIT
+Location: c:\anaconda3\lib\site-packages
+Requires:
+```
+
+Аналогично вы можете проверить установку вашего проекта, сделанного на основе данного шаблона.
diff --git a/exampleproject/Main.py b/exampleproject/Main.py
@@ -8,8 +8,11 @@ def Main():
     """
     This is Main method that do nosting.
     """
-    return "This is Main module for ExampleProject that do nosting.\nRead more about DevOpsHQ Community here: https://github.com/devopshq/ExampleProject"
+    return "This is Main module for ExampleProject that do nothing.\nRead more about DevOpsHQ Community here: https://github.com/devopshq/ExampleProject"
 
 
 if __name__ == "__main__":
     print(Main())
+
+    import pkg_resources  # part of standart setuptools
+    print("Version of ExampleProject is [ {} ]".format(pkg_resources.get_distribution('dohq-example-project').version))
diff --git a/tests/test_Main.py b/tests/test_Main.py
@@ -12,4 +12,4 @@ def init(self):
         print("This is start of test example.")
 
     def test_Main(self):
-        assert Main.Main() == "This is Main module for ExampleProject that do nosting.\nRead more about DevOpsHQ Community here: https://github.com/devopshq/ExampleProject"
+        assert Main.Main() == "This is Main module for ExampleProject that do nothing.\nRead more about DevOpsHQ Community here: https://github.com/devopshq/ExampleProject"
