├── .gitignore ├── githubaptrepos ├── sources.list ├── __main__.py ├── release-body.md ├── apt-add-repo ├── utils.py ├── repo.py ├── __init__.py ├── gpg.py └── github.py ├── setup.cfg ├── MANIFEST.in ├── make-release.sh ├── Makefile ├── setup.py ├── README.rst └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | /.venv 2 | /apt -------------------------------------------------------------------------------- /githubaptrepos/sources.list: -------------------------------------------------------------------------------- 1 | deb [trusted=yes] {base_download_url} ./ 2 | -------------------------------------------------------------------------------- /setup.cfg: -------------------------------------------------------------------------------- 1 | [egg_info] 2 | tag_build = dev 3 | tag_svn_revision = true 4 | -------------------------------------------------------------------------------- /MANIFEST.in: -------------------------------------------------------------------------------- 1 | recursive-include githubaptrepos apt-add-repo release-body.md sources.list 2 | -------------------------------------------------------------------------------- /githubaptrepos/__main__.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | """ 3 | Create Debian/Ubuntu apt repositories from GitHub releases. 4 | """ 5 | 6 | from . import main 7 | 8 | 9 | if __name__ == '__main__': 10 | main() 11 | -------------------------------------------------------------------------------- /make-release.sh: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | github-apt-repos \ 3 | --github-repo feverscreen/feverscreen \ 4 | --github-token ${GITHUB_TOKEN} \ 5 | --github-apt-repo feverscreen/fs-apt-source \ 6 | --gpg-pub-key ~/public.key \ 7 | --github-delete-existing 8 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | # Set up a isolated environment and install into it 2 | 3 | .PHONY: build 4 | build: .venv/bin/github-apt-repos 5 | 6 | .venv: 7 | virtualenv . 8 | 9 | .venv/bin/github-apt-repos: .venv 10 | .venv/bin/pip install -U --upgrade-strategy=eager -e . 11 | -------------------------------------------------------------------------------- /githubaptrepos/release-body.md: -------------------------------------------------------------------------------- 1 | # {name} 2 | 3 | To add this APT repository to your `/etc/apt/sources.list.d`, add the signing GPG key, and update the package DB, run the following command: 4 | 5 | $ curl -L https://github.com/{repo}/releases/download/{tag}/apt-add-repo | sh 6 | 7 | You can then use APT to install any of the packages in this repo and to automatically keep them up-to-date going forward 8 | -------------------------------------------------------------------------------- /githubaptrepos/apt-add-repo: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | # 3 | # Add APT repository, add the signing GPG key, and update the package DB 4 | 5 | set -xe 6 | 7 | 8 | main() {{ 9 | curl -L {base_download_url}/{gpg_pub_key_basename}.pub.key | 10 | sudo apt-key --keyring /etc/apt/trusted.gpg.d/{gpg_pub_key_basename}.gpg add - 11 | sudo curl -L -o /etc/apt/sources.list.d/{basename}.list \ 12 | {base_download_url}/{basename}.list 13 | sudo apt update 14 | }} 15 | 16 | 17 | main "$@" 18 | -------------------------------------------------------------------------------- /githubaptrepos/utils.py: -------------------------------------------------------------------------------- 1 | """ 2 | Utilities not specific to APT repositories. 3 | """ 4 | 5 | try: 6 | from urllib.parse import _ALWAYS_SAFE 7 | except ImportError: 8 | from urllib import always_safe 9 | _ALWAYS_SAFE = frozenset(always_safe) 10 | 11 | 12 | def quote_dotted(orig): 13 | """ 14 | Escape a string as a URL using dots instead of `%xx` escapes. 15 | 16 | Useful for generating strings that are both URL-safe and human-readable. 17 | """ 18 | dotted = ''.join([( 19 | char if char in _ALWAYS_SAFE else '.') for char in orig]) 20 | # Strip duplicate dots 21 | result = dotted.strip('.').replace('..', '.') 22 | while result != dotted: 23 | dotted = result 24 | result = dotted.replace('..', '.') 25 | return result 26 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | from setuptools import setup, find_packages 2 | 3 | version = '0.1' 4 | 5 | setup(name='github-apt-repos', 6 | version=version, 7 | description="Host Debian/Ubuntu APT repositories on GitHub releases.", 8 | long_description=open('README.rst').read(), 9 | classifiers=[ 10 | 'Development Status :: 3 - Alpha', 11 | 'Environment :: Console', 12 | 'Intended Audience :: Developers', 13 | 'License :: OSI Approved :: GNU General Public License (GPL)', 14 | 'Natural Language :: English', 15 | 'Operating System :: POSIX :: Linux', 16 | 'Programming Language :: Python', 17 | 'Topic :: Software Development', 18 | 'Topic :: Software Development :: Build Tools', 19 | 'Topic :: Software Development :: Version Control :: Git', 20 | 'Topic :: System :: Software Distribution', 21 | 'Topic :: Utilities', 22 | ], 23 | keywords='git github apt debian ubuntu deb dpkg', 24 | author='Ross Patterson', 25 | author_email='me@rpatterson.net', 26 | url='https://github.com/rpatterson/github-apt-repos', 27 | license='GPL', 28 | packages=find_packages(exclude=['ez_setup', 'examples', 'tests']), 29 | include_package_data=True, 30 | zip_safe=False, 31 | install_requires=[ 32 | 'python-gnupg', 33 | 'github3.py', 34 | ], 35 | entry_points={ 36 | 'console_scripts': [ 37 | 'github-apt-repos=githubaptrepos:main', 38 | ], 39 | }, 40 | ) 41 | -------------------------------------------------------------------------------- /githubaptrepos/repo.py: -------------------------------------------------------------------------------- 1 | """ 2 | Create Debian/Ubuntu apt repositories from `*.deb` files. 3 | 4 | The functionality here has minimal external dependencies. For example, no GPG 5 | or GitHub functionality. 6 | """ 7 | 8 | import os 9 | import glob 10 | import re 11 | import logging 12 | import argparse 13 | 14 | from apt import debfile 15 | 16 | logger = logging.getLogger('github-apt-repos') 17 | 18 | # The regular expression used to identify the dist of a `*.deb` package 19 | # package-name-dist_version_arch.deb 20 | DEB_BASENAME_RE = r'{package}([-_\.](?P.+)|)_{version}_{arch}' 21 | 22 | parser = argparse.ArgumentParser(description=__doc__) 23 | parser.add_argument( 24 | '--deb-dir', dest='deb_dir', metavar='DIR', 25 | help='The directory that contains the `*.deb` files, or into which ' 26 | 'to download them (default: a temporary directory).') 27 | parser.add_argument( 28 | '--apt-dir', dest='apt_dir', metavar='DIR', 29 | help='The directory in which to construct the `apt-dist-arch` APT ' 30 | 'repositories, (default: `--deb-dir`).') 31 | 32 | 33 | def get_deb_dist_arch(deb, basename_re=DEB_BASENAME_RE): 34 | """ 35 | Return the distribution and architecture for a `*.deb` file. 36 | 37 | The distribution is taken from what ever is left when the 38 | architecture, package name, and version are removed: 39 | 40 | package-name-dist_version_arch.deb 41 | """ 42 | deb_pkg = debfile.DebPackage(deb) 43 | arch = deb_pkg['Architecture'] 44 | package = deb_pkg['Package'] 45 | version = deb_pkg['Version'] 46 | deb_basename_match = re.match( 47 | DEB_BASENAME_RE.format( 48 | arch=arch, package=package, version=version), 49 | os.path.splitext(os.path.basename(deb))[0]) 50 | if deb_basename_match is None: 51 | dist = None 52 | else: 53 | dist = deb_basename_match.group(2) 54 | return dist, arch 55 | 56 | 57 | def group_debs( 58 | deb_dir=os.curdir, apt_dir=os.curdir, 59 | basename_re=DEB_BASENAME_RE): 60 | """ 61 | Groups the `*.deb` files by unique distribution and architecture. 62 | 63 | These groups are suitable for generating an APT repository from. 64 | 65 | The `*.deb` files are hard linked into the grouping to support 66 | re-using previously downloaded `*.deb`s. 67 | """ 68 | dist_arch_dirs = set() 69 | for deb in glob.glob(os.path.join(deb_dir, '*.deb')): 70 | dist, arch = get_deb_dist_arch(deb, basename_re) 71 | if dist is None: 72 | dist_arch_dir = os.path.join(apt_dir, arch) 73 | else: 74 | dist_arch_dir = os.path.join(apt_dir, dist, arch) 75 | try: # BBB Python 2, use exist_ok=True under Python 3 76 | os.makedirs(dist_arch_dir) 77 | except OSError as exc: 78 | # Ignore existing dirs 79 | if exc.errno != 17: 80 | raise 81 | dist_arch_dirs.add(dist_arch_dir) 82 | deb_link = os.path.join(dist_arch_dir, os.path.basename(deb)) 83 | if not os.path.exists(deb_link): 84 | logger.info('Linking: %r', deb_link) 85 | os.link(deb, deb_link) 86 | if not dist_arch_dirs: 87 | raise ValueError( 88 | 'No `*.deb` package files found in {0}'.format(deb_dir)) 89 | return dist_arch_dirs 90 | -------------------------------------------------------------------------------- /README.rst: -------------------------------------------------------------------------------- 1 | ===================================================== 2 | github-apt-repos 3 | ===================================================== 4 | Use GitHub releases as a Debian/Ubuntu apt repository 5 | ----------------------------------------------------- 6 | 7 | Provides a ``github-apt-repos`` utility for building simple, 8 | project-specific APT repositories without the overhead or build 9 | requirements of other APT repository hosts such as `Launchpad PPAs`_ 10 | or the `openSUSE Build Service`_. If your project's build process 11 | produces ``*.deb`` releases, or have considered it, but found the 12 | requirements of other APT repository host onerous, this may be for 13 | you. 14 | 15 | The ``github-apt-repos`` utility currently does roughly the following: 16 | 17 | #. Download the ``*.deb`` files from the latest GitHub release for a 18 | ``git`` checkout from GitHub 19 | #. Make an APT repository from the released ``*.deb`` files 20 | #. Upload the APT repository to a special GitHub release which 21 | Debian/Ubuntu users can use to keep up-to-date. 22 | 23 | Each phase is intended to be optional and incremental, re-using build 24 | artifacts already present, so it can be integrated into your build 25 | process. 26 | 27 | 28 | Installation 29 | ------------ 30 | 31 | The ``github-apt-repos`` utility is intended to be used in a 32 | Debian/Ubuntu build environment with the usual DPKG and APT build 33 | tools. Specifically it requires the following be installed:: 34 | 35 | $ sudo apt install python-pip dpkg-dev apt-utils gpg 36 | 37 | Since APT repositories require signing with GPG keys, 38 | ``github-apt-repos`` is intended to be run on a build machine with 39 | normal access to the GPG private keys to be used to sign the 40 | repository. If no key is specified, ``github-apt-repos`` will 41 | generate a new key for each project by default, so be sure to use it 42 | in an environment where you can preserve and manage the private keys. 43 | 44 | Finally, install the actual package and its dependencies:: 45 | 46 | $ sudo pip install https://github.com/rpatterson/github-apt-repos/archive/refs/heads/master.tar.gz 47 | 48 | 49 | Usage 50 | ----- 51 | 52 | Generally, run ``github-apt-repos`` inside the checkout of the GitHub 53 | checkout of the repository whose releases you want to build and upload 54 | an APT repository for. Note that, the APT repository needs to be 55 | updated whenever your project has a new release so you may want to 56 | integrate it in your build and release process and you may want to pay 57 | particular attention to the ``--apt-dir`` option argument. 58 | 59 | See the builtin, CLI help for further details:: 60 | 61 | $ github-apt-repos --help 62 | 63 | For example, TODO 64 | 65 | 66 | TODO 67 | ---- 68 | 69 | In general, I'm eager to accept contributions or feature requests 70 | that will generalize things, make different phases optional, and in 71 | general be more agnostic about specific build processes. For example, 72 | make GitHub optional, just build an APT repo from ``*.deb`` files. 73 | Another example, don't depend on git at all and be able to build an 74 | APT repository from any build of ``*.deb`` releases. 75 | 76 | Other TODOs: 77 | 78 | - Release to PyPI 79 | - Dogfood ``*.deb`` releases hosted in an APT repository on GitHub 80 | - Short CLI options? I'm really not sure we should. 81 | - GitHub CLI to automatically build the apt repo when the upstream fork adds a 82 | release tag 83 | 84 | I'm also open to discussing other contributions and feature requests. 85 | Send PR's freely. 86 | 87 | 88 | .. _Launchpad PPAs: https://help.launchpad.net/Packaging/PPA 89 | .. _openSUSE Build Service: https://build.opensuse.org/ 90 | -------------------------------------------------------------------------------- /githubaptrepos/__init__.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | """ 3 | Create Debian/Ubuntu apt repositories from GitHub releases. 4 | """ 5 | 6 | import os 7 | import tempfile 8 | import email.utils 9 | import shutil 10 | import logging 11 | 12 | from . import utils 13 | 14 | logger = logging.getLogger('github-apt-repos') 15 | 16 | 17 | def main(): 18 | """ 19 | Download all release deb assets, build and upload APT repos. 20 | """ 21 | from . import gpg 22 | from . import github 23 | from . import repo 24 | 25 | logging.basicConfig(level=logging.INFO) 26 | 27 | ########################################################################## 28 | # First do as much option handling as possible to fail early # 29 | ########################################################################## 30 | args = repo.parser.parse_args() 31 | 32 | # Optionally sign into the GitHub API 33 | api = github.login(args) 34 | 35 | # Optionally determine the GitHub repositories 36 | gh_repo_path = args.gh_repo 37 | if gh_repo_path is None: 38 | # Try to get a repo path from a checkout in the current directory 39 | try: 40 | gh_repo_path = github.get_github_repo_path() 41 | except Exception: 42 | pass 43 | deb_repo = apt_repo = github.parse_repo_path(api, gh_repo_path) 44 | if args.gh_apt_repo is not None: 45 | apt_repo = github.parse_repo_path(api, args.gh_apt_repo) 46 | 47 | # Optionally set up GPG for signing the APT repositories 48 | gpg_pub_key, gpg_user_id = gpg.set_up_gpg_key(args, apt_repo) 49 | 50 | ########################################################################## 51 | # Finally, do any mutating or longer running tasks # 52 | ########################################################################## 53 | try: 54 | # Set up working directories 55 | deb_dir = args.deb_dir 56 | if deb_dir is None: 57 | if deb_repo is None: 58 | raise ValueError( 59 | 'Must provide `--deb-dir` or a GitHub repository from ' 60 | 'which to download release `*.deb` package files.') 61 | prefix = 'deb' 62 | if apt_repo is not None: 63 | prefix += '-{0}-{1}'.format( 64 | apt_repo.owner.login, apt_repo.name) 65 | deb_dir = tempfile.mkdtemp(prefix=prefix) 66 | apt_dir = args.apt_dir 67 | if apt_dir is None: 68 | apt_dir = deb_dir 69 | 70 | # Download releases if the repo is given 71 | if deb_repo is not None: 72 | tag, assets = github.download_release_debs( 73 | deb_repo, 74 | prerelease=args.gh_prerelease, tag=args.gh_download_tag, 75 | deb_dir=deb_dir) 76 | 77 | # Groups the `*.deb` files by unique distribution and architecture. 78 | dist_arch_dirs = repo.group_debs(deb_dir=deb_dir, apt_dir=apt_dir) 79 | 80 | gpg_pub_key_src = None 81 | if gpg_pub_key is not None: 82 | gpg_pub_key_basename = utils.quote_dotted( 83 | email.utils.parseaddr(gpg_user_id)[1]) 84 | if gpg_pub_key_basename == '': 85 | gpg_pub_key_basename = 'default' 86 | gpg_pub_key_src = os.path.join( 87 | apt_dir, gpg_pub_key_basename + '.pub.key') 88 | if not os.path.exists(gpg_pub_key_src): 89 | logger.info('Writing public key: %s', gpg_pub_key_src) 90 | with open(gpg_pub_key_src, 'w') as gpg_pub_key_opened: 91 | gpg_pub_key_opened.write(gpg_pub_key) 92 | 93 | for dist_arch_dir in dist_arch_dirs: 94 | gpg.make_apt_repo(gpg_user_id, gpg_pub_key_src, dist_arch_dir) 95 | 96 | if apt_repo is not None: 97 | for dist_arch_dir in dist_arch_dirs: 98 | github.release_apt_repo( 99 | apt_repo, apt_dir, dist_arch_dir, 100 | tag_prefix=args.gh_release_prefix or tag, 101 | gpg_pub_key_basename=gpg_pub_key_basename, 102 | delete_existing=args.gh_delete_existing) 103 | 104 | finally: 105 | if deb_dir is not None and args.deb_dir is None: 106 | # If using a temporary directory, be sure to clean it up 107 | shutil.rmtree(deb_dir, ignore_errors=True) 108 | 109 | 110 | if __name__ == '__main__': 111 | main() 112 | -------------------------------------------------------------------------------- /githubaptrepos/gpg.py: -------------------------------------------------------------------------------- 1 | """ 2 | Sign Debian/Ubuntu apt repositories with GPG keys. 3 | 4 | All GPG dependent functionality lives here. 5 | """ 6 | 7 | import os 8 | import logging 9 | import email.utils 10 | import subprocess 11 | 12 | import gnupg 13 | 14 | from . import repo 15 | 16 | logger = logging.getLogger('github-apt-repose') 17 | 18 | gpg = gnupg.GPG() 19 | 20 | gpg_group = repo.parser.add_argument_group( 21 | title='GnuPG Options', 22 | description='Options controlling the GPG signing of the APT repository, ' 23 | 'provide only one.').add_mutually_exclusive_group() 24 | gpg_group.add_argument( 25 | '--gpg-pub-key', dest='gpg_pub_key', 26 | help='The path to an exported GPG public key of the private key with ' 27 | 'which to sign the APT repository (default: if present, a previously ' 28 | 'generated key based on the `--repo-dir` GitHub repository).') 29 | gpg_group.add_argument( 30 | '--gpg-user-id', dest='gpg_user_id', 31 | help='The GPG `user-id` of the key to sign the APT repository with ' 32 | '(default: generate a user ID from the `--repo-dir` ' 33 | 'GitHub user/organization name and the repository name).') 34 | 35 | 36 | def set_up_gpg_key(args, apt_repo=None, gpg=gpg): 37 | """ 38 | Optionally lookup or generate the GPG key to sign the APT repository. 39 | """ 40 | gpg_pub_key_path = args.gpg_pub_key 41 | gpg_user_id = args.gpg_user_id 42 | if gpg_pub_key_path is None: 43 | if gpg_user_id is None and apt_repo is not None: 44 | gpg_user_id = ( 45 | '{repo_name} {user_name} ' 46 | '<{user_name}+{repo_name}@github.com>'.format( 47 | user_name=apt_repo.owner.login, repo_name=apt_repo.name)) 48 | 49 | if gpg_user_id is not None: 50 | gpg_pub_key = gpg.export_keys(gpg_user_id) 51 | if not gpg_pub_key: 52 | logger.info( 53 | 'Public key not found for %r, generating a new key', 54 | gpg_user_id) 55 | name_real, name_email = email.utils.parseaddr(gpg_user_id) 56 | generated = gpg.gen_key( 57 | gpg.gen_key_input( 58 | name_real=name_real, name_email=name_email)) 59 | print("GPGKEY", generated) 60 | if not generated.fingerprint: 61 | raise ValueError( 62 | 'APT repository signing key not generated') 63 | gpg_pub_key = gpg.export_keys(gpg_user_id) 64 | else: 65 | gpg_pub_key_scanned, = gpg.scan_keys(gpg_pub_key_path) 66 | gpg_user_id = gpg_pub_key_scanned['uids'][0] 67 | gpg_pub_key = gpg.export_keys(gpg_user_id) 68 | 69 | return gpg_pub_key, gpg_user_id 70 | 71 | 72 | def make_apt_repo( 73 | gpg_user_id=None, gpg_pub_key_src=None, dist_arch_dir=os.curdir, 74 | gpg=gpg): 75 | """ 76 | Make an APT repository from a directory containing `*.deb` files. 77 | 78 | The repository will cause unexpected packages to be downloaded by 79 | apt unless the debs in this directory are only of one unique 80 | distribution and architecture combination, such as the grouping 81 | done by `group_debs()`. 82 | """ 83 | # Generate the Packages file 84 | with open(os.path.join(dist_arch_dir, 'Packages'), 'w') as packages: 85 | logger.info('Writing %r', packages.name) 86 | 87 | subprocess.check_call( 88 | ['dpkg-scanpackages', '-m', os.curdir, '/dev/null'], 89 | cwd=dist_arch_dir, stdout=packages) 90 | 91 | # Generate the Release file 92 | with open(os.path.join(dist_arch_dir, 'Release'), 'w') as release: 93 | logger.info('Writing %r', release.name) 94 | subprocess.check_call( 95 | ['apt-ftparchive', 'release', dist_arch_dir], 96 | stdout=release) 97 | 98 | # Optionally sign the Release files 99 | if gpg_user_id is not None: 100 | in_release_path = os.path.join(dist_arch_dir, 'InRelease') 101 | release_gpg_path = os.path.join(dist_arch_dir, 'Release.gpg') 102 | with open(os.path.join(dist_arch_dir, 'Release'), 'rb') as release: 103 | logger.info('Signing %r', in_release_path) 104 | signed = gpg.sign_file( 105 | release, keyid=gpg_user_id, output=in_release_path) 106 | if not signed.fingerprint: 107 | raise ValueError( 108 | 'Failed to sign the APT repository `InRelease` file') 109 | 110 | release.seek(0) 111 | logger.info('Signing %r', release_gpg_path) 112 | signed = gpg.sign_file( 113 | release, keyid=gpg_user_id, 114 | clearsign=False, detach=True, output=release_gpg_path) 115 | if not signed.fingerprint: 116 | raise ValueError( 117 | 'Failed to sign the APT repository `Release.gpg` file') 118 | 119 | # Optionally link the public key 120 | if gpg_pub_key_src is not None: 121 | gpg_pub_key_dst = os.path.join( 122 | dist_arch_dir, os.path.basename(gpg_pub_key_src)) 123 | if not os.path.exists(gpg_pub_key_dst): 124 | logger.info('Linking the public key: %r', gpg_pub_key_dst) 125 | os.link(gpg_pub_key_src, gpg_pub_key_dst) 126 | -------------------------------------------------------------------------------- /githubaptrepos/github.py: -------------------------------------------------------------------------------- 1 | """ 2 | Use GitHub releases as Debian/Ubuntu apt repositories. 3 | 4 | All GitHub dependent functionality lives here. 5 | """ 6 | 7 | import os 8 | import stat 9 | import re 10 | import mimetypes 11 | import logging 12 | import subprocess 13 | 14 | try: 15 | from urllib.request import urlretrieve 16 | except ImportError: 17 | from urllib import urlretrieve # BBB Python 2 18 | 19 | import github3 20 | 21 | from . import repo 22 | 23 | logger = logging.getLogger('github-apt-repos') 24 | 25 | # Map APT repo files without extensions to their closes match 26 | APT_EXTENSIONS = { 27 | 'Packages': '.txt', 28 | 'Release': '.txt', 29 | 'InRelease': '.sig', 30 | 'apt-add-repo': '.sh', 31 | } 32 | 33 | GH_ORIGIN_URL_RE = re.compile( 34 | r'^(https://github.com/|git@github.com:)' 35 | r'(?P(?P.+)/(?P.+?))(.git|)$') 36 | 37 | gh_group = repo.parser.add_argument_group( 38 | title='GitHub Options', 39 | description='Options controlling the interactions with GitHub. ' 40 | 'For automatic download of GitHub `*.deb` releases or uploading ' 41 | 'the APT repository to a GitHub release, either ' 42 | '`--github-token` or `--github-user` is required.') 43 | gh_auth_group = gh_group.add_mutually_exclusive_group() 44 | gh_auth_group.add_argument( 45 | '--github-token', dest='gh_access_token', metavar='GITHUB_TOKEN', 46 | help='Your GitHub API access token: https://github.com/settings/tokens') 47 | gh_auth_group.add_argument( 48 | '--github-user', dest='gh_user', metavar='GITHUB_USER', 49 | help='Your GitHub login user name.') 50 | gh_group.add_argument( 51 | '--github-repo', metavar='GITHUB_REPO_PATH', dest='gh_repo', 52 | help="If given a GitHub repoitory's `username/repo` path, " 53 | "download the `*.deb` files from that repository's releases.") 54 | gh_group.add_argument( 55 | '--github-prerelease', dest='gh_prerelease', action='store_true', 56 | help="Get the latest GitHub release including pre-releases, " 57 | "not just final releases? (default: False).") 58 | gh_group.add_argument( 59 | '--github-download-tag', metavar='GITHUB_RELEASE_TAG', 60 | dest='gh_download_tag', 61 | help="The GitHub release tag from which to download `*.deb` files " 62 | "(default: latest release).") 63 | gh_group.add_argument( 64 | '--github-apt-repo', metavar='GITHUB_REPO_PATH', dest='gh_apt_repo', 65 | help="The GitHub `username/repo` path of the repository who's releases " 66 | "the APT repositories will be uploaded to (default: --github-repo).") 67 | gh_group.add_argument( 68 | '--github-release-prefix', metavar='GITHUB_RELEASE_TAG_PREFIX', 69 | dest='gh_release_prefix', 70 | help="A prefix to prepend to the `apt-dist-arch` to form the GitHub " 71 | "release tag to upload the APT repository to." 72 | "(default: `--github-download-tag` or none for the latest release).") 73 | gh_group.add_argument( 74 | '--github-delete-existing', action='store_true', 75 | dest='gh_delete_existing', 76 | help="Delete and re-upload existing release assets if present. " 77 | "(default: False).") 78 | 79 | 80 | def login(args): 81 | """ 82 | Optionally sign into the GitHub API 83 | """ 84 | api = None 85 | if args.gh_access_token is not None: 86 | api = github3.login(token=args.gh_access_token) 87 | elif args.gh_user is not None: 88 | password = input('GitHub login password:') 89 | api = github3.login(username=args.gh_user, password=password) 90 | elif args.gh_repo is not None or args.gh_apt_repo is not None: 91 | repo.parser.error( 92 | 'Must give `--github-token` or `--github-user` ' 93 | 'if using `--github-repo` or `--github-apt-repo`') 94 | return api 95 | 96 | 97 | def parse_repo_path(api, repo_path): 98 | """ 99 | Lookup a GitHub repository from the API given a `user/repo` path. 100 | """ 101 | if api is None or repo_path is None: 102 | return 103 | user_name, repo_name = repo_path.split('/', 1) 104 | return api.repository(user_name, repo_name) 105 | 106 | 107 | def get_deb_assets(release): 108 | """ 109 | Get all the release assets that contain `*.deb` package files. 110 | """ 111 | return [ 112 | asset for asset in release.assets() 113 | if os.path.splitext(asset.name)[1] == '.deb'] 114 | 115 | 116 | def download_release_debs( 117 | deb_repo, prerelease=False, tag=None, deb_dir=os.curdir): 118 | """ 119 | Download all the `*.deb` assets from the release. 120 | 121 | Defaults to the latest release. 122 | """ 123 | if tag is not None: 124 | release = deb_repo.release_from_tag(tag) 125 | assets = get_deb_assets(release) 126 | elif prerelease: 127 | for release in deb_repo.releases(): 128 | if not release.prerelease: 129 | # Skip any final releases that may have been released more 130 | # recently than a pre-release 131 | continue 132 | assets = get_deb_assets(release) 133 | if assets: 134 | break 135 | else: 136 | # No prerelease found, use the latest stable release 137 | release = deb_repo.latest_release() 138 | logger.warn('No prerelease, falling back to latest %r', release) 139 | assets = get_deb_assets(release) 140 | tag = release.tag_name 141 | else: 142 | release = deb_repo.latest_release() 143 | assets = get_deb_assets(release) 144 | 145 | if not assets: 146 | raise ValueError( 147 | 'No `*.deb` assets in {0!r}'.format(release)) 148 | 149 | for asset in assets: 150 | dest = os.path.join(deb_dir, asset.name) 151 | if not os.path.exists(dest): 152 | logger.info( 153 | 'Downloading release asset: %s', asset.browser_download_url) 154 | urlretrieve(asset.browser_download_url, dest) 155 | else: 156 | logger.info( 157 | 'Re-using previously downloaded `*.deb` file: %r', dest) 158 | 159 | return tag, assets 160 | 161 | 162 | def get_github_repo_path(repo_dir=os.curdir, origin_url_re=GH_ORIGIN_URL_RE): 163 | """ 164 | Get the GitHub `user/repo` repository path from a checkout's origin. 165 | """ 166 | origin_url = subprocess.check_output( 167 | ['git', 'remote', 'get-url', 'origin']).strip() 168 | origin_match = origin_url_re.match(origin_url) 169 | if origin_match is None: 170 | raise ValueError( 171 | 'Did not recognize origin remote URL ' 172 | 'as a GitHub remote: {0}'.format(origin_url)) 173 | return origin_match.group('gh_repo_path') 174 | 175 | 176 | def release_apt_repo( 177 | apt_repo, apt_dir, dist_arch_dir, 178 | tag_prefix=None, gpg_pub_key_basename=None, delete_existing=False): 179 | """ 180 | Upload the APT repository as a GitHub release. 181 | """ 182 | # Convert the dist+arch specific APT repo path to a GH-friendly tag 183 | dist_arch = os.path.relpath(dist_arch_dir, apt_dir) 184 | if tag_prefix is None: 185 | tag_prefix = 'apt' 186 | else: 187 | tag_prefix = 'apt-' + tag_prefix 188 | tag = tag_prefix + '-' + dist_arch.replace('/', '-') 189 | 190 | base_download_url = 'https://github.com/{0}/releases/download/{1}'.format( 191 | apt_repo.full_name, tag) 192 | user_repo_basename = apt_repo.owner.login + '-' + apt_repo.name 193 | 194 | # Generate the APT repo sources.list 195 | apt_add_path = os.path.join(dist_arch_dir, user_repo_basename + '.list') 196 | with open(os.path.join( 197 | os.path.dirname(__file__), 'sources.list')) as apt_add_repo_tmpl: 198 | with open(apt_add_path, 'w') as apt_add_repo: 199 | logger.info( 200 | 'Writing the APT repository source: %r', apt_add_path) 201 | apt_add_repo.write( 202 | apt_add_repo_tmpl.read().format( 203 | base_download_url=base_download_url, 204 | basename=user_repo_basename)) 205 | 206 | # Generate the APT repo install script 207 | apt_add_path = os.path.join(dist_arch_dir, 'apt-add-repo') 208 | with open(os.path.join( 209 | os.path.dirname(__file__), 'apt-add-repo')) as apt_add_repo_tmpl: 210 | with open(apt_add_path, 'w') as apt_add_repo: 211 | logger.info( 212 | 'Writing the APT repository install script: %r', apt_add_path) 213 | apt_add_repo.write( 214 | apt_add_repo_tmpl.read().format( 215 | base_download_url=base_download_url, 216 | basename=user_repo_basename, 217 | gpg_pub_key_basename=gpg_pub_key_basename)) 218 | os.chmod( 219 | apt_add_path, stat.S_IRUSR | stat.S_IWUSR | stat.S_IXUSR | 220 | stat.S_IRGRP | stat.S_IWGRP | stat.S_IXGRP | stat.S_IROTH | 221 | stat.S_IXOTH) 222 | 223 | # Get or create the corresponding GH release 224 | try: 225 | release = apt_repo.release_from_tag(tag) 226 | except github3.exceptions.NotFoundError: 227 | name = 'Debian/Ubuntu APT repository for {0} on {1}'.format( 228 | tag, dist_arch) 229 | with open(os.path.join( 230 | os.path.dirname(__file__), 'release-body.md')) as body_opened: 231 | # Generate the release body text 232 | body = body_opened.read().format(repo=apt_repo, tag=tag, name=name) 233 | logger.info('Creating new release: %s', tag) 234 | release = apt_repo.create_release(tag_name=tag, name=name, body=body) 235 | 236 | # Add or update (delete and re-add) the assets 237 | assets = {asset.name: asset for asset in release.assets()} 238 | for asset_name in os.listdir(dist_arch_dir): 239 | asset = assets.get(asset_name) 240 | if asset is not None: 241 | if os.path.splitext(asset_name)[1] != '.deb' or delete_existing: 242 | # Delete any assets that correspond to one in the repo 243 | logger.info( 244 | 'Deleting existing release asset: %s', 245 | asset.browser_download_url) 246 | asset.delete() 247 | else: 248 | logger.info( 249 | 'Preserving existing release asset: %s', 250 | asset.browser_download_url) 251 | continue 252 | 253 | # Guess the most appropriate MIME type 254 | path = os.path.join(dist_arch_dir, asset_name) 255 | content_type, encoding = mimetypes.guess_type(asset_name) 256 | if content_type is None: 257 | content_type, encoding = mimetypes.guess_type( 258 | asset_name + APT_EXTENSIONS.get(asset_name, '.txt')) 259 | 260 | # NOTE: for some reason .deb files were being treated as text, and then utf-8 validation fails 261 | # when trying to upload them. Make sure we open .deb files as binary. 262 | mode = 'rb' 263 | 264 | logger.info( 265 | 'Uploading release asset: %s', path) 266 | with open(path, mode) as asset_opened: 267 | asset = release.upload_asset( 268 | content_type=content_type, name=asset_name, 269 | asset=asset_opened) 270 | -------------------------------------------------------------------------------- /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 | --------------------------------------------------------------------------------