├── tests └── test_app.py ├── duckiter ├── template │ ├── __init__.py │ ├── config_cfg.py │ └── docker_file.py ├── __init__.py ├── config.py ├── main.py ├── duckiter.py ├── validation.py └── utility.py ├── setup.cfg ├── MANIFEST.in ├── assets └── logo.png ├── requirements.txt ├── HISTORY.md ├── .github └── workflows │ └── python-publish.yml ├── .gitignore ├── README.md ├── setup.py └── LICENSE /tests/test_app.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /duckiter/template/__init__.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /setup.cfg: -------------------------------------------------------------------------------- 1 | [metadata] 2 | description-file = README.md -------------------------------------------------------------------------------- /MANIFEST.in: -------------------------------------------------------------------------------- 1 | include requirements.txt 2 | include README.md 3 | -------------------------------------------------------------------------------- /duckiter/__init__.py: -------------------------------------------------------------------------------- 1 | __author__ = "Soroush Safari" 2 | __version__ = '0.2.0' -------------------------------------------------------------------------------- /assets/logo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/coci/duckiter/HEAD/assets/logo.png -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | docker==4.4.1 2 | six==1.15.0 3 | websocket-client==0.57.0 4 | wheel==0.36.2 5 | rich==9.10.0 6 | Jinja2==2.11.1 -------------------------------------------------------------------------------- /duckiter/template/config_cfg.py: -------------------------------------------------------------------------------- 1 | config_cfg = \ 2 | """ 3 | [project_info] 4 | project_name = {{ project_name }} 5 | python_version= {{ python_version }} 6 | is_migration= {{ is_migration }} 7 | 8 | [project_server] 9 | project_server = {{ project_server }} 10 | """ 11 | -------------------------------------------------------------------------------- /HISTORY.md: -------------------------------------------------------------------------------- 1 | # Release History 2 | 3 | 4 | 5 | ## 0.1.9 (2020-02-25) 6 | 7 | **Bugfixes** 8 | 9 | - fixed issue about alpine images 10 | 11 | 12 | 13 | ## 0.1.8 (2020-02-15) 14 | 15 | **Bugfixes** 16 | 17 | - fixed issue about jinja insertion in config.cfg file 18 | 19 | **Changes** 20 | 21 | - replace colored pip package with rich package 22 | - replace progress pip package with rich package 23 | 24 | -------------------------------------------------------------------------------- /duckiter/template/docker_file.py: -------------------------------------------------------------------------------- 1 | from jinja2 import Template 2 | 3 | dockerfile = \ 4 | """ 5 | FROM python:{{ python_version }} 6 | 7 | # set environment variables 8 | ENV PYTHONDONTWRITEBYTECODE 1 9 | ENV PYTHONUNBUFFERED 1 10 | 11 | WORKDIR /app 12 | COPY . /app 13 | 14 | # install dependencies 15 | RUN pip install --upgrade pip 16 | RUN pip install -r requirements.txt 17 | 18 | {{ migrate }} 19 | {{ project_server }} 20 | """ 21 | -------------------------------------------------------------------------------- /.github/workflows/python-publish.yml: -------------------------------------------------------------------------------- 1 | # This workflow will upload a Python Package using Twine when a release is created 2 | # For more information see: https://help.github.com/en/actions/language-and-framework-guides/using-python-with-github-actions#publishing-to-package-registries 3 | 4 | name: Upload Python Package 5 | 6 | on: 7 | release: 8 | types: [created] 9 | 10 | jobs: 11 | deploy: 12 | 13 | runs-on: ubuntu-latest 14 | 15 | steps: 16 | - uses: actions/checkout@v2 17 | - name: Set up Python 18 | uses: actions/setup-python@v2 19 | with: 20 | python-version: '3.x' 21 | - name: Install dependencies 22 | run: | 23 | python -m pip install --upgrade pip 24 | pip install setuptools wheel twine 25 | - name: Build and publish 26 | env: 27 | TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }} 28 | TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }} 29 | run: | 30 | python setup.py sdist bdist_wheel 31 | twine upload dist/* 32 | -------------------------------------------------------------------------------- /duckiter/config.py: -------------------------------------------------------------------------------- 1 | # -*- coding: utf-8 -*- 2 | # 3 | # Copyright (C) 2021- Soroush Safari 4 | # 5 | # This file is part of duckiter. 6 | # 7 | # duckiter is free software: you can redistribute it and/or modify 8 | # it under the terms of the GNU General Public License as published by 9 | # the Free Software Foundation, either version 3 of the License, or 10 | # (at your option) any later version. 11 | # 12 | # duckiter is distributed in the hope that it will be useful, 13 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 14 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 | # GNU General Public License for more details. 16 | # 17 | # You should have received a copy of the GNU General Public License 18 | # along with grest. If not, see . 19 | # 20 | 21 | def get_config() -> dict: 22 | """ 23 | get config from user ( CLI ) 24 | 25 | """ 26 | print("please enter python version that you need insert in your Docker. Exp : ( 3.9-alpine or 3.9 )") 27 | python_version = input( 28 | "( blank will consider as 3.8-alpine ) : ") 29 | 30 | python_version = python_version if python_version else '3.8' 31 | 32 | is_migration = input( 33 | "Do you want add 'python manage.py migrate' in your docker file ? (y/n) : ") 34 | 35 | is_migration = True if (is_migration == 'y' or not is_migration) else False 36 | 37 | config = { 38 | 'python_version': python_version, 39 | 'is_migration': is_migration, 40 | 41 | } 42 | return config 43 | -------------------------------------------------------------------------------- /duckiter/main.py: -------------------------------------------------------------------------------- 1 | # -*- coding: utf-8 -*- 2 | # 3 | # Copyright (C) 2021- Soroush Safari 4 | # 5 | # This file is part of duckiter. 6 | # 7 | # duckiter is free software: you can redistribute it and/or modify 8 | # it under the terms of the GNU General Public License as published by 9 | # the Free Software Foundation, either version 3 of the License, or 10 | # (at your option) any later version. 11 | # 12 | # duckiter is distributed in the hope that it will be useful, 13 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 14 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 | # GNU General Public License for more details. 16 | # 17 | # You should have received a copy of the GNU General Public License 18 | # along with grest. If not, see . 19 | # 20 | 21 | import argparse 22 | 23 | from duckiter.duckiter import Duckiter 24 | 25 | 26 | def main(): 27 | duckiter_instance = Duckiter() 28 | 29 | my_parser = argparse.ArgumentParser( 30 | description='List the content of a folder') 31 | my_parser.add_argument('--init', 32 | action='store_true', 33 | help='initialize dockerfile in your project') 34 | 35 | my_parser.add_argument('--build', '-b', 36 | action='store_true', 37 | help='build from docker file') 38 | 39 | args = my_parser.parse_args() 40 | 41 | if args.init: 42 | duckiter_instance.initialize() 43 | 44 | if args.build: 45 | duckiter_instance.build() 46 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Byte-compiled / optimized / DLL files 2 | __pycache__/ 3 | *.py[cod] 4 | *$py.class 5 | 6 | # C extensions 7 | *.so 8 | 9 | # Distribution / packaging 10 | .Python 11 | env/ 12 | build/ 13 | develop-eggs/ 14 | dist/ 15 | downloads/ 16 | eggs/ 17 | .eggs/ 18 | lib/ 19 | lib64/ 20 | parts/ 21 | sdist/ 22 | var/ 23 | *.egg-info/ 24 | .installed.cfg 25 | *.egg 26 | 27 | # PyInstaller 28 | # Usually these files are written by a python script from a template 29 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 30 | *.manifest 31 | *.spec 32 | 33 | # Installer logs 34 | pip-log.txt 35 | pip-delete-this-directory.txt 36 | 37 | # Unit test / coverage reports 38 | htmlcov/ 39 | .tox/ 40 | .coverage 41 | .coverage.* 42 | .cache 43 | coverage.xml 44 | *,cover 45 | .hypothesis/ 46 | .coveralls.yml 47 | 48 | # Translations 49 | *.mo 50 | *.pot 51 | 52 | # Django stuff: 53 | *.log 54 | local_settings.py 55 | 56 | # Flask stuff: 57 | instance/ 58 | .webassets-cache 59 | 60 | # Scrapy stuff: 61 | .scrapy 62 | 63 | # Sphinx documentation 64 | docs/_build/ 65 | 66 | # PyBuilder 67 | target/ 68 | 69 | # IPython Notebook 70 | .ipynb_checkpoints 71 | 72 | # pyenv 73 | .python-version 74 | 75 | # celery beat schedule file 76 | celerybeat-schedule 77 | 78 | # dotenv 79 | .env 80 | 81 | # virtualenv 82 | venv/ 83 | ENV/ 84 | venv27/ 85 | 86 | # Spyder project settings 87 | .spyderproject 88 | 89 | # Rope project settings 90 | .ropeproject 91 | 92 | register_package_pypi.bat 93 | register_package_pypi_py3.bat 94 | test.bat 95 | 96 | # jet brains 97 | .idea/ 98 | 99 | # VSCode 100 | .vscode/ 101 | 102 | # pytest cache 103 | .pytest_cache/ 104 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 |

