├── api ├── __init__.py ├── core │ ├── __init__.py │ ├── migrations │ │ └── __init__.py │ ├── models.py │ ├── admin.py │ ├── tests.py │ ├── views.py │ └── apps.py ├── report │ ├── __init__.py │ ├── migrations │ │ ├── __init__.py │ │ └── 0001_initial.py │ ├── tests.py │ ├── apps.py │ ├── view.py │ ├── models.py │ └── management │ │ └── commands │ │ └── update_report.py ├── asgi.py ├── wsgi.py ├── urls.py └── settings.py ├── .dockerignore ├── docker-compose.yaml ├── requirements.txt ├── Dockerfile ├── manage.py ├── README.md ├── .gitignore └── LICENSE /api/__init__.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /api/core/__init__.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /api/report/__init__.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /api/core/migrations/__init__.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /api/report/migrations/__init__.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /.dockerignore: -------------------------------------------------------------------------------- 1 | requeriments.txt 2 | .gitignore 3 | README.md 4 | -------------------------------------------------------------------------------- /api/core/models.py: -------------------------------------------------------------------------------- 1 | from django.db import models 2 | 3 | # Create your models here. 4 | -------------------------------------------------------------------------------- /api/core/admin.py: -------------------------------------------------------------------------------- 1 | from django.contrib import admin 2 | 3 | # Register your models here. 4 | -------------------------------------------------------------------------------- /api/core/tests.py: -------------------------------------------------------------------------------- 1 | from django.test import TestCase 2 | 3 | # Create your tests here. 4 | -------------------------------------------------------------------------------- /api/core/views.py: -------------------------------------------------------------------------------- 1 | from django.shortcuts import render 2 | 3 | # Create your views here. 4 | -------------------------------------------------------------------------------- /api/report/tests.py: -------------------------------------------------------------------------------- 1 | from django.test import TestCase 2 | 3 | # Create your tests here. 4 | -------------------------------------------------------------------------------- /api/core/apps.py: -------------------------------------------------------------------------------- 1 | from django.apps import AppConfig 2 | 3 | 4 | class CoreConfig(AppConfig): 5 | name = 'core' 6 | -------------------------------------------------------------------------------- /api/report/apps.py: -------------------------------------------------------------------------------- 1 | from django.apps import AppConfig 2 | 3 | 4 | class ReportConfig(AppConfig): 5 | name = 'report' 6 | -------------------------------------------------------------------------------- /docker-compose.yaml: -------------------------------------------------------------------------------- 1 | version: '3.4' 2 | 3 | services: 4 | app: 5 | build: 6 | context: . 7 | target: release 8 | image: hummingbird 9 | -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | asgiref==3.2.5 2 | certifi==2019.11.28 3 | chardet==3.0.4 4 | Django==3.0.4 5 | django-rest-framework==0.1.0 6 | djangorestframework==3.11.0 7 | idna==2.9 8 | pytz==2019.3 9 | requests==2.23.0 10 | sqlparse==0.3.1 11 | urllib3==1.25.8 12 | apscheduler==3.6.3 13 | -------------------------------------------------------------------------------- /api/report/view.py: -------------------------------------------------------------------------------- 1 | from api.report.models import * 2 | from rest_framework.views import APIView 3 | from rest_framework.response import Response 4 | from rest_framework.decorators import api_view 5 | from django.http import JsonResponse 6 | 7 | @api_view(http_method_names=["GET"]) 8 | def get_cases(request): 9 | queryset = Case.objects.all() 10 | return Response({"cases" : list(queryset.values())}, status=200) 11 | -------------------------------------------------------------------------------- /api/asgi.py: -------------------------------------------------------------------------------- 1 | """ 2 | ASGI config for api project. 3 | 4 | It exposes the ASGI callable as a module-level variable named ``application``. 5 | 6 | For more information on this file, see 7 | https://docs.djangoproject.com/en/3.0/howto/deployment/asgi/ 8 | """ 9 | 10 | import os 11 | 12 | from django.core.asgi import get_asgi_application 13 | 14 | os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'api.settings') 15 | 16 | application = get_asgi_application() 17 | -------------------------------------------------------------------------------- /api/wsgi.py: -------------------------------------------------------------------------------- 1 | """ 2 | WSGI config for api project. 3 | 4 | It exposes the WSGI callable as a module-level variable named ``application``. 5 | 6 | For more information on this file, see 7 | https://docs.djangoproject.com/en/3.0/howto/deployment/wsgi/ 8 | """ 9 | 10 | import os 11 | 12 | from django.core.wsgi import get_wsgi_application 13 | 14 | os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'api.settings') 15 | 16 | application = get_wsgi_application() 17 | -------------------------------------------------------------------------------- /Dockerfile: -------------------------------------------------------------------------------- 1 | FROM python:3.6-alpine as base 2 | 3 | FROM base as build 4 | 5 | COPY requirements.txt /install/ 6 | RUN pip install -r /install/requirements.txt 7 | 8 | FROM python:3.6-alpine as release 9 | 10 | WORKDIR /app 11 | 12 | RUN addgroup -S app && \ 13 | adduser -S -G app app && \ 14 | chown -R app:app /app && \ 15 | apk --update --no-cache add curl 16 | 17 | COPY . /app/ 18 | COPY --from=BUILD /usr/local/ /usr/local 19 | 20 | USER app 21 | 22 | CMD python manage.py update_report 23 | -------------------------------------------------------------------------------- /manage.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | """Django's command-line utility for administrative tasks.""" 3 | import os 4 | import sys 5 | 6 | 7 | def main(): 8 | os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'api.settings') 9 | try: 10 | from django.core.management import execute_from_command_line 11 | except ImportError as exc: 12 | raise ImportError( 13 | "Couldn't import Django. Are you sure it's installed and " 14 | "available on your PYTHONPATH environment variable? Did you " 15 | "forget to activate a virtual environment?" 16 | ) from exc 17 | execute_from_command_line(sys.argv) 18 | 19 | 20 | if __name__ == '__main__': 21 | main() 22 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # CÓDIGO FORA DE UTILIZAÇÃO 2 | # hummingbird-covidzero 3 | 4 | Essa é uma aplicação criada para fornecer APIs de consulta de dados sobre 5 | COVID-19. Dividimos a aplicação em duas partes, a primeira é uma cron que roda 6 | de tempos em tempos para buscar dados atualizados sobre os casos e registrar em 7 | uma base de dados para consulta e a segunda são as API para consulta dos dados 8 | que são utilizadas pelos Clients. 9 | 10 | ## Como rodar 11 | 12 | - Para rodar com docker-compose: 13 | 14 | ``` 15 | docker-compose build 16 | docker-compose up 17 | ``` 18 | 19 | ## Cron - [Doing] 20 | 21 | - Roda uma busca na base: http://plataforma.saude.gov.br/novocoronavirus/resources/scripts/database.js 22 | - Registra os dados em um modelo de Report e Cases 23 | 24 | ## APIS - [ToDo] 25 | 26 | -------------------------------------------------------------------------------- /api/urls.py: -------------------------------------------------------------------------------- 1 | """api URL Configuration 2 | 3 | The `urlpatterns` list routes URLs to views. For more information please see: 4 | https://docs.djangoproject.com/en/3.0/topics/http/urls/ 5 | Examples: 6 | Function views 7 | 1. Add an import: from my_app import views 8 | 2. Add a URL to urlpatterns: path('', views.home, name='home') 9 | Class-based views 10 | 1. Add an import: from other_app.views import Home 11 | 2. Add a URL to urlpatterns: path('', Home.as_view(), name='home') 12 | Including another URLconf 13 | 1. Import the include() function: from django.urls import include, path 14 | 2. Add a URL to urlpatterns: path('blog/', include('blog.urls')) 15 | """ 16 | from django.contrib import admin 17 | from django.urls import path 18 | from api.report import view 19 | 20 | urlpatterns = [ 21 | path("cases/", view.get_cases) 22 | ] 23 | 24 | -------------------------------------------------------------------------------- /api/report/models.py: -------------------------------------------------------------------------------- 1 | from django.db import models 2 | 3 | 4 | class Report(models.Model): 5 | updated_at = models.DateTimeField(auto_now=False) 6 | 7 | def __str__(self): 8 | return self.updated_at.strftime('%d/%m/%Y') 9 | 10 | 11 | class Case(models.Model): 12 | STATES = [ 13 | (11, 'Rondônia'), (12, 'Acre'), (13, 'Amazonas'), (14, 'Roraima'), 14 | (15, 'Pará'), (16, 'Amapá'), (17, 'Tocantins'), (21, 'Maranhão'), 15 | (22, 'Piauí'), (23, 'Ceará'), (24, 'Rio Grande do Norte'), 16 | (25, 'Paraíba'), (26, 'Pernambuco'), (27, 'Alagoas'), 17 | (28, 'Sergipe'), (29, 'Bahia'), (31, 'Minas Gerais'), 18 | (32, 'Espírito Santo'), (33, 'Rio de Janeiro'), (35, 'São Paulo'), 19 | (41, 'Paraná'), (42, 'Santa Catarina'), (43, 'Rio Grande do Sul'), 20 | (50, 'Mato Grosso do Sul'), (51, 'Mato Grosso'), (52, 'Goiás'), 21 | (53, 'Distrito Federal') 22 | ] 23 | 24 | state = models.PositiveSmallIntegerField(choices=STATES) 25 | 26 | suspects = models.PositiveSmallIntegerField(default=0) 27 | refuses = models.PositiveSmallIntegerField(default=0) 28 | cases = models.PositiveSmallIntegerField(default=0) 29 | deaths = models.PositiveSmallIntegerField(default=0) 30 | recovered = models.PositiveIntegerField(default=0) 31 | 32 | report = models.ForeignKey(Report, on_delete=models.CASCADE) 33 | 34 | def __str__(self): 35 | return f"{self.state} {self.report}" 36 | 37 | class Meta: 38 | ordering = ['report', 'state'] 39 | verbose_name = 'Caso' 40 | -------------------------------------------------------------------------------- /api/report/migrations/0001_initial.py: -------------------------------------------------------------------------------- 1 | # Generated by Django 3.0.4 on 2020-03-19 18:56 2 | 3 | from django.db import migrations, models 4 | import django.db.models.deletion 5 | 6 | 7 | class Migration(migrations.Migration): 8 | 9 | initial = True 10 | 11 | dependencies = [ 12 | ] 13 | 14 | operations = [ 15 | migrations.CreateModel( 16 | name='Report', 17 | fields=[ 18 | ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')), 19 | ('updated_at', models.DateTimeField()), 20 | ], 21 | ), 22 | migrations.CreateModel( 23 | name='Case', 24 | fields=[ 25 | ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')), 26 | ('state', models.PositiveSmallIntegerField(choices=[(11, 'Rondônia'), (12, 'Acre'), (13, 'Amazonas'), (14, 'Roraima'), (15, 'Pará'), (16, 'Amapá'), (17, 'Tocantins'), (21, 'Maranhão'), (22, 'Piauí'), (23, 'Ceará'), (24, 'Rio Grande do Norte'), (25, 'Paraíba'), (26, 'Pernambuco'), (27, 'Alagoas'), (28, 'Sergipe'), (29, 'Bahia'), (31, 'Minas Gerais'), (32, 'Espírito Santo'), (33, 'Rio de Janeiro'), (35, 'São Paulo'), (41, 'Paraná'), (42, 'Santa Catarina'), (43, 'Rio Grande do Sul'), (50, 'Mato Grosso do Sul'), (51, 'Mato Grosso'), (52, 'Goiás'), (53, 'Distrito Federal')])), 27 | ('suspects', models.PositiveSmallIntegerField(default=0)), 28 | ('refuses', models.PositiveSmallIntegerField(default=0)), 29 | ('cases', models.PositiveSmallIntegerField(default=0)), 30 | ('deaths', models.PositiveSmallIntegerField(default=0)), 31 | ('recovered', models.PositiveIntegerField(default=0)), 32 | ('report', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='report.Report')), 33 | ], 34 | options={ 35 | 'verbose_name': 'Caso', 36 | 'ordering': ['report', 'state'], 37 | }, 38 | ), 39 | ] 40 | -------------------------------------------------------------------------------- /api/report/management/commands/update_report.py: -------------------------------------------------------------------------------- 1 | import json 2 | 3 | from datetime import datetime 4 | 5 | import requests 6 | 7 | from apscheduler.schedulers.blocking import BlockingScheduler 8 | from django.core.management.base import BaseCommand 9 | from django.utils.timezone import make_aware 10 | 11 | from api.report.models import * 12 | 13 | url = "http://plataforma.saude.gov.br/novocoronavirus/resources/scripts/database.js" 14 | 15 | 16 | def cron(*args, **options): 17 | if 6 <= datetime.now().hour <= 20: 18 | 19 | print(f"Cron job is running. The time is {datetime.now()}") 20 | request = requests.get(url) 21 | 22 | content = request.content.decode('utf8').replace('var database=', '') 23 | data = json.loads(content) 24 | 25 | for record in data['brazil']: 26 | date_time = datetime.strptime(f"{record['date']} {record['time']}", 27 | '%d/%m/%Y %H:%M') 28 | 29 | report, report_created = Report.objects.get_or_create( 30 | updated_at=make_aware(date_time) 31 | ) 32 | 33 | if report_created: 34 | for value in record['values']: 35 | state = int(value['uid']) 36 | 37 | suspects = value.get('suspects', 0) 38 | refuses = value.get('refuses', 0) 39 | cases = value.get('cases', 0) 40 | deaths = value.get('deaths', 0) 41 | recovered = value.get('recovered', 0) 42 | 43 | Case.objects.get_or_create( 44 | suspects=suspects, refuses=refuses, cases=cases, deaths=deaths, recovered=recovered, 45 | defaults={ 46 | 'state': state, 47 | 'report': report 48 | }) 49 | 50 | print(f"Done! The time is: {datetime.now()}") 51 | 52 | 53 | class Command(BaseCommand): 54 | help = 'Update kaggle dataset with the last cases of COVID-19 in Brazil.' 55 | 56 | def handle(self, *args, **options): 57 | print('Cron started! Wait the job starts!') 58 | 59 | scheduler = BlockingScheduler() 60 | scheduler.add_job(cron, 'cron', minute=20, timezone='America/Maceio') 61 | 62 | scheduler.start() 63 | -------------------------------------------------------------------------------- /api/settings.py: -------------------------------------------------------------------------------- 1 | """ 2 | Django settings for humming_brazil_covid19 project. 3 | 4 | Generated by 'django-admin startproject' using Django 3.0.4. 5 | 6 | For more information on this file, see 7 | https://docs.djangoproject.com/en/3.0/topics/settings/ 8 | 9 | For the full list of settings and their values, see 10 | https://docs.djangoproject.com/en/3.0/ref/settings/ 11 | """ 12 | 13 | import os 14 | 15 | # Build paths inside the project like this: os.path.join(BASE_DIR, ...) 16 | BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__))) 17 | 18 | ROOT_URLCONF = 'api.urls' 19 | 20 | # Quick-start development settings - unsuitable for production 21 | # See https://docs.djangoproject.com/en/3.0/howto/deployment/checklist/ 22 | 23 | # SECURITY WARNING: keep the secret key used in production secret! 24 | SECRET_KEY = '@^0cw57r4(i1gi=w$l@g8!y)reuo@1q-ix(((oy#3vl@7^=hkh' 25 | 26 | # SECURITY WARNING: don't run with debug turned on in production! 27 | DEBUG = True 28 | 29 | ALLOWED_HOSTS = [] 30 | 31 | 32 | # Application definition 33 | 34 | INSTALLED_APPS = [ 35 | 'rest_framework', 36 | 'api.core', 37 | 'api.report', 38 | 'django.contrib.auth', 39 | 'django.contrib.contenttypes', 40 | 'django.contrib.sessions', 41 | 'django.contrib.messages', 42 | 'django.contrib.staticfiles', 43 | 44 | ] 45 | 46 | MIDDLEWARE = [ 47 | 'django.middleware.security.SecurityMiddleware', 48 | ] 49 | 50 | DATABASES = { 51 | 'default': { 52 | 'ENGINE': 'django.db.backends.sqlite3', 53 | 'NAME': os.path.join(BASE_DIR, 'db.sqlite3'), 54 | } 55 | } 56 | 57 | LANGUAGE_CODE = 'pt-br' 58 | 59 | TIME_ZONE = 'America/Sao_Paulo' 60 | 61 | USE_I18N = True 62 | 63 | USE_L10N = True 64 | 65 | USE_TZ = True 66 | 67 | 68 | # Static files (CSS, JavaScript, Images) 69 | # https://docs.djangoproject.com/en/3.0/howto/static-files/ 70 | 71 | STATIC_URL = '/static/' 72 | 73 | TEMPLATES = [ 74 | { 75 | 'BACKEND': 'django.template.backends.django.DjangoTemplates', 76 | 'DIRS': [], 77 | 'APP_DIRS': True, 78 | 'OPTIONS': { 79 | 'context_processors': [ 80 | 'django.template.context_processors.debug', 81 | 'django.template.context_processors.request', 82 | 'django.contrib.auth.context_processors.auth', 83 | 'django.contrib.messages.context_processors.messages', 84 | ], 85 | }, 86 | }, 87 | ] 88 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | .idea/* 2 | 3 | db.sqlite3 4 | 5 | # Created by https://www.gitignore.io/api/osx,python,pycharm,virtualenv 6 | # Edit at https://www.gitignore.io/?templates=osx,python,pycharm,virtualenv 7 | 8 | ### OSX ### 9 | # General 10 | .DS_Store 11 | .AppleDouble 12 | .LSOverride 13 | 14 | # Icon must end with two \r 15 | Icon 16 | 17 | # Thumbnails 18 | ._* 19 | 20 | # Files that might appear in the root of a volume 21 | .DocumentRevisions-V100 22 | .fseventsd 23 | .Spotlight-V100 24 | .TemporaryItems 25 | .Trashes 26 | .VolumeIcon.icns 27 | .com.apple.timemachine.donotpresent 28 | 29 | # Directories potentially created on remote AFP share 30 | .AppleDB 31 | .AppleDesktop 32 | Network Trash Folder 33 | Temporary Items 34 | .apdisk 35 | 36 | ### PyCharm ### 37 | # Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio and WebStorm 38 | # Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839 39 | 40 | # User-specific stuff 41 | .idea/**/workspace.xml 42 | .idea/**/tasks.xml 43 | .idea/**/usage.statistics.xml 44 | .idea/**/dictionaries 45 | .idea/**/shelf 46 | 47 | # Generated files 48 | .idea/**/contentModel.xml 49 | 50 | # Sensitive or high-churn files 51 | .idea/**/dataSources/ 52 | .idea/**/dataSources.ids 53 | .idea/**/dataSources.local.xml 54 | .idea/**/sqlDataSources.xml 55 | .idea/**/dynamic.xml 56 | .idea/**/uiDesigner.xml 57 | .idea/**/dbnavigator.xml 58 | 59 | # Gradle 60 | .idea/**/gradle.xml 61 | .idea/**/libraries 62 | 63 | # Gradle and Maven with auto-import 64 | # When using Gradle or Maven with auto-import, you should exclude module files, 65 | # since they will be recreated, and may cause churn. Uncomment if using 66 | # auto-import. 67 | # .idea/modules.xml 68 | # .idea/*.iml 69 | # .idea/modules 70 | # *.iml 71 | # *.ipr 72 | 73 | # CMake 74 | cmake-build-*/ 75 | 76 | # Mongo Explorer plugin 77 | .idea/**/mongoSettings.xml 78 | 79 | # File-based project format 80 | *.iws 81 | 82 | # IntelliJ 83 | out/ 84 | 85 | # mpeltonen/sbt-idea plugin 86 | .idea_modules/ 87 | 88 | # JIRA plugin 89 | atlassian-ide-plugin.xml 90 | 91 | # Cursive Clojure plugin 92 | .idea/replstate.xml 93 | 94 | # Crashlytics plugin (for Android Studio and IntelliJ) 95 | com_crashlytics_export_strings.xml 96 | crashlytics.properties 97 | crashlytics-build.properties 98 | fabric.properties 99 | 100 | # Editor-based Rest Client 101 | .idea/httpRequests 102 | 103 | # Android studio 3.1+ serialized cache file 104 | .idea/caches/build_file_checksums.ser 105 | 106 | ### PyCharm Patch ### 107 | # Comment Reason: https://github.com/joeblau/gitignore.io/issues/186#issuecomment-215987721 108 | 109 | # *.iml 110 | # modules.xml 111 | # .idea/misc.xml 112 | # *.ipr 113 | 114 | # Sonarlint plugin 115 | .idea/**/sonarlint/ 116 | 117 | # SonarQube Plugin 118 | .idea/**/sonarIssues.xml 119 | 120 | # Markdown Navigator plugin 121 | .idea/**/markdown-navigator.xml 122 | .idea/**/markdown-navigator/ 123 | 124 | ### Python ### 125 | # Byte-compiled / optimized / DLL files 126 | __pycache__/ 127 | *.py[cod] 128 | *$py.class 129 | 130 | # C extensions 131 | *.so 132 | 133 | # Distribution / packaging 134 | .Python 135 | build/ 136 | develop-eggs/ 137 | dist/ 138 | downloads/ 139 | eggs/ 140 | .eggs/ 141 | lib/ 142 | lib64/ 143 | parts/ 144 | sdist/ 145 | var/ 146 | wheels/ 147 | pip-wheel-metadata/ 148 | share/python-wheels/ 149 | *.egg-info/ 150 | .installed.cfg 151 | *.egg 152 | MANIFEST 153 | 154 | # PyInstaller 155 | # Usually these files are written by a python script from a template 156 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 157 | *.manifest 158 | *.spec 159 | 160 | # Installer logs 161 | pip-log.txt 162 | pip-delete-this-directory.txt 163 | 164 | # Unit test / coverage reports 165 | htmlcov/ 166 | .tox/ 167 | .nox/ 168 | .coverage 169 | .coverage.* 170 | .cache 171 | nosetests.xml 172 | coverage.xml 173 | *.cover 174 | .hypothesis/ 175 | .pytest_cache/ 176 | 177 | # Translations 178 | *.mo 179 | *.pot 180 | 181 | # Scrapy stuff: 182 | .scrapy 183 | 184 | # Sphinx documentation 185 | docs/_build/ 186 | 187 | # PyBuilder 188 | target/ 189 | 190 | # pyenv 191 | .python-version 192 | 193 | # pipenv 194 | # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. 195 | # However, in case of collaboration, if having platform-specific dependencies or dependencies 196 | # having no cross-platform support, pipenv may install dependencies that don't work, or not 197 | # install all needed dependencies. 198 | #Pipfile.lock 199 | 200 | # celery beat schedule file 201 | celerybeat-schedule 202 | 203 | # SageMath parsed files 204 | *.sage.py 205 | 206 | # Spyder project settings 207 | .spyderproject 208 | .spyproject 209 | 210 | # Rope project settings 211 | .ropeproject 212 | 213 | # Mr Developer 214 | .mr.developer.cfg 215 | .project 216 | .pydevproject 217 | 218 | # mkdocs documentation 219 | /site 220 | 221 | # mypy 222 | .mypy_cache/ 223 | .dmypy.json 224 | dmypy.json 225 | 226 | # Pyre type checker 227 | .pyre/ 228 | 229 | ### VirtualEnv ### 230 | # Virtualenv 231 | # http://iamzed.com/2009/05/07/a-primer-on-virtualenv/ 232 | pyvenv.cfg 233 | .env 234 | .venv 235 | env/ 236 | venv/ 237 | ENV/ 238 | env.bak/ 239 | venv.bak/ 240 | pip-selfcheck.json 241 | 242 | # End of https://www.gitignore.io/api/osx,python,pycharm,virtualenv -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | --------------------------------------------------------------------------------