Skip to content

Commit 2543310

Browse files
author
Timur Gilmullin
committed
Print Version is added. More examples added to README.
1 parent 7dc74aa commit 2543310

2 files changed

Lines changed: 62 additions & 1 deletion

File tree

README.md

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ See english instruction here: https://github.com/devopshq/ExampleProject/blob/ma
1515
- [Настройка конфигурации в .travis.yml](#Configuration)
1616
- [Подготовка и настройка репозитория в PyPI](#PyPI)
1717
- [Публикация новости о релизе в Telegram-канале DevOpsHQ](#News)
18+
- [проверка тестового проекта](#Testing)
1819

1920

2021
# Введение <a name="Introduction"></a>
@@ -355,3 +356,60 @@ env:
355356
@devops_mega_bot [название вашего инструмента]
356357
357358
3. После этого можно в канале сообщества опубликовать запись о новой версии и добавить информацию в произвольном виде: что вошло в новую сборку, какие фичи добавлены, какие баги исправлены и т.п.
359+
360+
361+
# Проверка тестового проекта <a name="Testing"></a>
362+
363+
Чтобы убедиться, что данный тестовый проект **ExampleProject** работает, попробуйте установить его из PyPI:
364+
365+
pip install dohq-example-project [--upgrade] [--pre]
366+
367+
В случае успеха установки вы увидите что-то вроде:
368+
369+
```Shell
370+
pip install dohq-example-project --upgrade
371+
372+
Collecting dohq-example-project
373+
Downloading dohq_example_project-1.0.11-py3-none-any.whl
374+
Installing collected packages: dohq-example-project
375+
Found existing installation: dohq-example-project 1.0.dev3
376+
Uninstalling dohq-example-project-1.0.dev3:
377+
Successfully uninstalled dohq-example-project-1.0.dev3
378+
Successfully installed dohq-example-project-1.0.11
379+
```
380+
381+
Запустите тестовый проект:
382+
383+
exampleproject
384+
385+
или
386+
387+
[python_directory]/Scripts/exampleproject
388+
389+
и вы должны увидеть что-то вроде:
390+
391+
```Shell
392+
This is Main module for ExampleProject that do nothing.
393+
Read more about DevOpsHQ Community here: https://github.com/devopshq/ExampleProject
394+
Version of ExampleProject is [ 1.0.11 ]
395+
```
396+
397+
Также можно проверить информацию в pip:
398+
399+
pip show dohq-example-project
400+
401+
после чего вы должны увидеть что-то вроде:
402+
403+
```Shell
404+
Name: dohq-example-project
405+
Version: 1.0.11
406+
Summary: About Example Project: https://github.com/devopshq/ExampleProject
407+
Home-page: https://devopshq.github.io/ExampleProject/
408+
Author: Open DevOps Community
409+
Author-email: [email protected]
410+
License: MIT
411+
Location: c:\anaconda3\lib\site-packages
412+
Requires:
413+
```
414+
415+
Аналогично вы можете проверить установку вашего проекта, сделанного на основе данного шаблона.

exampleproject/Main.py

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,11 @@ def Main():
88
"""
99
This is Main method that do nosting.
1010
"""
11-
return "This is Main module for ExampleProject that do nosting.\nRead more about DevOpsHQ Community here: https://github.com/devopshq/ExampleProject"
11+
return "This is Main module for ExampleProject that do nothing.\nRead more about DevOpsHQ Community here: https://github.com/devopshq/ExampleProject"
1212

1313

1414
if __name__ == "__main__":
1515
print(Main())
16+
17+
import pkg_resources # part of standart setuptools
18+
print("Version of ExampleProject is [ {} ]".format(pkg_resources.get_distribution('dohq-example-project').version))

0 commit comments

Comments
 (0)