2 |
3 | 4 |

5 | 6 | # Duckiter 7 | Duckiter will Automatically dockerize your Django projects. 8 | 9 | ### Requirements : 10 | 11 | - python version : python version 3.6 or upper version 12 | - OS : 13 | - linux 14 | - MacOS 15 | - windows ( drop support ) 16 | - docker engine installed in your machine and already run through the usage of package 17 | 18 | 19 | ### Installation : 20 | clone project: 21 | ``` 22 | pip install duckiter 23 | ``` 24 | 25 | 26 | ### Usage : 27 | Duckiter has two individual steps: 28 | 29 | ​ 1- initialize Dockerfile 30 | 31 | ​ 2- build image from created Dockerfile 32 | 33 | #### To initialize Dockerfile (step 1) : 34 | in terminal hit to your project directory ( where manage.py is in root ): 35 | ``` 36 | duckiter --init 37 | ``` 38 | This will create Dockerfile and config.cfg in the root of the project, and you can manipulate those files before Duckiter creates an image. 39 | If you are ok with our configurations, you can just pass '-b' to immediately build the image right after creating the Dockerfile. 40 | 41 | ``` 42 | duckiter --init -b 43 | ``` 44 | #### To build image (step 2) : 45 | To build an image from the Dockerfile that has been created in the last step, you need enter: 46 | ``` 47 | duckiter main.py --build 48 | ``` 49 | this will look for config.cfg in project directory and then build the image. 50 | 51 | ## Troubleshooting : 52 | 53 | - if you get blow error while your docker engine is already run : 54 | 55 | ``` 56 | [ WARNNING !!!! ] It seems your docker engine doesn't run, please run the Docker engine. 57 | ``` 58 | 59 | ​ you can fix this issue , just enter these commands : 60 | 61 | ``` 62 | $ sudo groupadd docker 63 | $ sudo usermod -aG docker $USER 64 | $ newgrp docker 65 | ``` 66 | 67 | now problem fixed and you can run command again. 68 | 69 | 70 | 71 | - if you got error like : 72 | 73 | ``` 74 | duckiter : command not found 75 | ``` 76 | 77 | you can fix this issue by adding your python package directory into you PATH. 78 | 79 | 80 | 81 | ### Contribution : 82 | 83 | feel free to contribute to this project, but first contact me about the idea :) -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | # -*- coding: utf-8 -*- 2 | # 3 | # Copyright (C) 2021- Soroush Safari 4 | # 5 | # This file is part of duckiter. 6 | # 7 | # duckiter is free software: you can redistribute it and/or modify 8 | # it under the terms of the GNU General Public License as published by 9 | # the Free Software Foundation, either version 3 of the License, or 10 | # (at your option) any later version. 11 | # 12 | # duckiter is distributed in the hope that it will be useful, 13 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 14 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 | # GNU General Public License for more details. 16 | # 17 | # You should have received a copy of the GNU General Public License 18 | # along with grest. If not, see . 19 | # 20 | 21 | import re 22 | from os.path import dirname, join 23 | 24 | from setuptools import find_packages, setup 25 | 26 | # Extract requirements from requirements.txt 27 | REQUIREMENTS = [ 28 | r.rstrip() for r in open( 29 | join( 30 | dirname(__file__), 31 | 'requirements.txt')).readlines()] 32 | 33 | 34 | with open(join(dirname(__file__), 'duckiter', '__init__.py')) as v_file: 35 | package_version = re.compile( 36 | r".*__version__ = '(.*?)'", re.S).match(v_file.read()).group(1) 37 | 38 | with open("README.md", "r", encoding="utf-8") as fh: 39 | long_description = fh.read() 40 | 41 | setup( 42 | name="duckiter", 43 | version=package_version, 44 | description="Dockerize your django project", 45 | url="https://github.com/coci/duckiter", 46 | author="Soroush Safari", 47 | author_email="mr.safarii1992@gmail.com", 48 | license="GPLv3", 49 | include_package_data=True, 50 | long_description=long_description, 51 | long_description_content_type="text/markdown", 52 | install_requires=REQUIREMENTS, 53 | packages=find_packages(), 54 | entry_points={ 55 | 'console_scripts': [ 56 | 'duckiter = duckiter.main:main' 57 | ] 58 | }, 59 | classifiers=[ 60 | "Operating System :: OS Independent", 61 | "License :: OSI Approved :: GNU General Public License v3 (GPLv3)", 62 | "Programming Language :: Python :: 3.6", 63 | "Programming Language :: Python :: 3.7", 64 | "Programming Language :: Python :: 3.8", 65 | "Programming Language :: Python :: 3.9" 66 | ], 67 | python_requires='>=3.6', 68 | zip_safe=False 69 | ) 70 | -------------------------------------------------------------------------------- /duckiter/duckiter.py: -------------------------------------------------------------------------------- 1 | # -*- coding: utf-8 -*- 2 | # 3 | # Copyright (C) 2021- Soroush Safari 4 | # 5 | # This file is part of duckiter. 6 | # 7 | # duckiter is free software: you can redistribute it and/or modify 8 | # it under the terms of the GNU General Public License as published by 9 | # the Free Software Foundation, either version 3 of the License, or 10 | # (at your option) any later version. 11 | # 12 | # duckiter is distributed in the hope that it will be useful, 13 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 14 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 | # GNU General Public License for more details. 16 | # 17 | # You should have received a copy of the GNU General Public License 18 | # along with grest. If not, see . 19 | # 20 | 21 | import os 22 | import pathlib 23 | from threading import Thread 24 | from time import sleep 25 | 26 | import docker 27 | from rich import print 28 | from rich.console import Console 29 | 30 | from duckiter.config import get_config 31 | from duckiter.utility import (create_docker_configuration_file, 32 | create_dockerfile, get_django_project_name, 33 | generate_random_string) 34 | from duckiter.validation import (check_dockerfile, 35 | docker_engine_status_checker, pre_validation) 36 | 37 | 38 | class Duckiter: 39 | def __init__(self): 40 | self.__project_path = os.getcwd() 41 | self.__MODULE_PATH = str(pathlib.Path(__file__).resolve().parent) 42 | self.__docker_client = None 43 | self.__project_name = '' 44 | self.__config = {} 45 | self.__project_name = get_django_project_name( 46 | project_path=self.__project_path) 47 | 48 | def initialize(self): 49 | pre_validation(project_path=self.__project_path) 50 | print("[bold green][ INITIALIZING ][/bold green]") 51 | 52 | print("[ 3/6 ] getting project name ......[bold green][ passed ][/bold green]") 53 | 54 | self.__config = get_config() 55 | print("[ 4/6 ] getting configuration ......[bold green][ passed ][/bold green]") 56 | 57 | create_docker_configuration_file( 58 | config=self.__config, 59 | project_name=self.__project_name, 60 | project_path=self.__project_path) 61 | print( 62 | "[ 5/6 ] creating configuration file ......[bold green][ passed ][/bold green]") 63 | 64 | create_dockerfile(project_path=self.__project_path) 65 | print("[ 6/6 ] creating Dockerfile ......[bold green][ passed ][/bold green]") 66 | print( 67 | "[bold green][ NOTE ][/bold green] if there is gunicorn or daphne in your requirements.txt, Duckiter run your project with them" 68 | ", else your project will be run with runserver.") 69 | 70 | print("[bold green][ NOTE ][/bold green] if you didn't provide --build, you can edit Dockerfile or config.cfg and then run --build .") 71 | 72 | def build(self): 73 | self.__project_path = os.getcwd() 74 | 75 | docker_engine_status_checker() 76 | check_dockerfile(project_path=self.__project_path) 77 | 78 | print("[bold green][ BUILDING IMAGE ][/bold green]") 79 | print("it is going to take a while, please be patient...") 80 | 81 | self.__image_name = self.__project_name + "-" + generate_random_string() 82 | self.__state = True 83 | 84 | create_image_thread = Thread(target=self.__build) 85 | create_image_thread.start() 86 | 87 | console = Console() 88 | with console.status("[bold green]Building image .....", spinner='point') as status: 89 | while self.__state: 90 | sleep(0.1) 91 | 92 | print("\n") 93 | print(" [ 3/3 ] creating image ......[bold green][ passed ][/bold green]") 94 | print("[bold green][ NOTE ][/bold green] you can run your image :") 95 | print(f'docker run -d -p 8000:8000 {self.__image_name}') 96 | print("you can hit '127.0.0.1:8000' in your browser.") 97 | 98 | def __build(self): 99 | client = docker.from_env() 100 | client.images.build( 101 | path=self.__project_path, 102 | tag=self.__image_name, 103 | rm=True, 104 | forcerm=True) 105 | self.__state = False 106 | -------------------------------------------------------------------------------- /duckiter/validation.py: -------------------------------------------------------------------------------- 1 | # -*- coding: utf-8 -*- 2 | # 3 | # Copyright (C) 2021- Soroush Safari 4 | # 5 | # This file is part of duckiter. 6 | # 7 | # duckiter is free software: you can redistribute it and/or modify 8 | # it under the terms of the GNU General Public License as published by 9 | # the Free Software Foundation, either version 3 of the License, or 10 | # (at your option) any later version. 11 | # 12 | # duckiter is distributed in the hope that it will be useful, 13 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 14 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 | # GNU General Public License for more details. 16 | # 17 | # You should have received a copy of the GNU General Public License 18 | # along with grest. If not, see . 19 | # 20 | 21 | import sys 22 | import os 23 | 24 | import docker 25 | from docker.errors import DockerException 26 | from rich import print 27 | 28 | 29 | def pre_validation(project_path): 30 | """ 31 | check if project_path is valid path ( contain django project) 32 | 33 | :param project_path: path of project 34 | """ 35 | 36 | # check project_path status ( is valid django project) 37 | REQUIREMENTS_AUTO_CREATED = False 38 | 39 | if not os.path.exists(os.path.join(project_path, 'manage.py')): 40 | print("[bold red][ WARNNING !!!! ][/bold red] this is not valid django project, run '--init' inside django project.") 41 | sys.exit() 42 | print("[ 1/6 ] check project validity ......[bold green][ passed ][/bold green]") 43 | 44 | if not os.path.exists(os.path.join(project_path, 'requirements.txt')): 45 | venv_path = '' 46 | 47 | for r, d, f in os.walk(project_path): 48 | for file in f: 49 | if file.lower() == 'pyvenv.cfg': 50 | path_seprator, venv_path = '/' if '/' in r else '\\', r 51 | 52 | if not venv_path: 53 | print("[bold red][ WARNNING DEBUG !!!! ][/bold red] There isn't any 'requirements.txt' file or virtual environment in current path, please provide for further steps.") 54 | sys.exit() 55 | 56 | print( 57 | "[bold blue][ ACTION ][/bold blue] requirements.txt file not found," 58 | "creating this file automatically through your virutal environment" 59 | " ({})".format(venv_path.split(path_seprator)[-1]) 60 | ) 61 | 62 | MODULES = [] 63 | if os.name == 'nt': 64 | venv_path = os.path.join( 65 | venv_path, 'Lib', 'site-packages') 66 | else: 67 | venv_path = os.path.join( 68 | venv_path, 'lib', [i for i in os.walk(os.path.join(venv_path, 'lib'))][0][1][0], 'site-packages') 69 | 70 | for i in os.listdir(venv_path): 71 | if os.path.isdir(os.path.join(venv_path, i)): 72 | if ( 73 | not i.startswith(('pip', 'setuptools', 'wheel')) and 74 | i not in ['_distutils_hack', 'pkg_resources'] and 75 | i.endswith('.dist-info') 76 | ): 77 | MODULES.append('=='.join(i.split('.dist-info')[0].split('-'))) 78 | 79 | with open('requirements.txt', 'a') as requirements_file: 80 | for MODULE in MODULES: 81 | requirements_file.write(MODULE+'\n') 82 | requirements_file.close() 83 | REQUIREMENTS_AUTO_CREATED = True 84 | 85 | print(" [ 2/6 ] {}[bold green][ passed ][/bold green]".format( 86 | 'check requirements.txt validty...' if not REQUIREMENTS_AUTO_CREATED else 87 | 'The requirements.txt file is created automatically for your project and will be used in project dockerizing.' 88 | )) 89 | 90 | 91 | def docker_engine_status_checker() -> None: 92 | """ 93 | check is docker engine already up 94 | """ 95 | 96 | try: 97 | docker.from_env() 98 | except DockerException: 99 | print("[bold red][ WARNNING !!!! ][/bold red] It seems your docker engine doesn't run, please run the Docker engine.") 100 | sys.exit() 101 | print(" [ 1/3 ] check docker engine status ......[bold green][ passed ][/bold green]") 102 | 103 | 104 | def check_dockerfile(project_path): 105 | """ 106 | check if project path has Dockerfile ( for build process ) 107 | 108 | :param project_path: path of project 109 | """ 110 | if not os.path.exists(os.path.join(project_path, 'Dockerfile')): 111 | print("[bold red][ WARNNING !!!! ][/bold red] this is not valid django project, run '--init' inside django project.") 112 | sys.exit() 113 | print(" [ 2/3 ] check project validity ......[bold green][ passed ][/bold green]") 114 | -------------------------------------------------------------------------------- /duckiter/utility.py: -------------------------------------------------------------------------------- 1 | # -*- coding: utf-8 -*- 2 | # 3 | # Copyright (C) 2021- Soroush Safari 4 | # 5 | # This file is part of duckiter. 6 | # 7 | # duckiter is free software: you can redistribute it and/or modify 8 | # it under the terms of the GNU General Public License as published by 9 | # the Free Software Foundation, either version 3 of the License, or 10 | # (at your option) any later version. 11 | # 12 | # duckiter is distributed in the hope that it will be useful, 13 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 14 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 | # GNU General Public License for more details. 16 | # 17 | # You should have received a copy of the GNU General Public License 18 | # along with grest. If not, see . 19 | # 20 | 21 | import configparser 22 | import os 23 | import random 24 | import string 25 | 26 | import docker 27 | from jinja2 import Template 28 | 29 | from duckiter.template.config_cfg import config_cfg as config_cfg_template 30 | from duckiter.template.docker_file import dockerfile as docker_file_template 31 | 32 | 33 | def get_django_project_name(project_path) -> str: 34 | """ 35 | get project name 36 | 37 | :param project_path: path of project 38 | """ 39 | # list of all files and dirs in root 40 | project_dirs = {} 41 | for r, d, f in os.walk(project_path): 42 | for file in f: 43 | project_dirs[file] = os.path.join(r, file) 44 | 45 | # get the path of settings.py file 46 | project_main_dir = str(project_dirs['settings.py']) 47 | 48 | return project_main_dir.split('/' if '/' in project_main_dir else '\\')[-2] 49 | 50 | 51 | def get_project_server(project_path, project_name) -> str: 52 | """ 53 | get project server ( runserver , gunicorn , daphne ,..... ) 54 | it looks through requirements.txt file 55 | 56 | :param project_path: path of project 57 | :param project_name: name of django project 58 | """ 59 | is_gunicorn = False 60 | is_daphne = False 61 | 62 | with open(os.path.join(project_path, 'requirements.txt'), 'r') as file: 63 | for line in file: 64 | if 'gunicorn' in line: 65 | is_gunicorn = True 66 | if 'daphne' in line: 67 | is_daphne = True 68 | 69 | if is_gunicorn: 70 | return f'CMD ["gunicorn" , "-b", "0.0.0.0:8000", "{project_name}.wsgi"]' 71 | elif is_daphne: 72 | 73 | return f'CMD ["daphne","-b", "0.0.0.0", "-p","8000", "--access-log", "-","--proxy-headers", "{project_name}.asgi:application"]' 74 | else: 75 | return 'CMD ["python", "manage.py", "runserver", "0.0.0.0:8000"]' 76 | 77 | 78 | def create_docker_configuration_file( 79 | config, project_name, project_path) -> None: 80 | """ 81 | create config.cfg file that Dockerfile read settings from this 82 | 83 | :param project_path: path of project 84 | :param config: configuration that user entered 85 | :param project_name: name of django project 86 | """ 87 | project_server = get_project_server( 88 | project_path=project_path, 89 | project_name=project_name) 90 | 91 | project_name = str(project_name) 92 | project_server = str(project_server) 93 | 94 | config_file = Template(config_cfg_template) 95 | config_file = config_file.render( 96 | project_name=project_name, 97 | python_version=config['python_version'], 98 | is_migration=config['is_migration'], 99 | project_server=project_server, 100 | ) 101 | 102 | with open(os.path.join(project_path, 'config.cfg'), 'w+') as file: 103 | file.write(config_file) 104 | 105 | 106 | def create_dockerfile(project_path) -> None: 107 | """ 108 | create dockerfile from config.cfg 109 | :param project_path: path of project 110 | """ 111 | config = configparser.RawConfigParser() 112 | config.read(os.path.join(project_path, 'config.cfg')) 113 | 114 | project_info = dict(config.items('project_info')) 115 | project_server = dict(config.items('project_server')) 116 | migrate = 'CMD ["python3","manage.py","migrate"]' if project_info['is_migration'] == 'True' else "" 117 | 118 | dockerfile = Template(docker_file_template) 119 | python_version = project_info['python_version'] 120 | python_server = project_server['project_server'] 121 | 122 | dockerfile = dockerfile.render( 123 | python_version=python_version, 124 | migrate=migrate, 125 | project_server=python_server, 126 | ) 127 | 128 | with open(os.path.join(project_path, 'Dockerfile'), 'w+') as file: 129 | file.write(dockerfile) 130 | 131 | 132 | def generate_random_string() -> str: 133 | """ 134 | create random string with 5 character 135 | """ 136 | letter = string.ascii_lowercase 137 | random_string = ''.join(random.choice(letter) for i in range(5)) 138 | return random_string 139 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------