Merge pull request #4 from TitaniumHocker/v0.4

V0.4
TitaniumHocker · Jul 9, 2020 · 7d408b7 · 7d408b7
2 parents bb438b4 + 89b1a50
commit 7d408b7
Show file tree

Hide file tree

Showing 19 changed files with 423 additions and 532 deletions.
diff --git a/.github/workflows/python-package.yml b/.github/workflows/python-package.yml
@@ -26,7 +26,7 @@ jobs:
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
-        pip install flake8 pytest
+        pip install flake8 pytest freezegun
         if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
     - name: Lint with flake8
       run: |

diff --git a/Pipfile b/Pipfile
@@ -9,13 +9,15 @@ pytest-cov = "*"
 pylint = "*"
 jedi = "*"
 tox = "*"
-twine = "*"
 sphinx = "*"
+coverage-badge = "*"
+pallets-sphinx-themes = "*"
+mypy = "*"
+freezegun = "*"
 
 [packages]
 requests = "*"
 click = "*"
-pallets-sphinx-themes = "*"
 
 [requires]
 python_version = "3.7"
diff --git a/Pipfile.lock b/Pipfile.lock
diff --git a/README.rst b/README.rst
@@ -38,14 +38,16 @@ gvapi
 
 .. |pypgk| image:: https://github.com/TitaniumHocker/gvapi/workflows/Python%20package/badge.svg?branch=master
 
-.. |coverage| image:: https://img.shields.io/badge/coverage-92%25-green?style=flat-square
+.. |coverage| image:: https://raw.githubusercontent.com/TitaniumHocker/gvapi/master/media/coverage.svg
 
-.. |version| image:: https://img.shields.io/badge/version-0.2-red?style=flat-square
+.. |python| image:: https://img.shields.io/badge/python-3.5%20|%203.6%20|%203.7%20|%203.8-blue?style=flat
 
-.. |python| image:: https://img.shields.io/badge/python-3.5%20|%203.6%20|%203.7%20|%203.8-blue?style=flat-square
-
-.. |requirements| image:: https://img.shields.io/badge/requirements-requests%20%26%20click-blue?style=flat-square
+.. |requirements| image:: https://img.shields.io/badge/requirements-requests%20%26%20click-blue?style=flat
 
 .. |doc| image:: https://readthedocs.org/projects/gvapi/badge/?version=latest
    :target: https://gvapi.readthedocs.io/ru/latest/?badge=latest
    :alt: Documentation Status
+
+.. |version| image:: https://badge.fury.io/py/gvapi.svg
+   :target: https://badge.fury.io/py/gvapi
+   :alt: Latest Version
diff --git a/docs/conf.py b/docs/conf.py
@@ -18,11 +18,11 @@
 # -- Project information -----------------------------------------------------
 
 project = 'gvapi'
-copyright = '2020, Titanium Hocker(Ivan Fedorov)'
+copyright = '2020, Ivan Fedorov'
 author = 'Titanium Hocker(Ivan Fedorov)'
 
 # The full version, including alpha/beta/rc tags
-release = '0.3'
+release = '0.4'
 
 
 # -- General configuration ---------------------------------------------------

diff --git a/docs/gvapi.rst b/docs/gvapi.rst
@@ -1,5 +1,5 @@
-Пакет gvapi API
-===============
+API пакета gvapi
+================
 
 Модуль gvapi.hero
 -----------------

diff --git a/docs/index.rst b/docs/index.rst
@@ -6,9 +6,9 @@
 **Фичи:**
 
  - Создание объекта героя с соответствующими атрибутами
- - Возможность использоваться расширенного доступа на базе API
- - Отслеживание ошибок с соответствующими исключениями
  - Автоматическое обновление данных внутри объекта
+ - Отслеживание ошибок с соответствующими исключениями
+ - Возможность использоваться расширенного доступа с использованием токена
 
 **Полезные ссылки:**
 
@@ -28,7 +28,8 @@
 Помощь
 ------
 
-Нашел ошибку? Открой issue на `GitHub <https://github.com/TitaniumHocker/gvapi/issues>`_
+Нашел ошибку, есть вопрос или предложение?
+Открой issue на `GitHub <https://github.com/TitaniumHocker/gvapi/issues>`_
 
 Индексы и таблицы
 =================

diff --git a/docs/quickstart.rst b/docs/quickstart.rst
@@ -30,6 +30,6 @@
 Данный скрипт выведет примерное количество золота героя и количество кирпичей.
 
 .. code-block:: bash
-
+   
    python3 simple.py
-   Золото: около 2 тысяч, Кирпичи: 382
+   ЗЛ: 8.0k, КП: 43.0%
diff --git a/examples/simple.py b/examples/simple.py
@@ -1,7 +1,4 @@
-#!/usr/bin/env python3
-# -*- coding: utf-8 -*-
 from gvapi import Hero
 
 hero = Hero('Mars', token='awudhawiudh')
-
-print('Золото: {}, Кирпичи: {}'.format(hero.gold, hero.bricks))
+print('ЗЛ: ~{}k, КП: {:.1f}%'.format(hero.goldf, hero.bricks_percent))
diff --git a/gvapi/errors.py b/gvapi/errors.py
@@ -9,6 +9,9 @@ class GVAPIException(Exception):
     От данного исключения наследуются остальные исключения пакета.
     '''
 
+class UnknownGod(GVAPIException):
+    '''Бог не был найден.'''
+
 
 class APIUnavailable(GVAPIException):
     '''API недоступно.'''
@@ -18,8 +21,8 @@ class UnexpectedAPIResponse(GVAPIException):
     '''Непредвиденный ответ API.'''
 
 
-class TokenWasResetted(GVAPIException):
-    '''Токен был сброшен и требует обновления.'''
+class InvalidToken(GVAPIException):
+    '''Токен невалилен или был сброшен.'''
 
 
 class NeedToken(GVAPIException):