├── rss_reader
    ├── __init__.py
    ├── reader
    │   ├── __init__.py
    │   └── _reader.py
    ├── imports
    │   ├── __init__.py
    │   └── _json.py
    ├── config
    │   ├── __init__.py
    │   ├── _base.py
    │   └── _data.py
    ├── argument_parser
    │   ├── __init__.py
    │   ├── _models.py
    │   ├── types.py
    │   └── _parser.py
    ├── converter
    │   ├── __init__.py
    │   ├── xhtml_template.jinja2
    │   ├── html_template.jinja2
    │   ├── pretty_html_template.jinja2
    │   └── _converter.py
    ├── printer
    │   ├── __init__.py
    │   └── _printer.py
    └── __main__.py
├── MANIFEST.in
├── renovate.json
├── .flake8
├── .github
    └── workflows
    │   ├── publish_to_pypi.yml
    │   └── lint.yml
├── .pre-commit-config.yaml
├── .gitignore
├── pyproject.toml
├── README.md
└── LICENSE


/rss_reader/__init__.py:
--------------------------------------------------------------------------------
1 | 


--------------------------------------------------------------------------------
/MANIFEST.in:
--------------------------------------------------------------------------------
1 | include rss_reader/converter/*.jinja2


--------------------------------------------------------------------------------
/rss_reader/reader/__init__.py:
--------------------------------------------------------------------------------
1 | from ._reader import Reader
2 | 


--------------------------------------------------------------------------------
/renovate.json:
--------------------------------------------------------------------------------
1 | {
2 |   "extends": [
3 |     "config:base"
4 |   ]
5 | }
6 | 


--------------------------------------------------------------------------------
/.flake8:
--------------------------------------------------------------------------------
1 | [flake8]
2 | max-line-length = 120
3 | exclude = venv/*, src/*, __init__.py, dist/*, build/*, *.egg-info/*


--------------------------------------------------------------------------------
/rss_reader/imports/__init__.py:
--------------------------------------------------------------------------------
1 | """Module which parses possible module replacements and speedups"""
2 | from ._json import json
3 | 


--------------------------------------------------------------------------------
/rss_reader/config/__init__.py:
--------------------------------------------------------------------------------
1 | """Config module"""
2 | from ._base import MODULE_DIR, OUTPUT_DIR
3 | from ._data import data_config
4 | 


--------------------------------------------------------------------------------
/rss_reader/argument_parser/__init__.py:
--------------------------------------------------------------------------------
1 | """Cli argument parser module"""
2 | from ._models import ArgsModel
3 | from ._parser import ArgParser
4 | 


--------------------------------------------------------------------------------
/rss_reader/converter/__init__.py:
--------------------------------------------------------------------------------
1 | """Module that provides Converter class which converts feed to different formats"""
2 | from ._converter import Converter
3 | 


--------------------------------------------------------------------------------
/rss_reader/printer/__init__.py:
--------------------------------------------------------------------------------
1 | """Module that provides Printer class which prints feed to console in different formats"""
2 | from ._printer import Printer
3 | 


--------------------------------------------------------------------------------
/rss_reader/argument_parser/_models.py:
--------------------------------------------------------------------------------
 1 | import argparse
 2 | 
 3 | 
 4 | class ArgsModel(argparse.Namespace):
 5 |     """Argparse output namespace schema to make linters work"""
 6 | 
 7 |     source: str
 8 |     version: str
 9 |     verbose: bool
10 |     output: str
11 |     convert: str
12 |     convert_dir: str
13 |     convert_file: str
14 |     limit: int
15 |     pretty: bool
16 | 


--------------------------------------------------------------------------------
/rss_reader/config/_base.py:
--------------------------------------------------------------------------------
 1 | from os import mkdir
 2 | from os.path import isdir, join
 3 | from pathlib import Path
 4 | 
 5 | BASE_DIR = join(str(Path.home()), "rss_reader")
 6 | if not isdir(BASE_DIR):
 7 |     mkdir(BASE_DIR)
 8 | 
 9 | OUTPUT_DIR = join(BASE_DIR, "output")
10 | if not isdir(OUTPUT_DIR):
11 |     mkdir(OUTPUT_DIR)
12 | 
13 | MODULE_DIR = Path(__file__).parent.parent
14 | 


--------------------------------------------------------------------------------
/rss_reader/imports/_json.py:
--------------------------------------------------------------------------------
 1 | import pkg_resources
 2 | 
 3 | # For now supporting only ujson as alternatives like rapidjson, hyperjson are not consistent in benchmarks
 4 | SUPPORTED_MODULES = ["ujson"]
 5 | DOWNLOADED = [
 6 |     pkg.key for pkg in pkg_resources.working_set if pkg.key in SUPPORTED_MODULES
 7 | ]
 8 | USAGE = DOWNLOADED[-1] if DOWNLOADED else "json"
 9 | 
10 | json = __import__(USAGE)
11 | 


--------------------------------------------------------------------------------
/.github/workflows/publish_to_pypi.yml:
--------------------------------------------------------------------------------
 1 | name: Publish Package to PyPI with poetry
 2 | 
 3 | on:
 4 |   push:
 5 |     tags:
 6 |       - 'v*'
 7 | 
 8 | jobs:
 9 |   build-and-test-publish:
10 |     runs-on: ubuntu-latest
11 |     steps:
12 |       - uses: actions/checkout@master
13 |       - name: Build and publish to pypi
14 |         uses: JRubics/poetry-publish@v1.5
15 |         with:
16 |           pypi_token: ${{ secrets.pypi_password }}


--------------------------------------------------------------------------------
/rss_reader/__main__.py:
--------------------------------------------------------------------------------
 1 | import logging
 2 | 
 3 | from .reader import Reader
 4 | 
 5 | logger = logging.getLogger("rss-reader")
 6 | 
 7 | 
 8 | def main():
 9 |     reader = Reader()
10 |     try:
11 |         reader.start()
12 |     except Exception as e:
13 |         logger.exception(e)
14 |         print(f"Rss reader crashed from {type(e).__name__}")
15 |         if not reader.config.verbose:
16 |             print("Consider using --verbose for more info")
17 | 
18 | 
19 | if __name__ == "__main__":
20 |     main()
21 | 


--------------------------------------------------------------------------------
/.github/workflows/lint.yml:
--------------------------------------------------------------------------------
 1 | name: Lint
 2 | 
 3 | on: [push, pull_request]
 4 | 
 5 | jobs:
 6 |   build:
 7 |     runs-on: ubuntu-latest
 8 | 
 9 |     strategy:
10 |       matrix:
11 |         os: [ "windows-latest", "ubuntu-latest" ]
12 |         python-version: [ 3.7, 3.8 ]
13 | 
14 |     steps:
15 |       - uses: actions/checkout@master
16 | 
17 |       - name: Set up Python ${{ matrix.python-version }} on ${{ matrix.os }}
18 |         uses: actions/setup-python@v2
19 |         with:
20 |           python-version: ${{ matrix.python-version }}
21 | 
22 |       - name: Install dependencies
23 |         run: |
24 |           python -m pip install --upgrade pip poetry
25 |           poetry install
26 |       - name: Lint code with flake8
27 |         run: |
28 |           poetry run flake8
29 |       - name: Lint code with black
30 |         run: |
31 |           poetry run black --check .
32 |       - name: Lint code with isort
33 |         run: |
34 |           poetry run isort --check-only .


--------------------------------------------------------------------------------
/rss_reader/converter/xhtml_template.jinja2:
--------------------------------------------------------------------------------
 1 | {# XML template for epub conversion #}
 2 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
 3 | 		"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
 4 | <html xmlns="http://www.w3.org/1999/xhtml" lang="{{ language }}">
 5 | <head>
 6 | 	<meta content="text/html; charset=utf-8">
 7 | 	<title>{{ item.title }}</title>
 8 | </head>
 9 | <body>
10 | 	<p class="item_title">{{ item.title }}</p>
11 | 	{% if item.publish_date %}
12 | 		<p class="publish_date">{{ item.publish_date }}</p>
13 | 	{% endif %}
14 | 	<div class="description">
15 | 		<p class="description_text">{{ item.description }}</p>
16 | 		<ul>
17 | 			{% for link in item.description_links %}
18 | 				<li>
19 | 					<a class="description_link" href="{{ link }}"></a>
20 | 				</li>
21 | 			{% endfor %}
22 | 		</ul>
23 | 		{% for image in item.description_images %}
24 | 			<img class="description_image" src="{{ image.source }}" alt="{{ image.alt }}">
25 | 		{% endfor %}
26 | 	</div>
27 | </body>
28 | </html>


--------------------------------------------------------------------------------
/rss_reader/argument_parser/types.py:
--------------------------------------------------------------------------------
 1 | """Custom types for argparse"""
 2 | import argparse
 3 | from pathlib import Path
 4 | 
 5 | from pathvalidate import ValidationError, validate_filename
 6 | 
 7 | 
 8 | def directory(path: str) -> str:
 9 |     p = Path(path)
10 |     if not p.is_dir():
11 |         raise argparse.ArgumentTypeError(f"directory {str(p)} does not exist")
12 |     else:
13 |         return path
14 | 
15 | 
16 | def filename(name: str) -> str:
17 |     try:
18 |         validate_filename(name)
19 |     except ValidationError:
20 |         raise argparse.ArgumentTypeError(f"filename {name} is invalid")
21 |     return name
22 | 
23 | 
24 | def unsigned_int(number: str) -> int:
25 |     num = int(number)
26 |     if num < 0:
27 |         raise argparse.ArgumentTypeError("limit must be positive")
28 |     return num
29 | 
30 | 
31 | def output_enum(output: str) -> str:
32 |     enum = ("console", "colorized", "json", "none")
33 |     if output not in enum:
34 |         raise argparse.ArgumentTypeError(f"output not in {enum}")
35 |     return output
36 | 
37 | 
38 | def convert_enum(convert: str) -> str:
39 |     enum = ("json", "html", "pdf", "epub")
40 |     if convert not in enum:
41 |         raise argparse.ArgumentTypeError(f"convert not in {enum}")
42 |     return convert
43 | 


--------------------------------------------------------------------------------
/.pre-commit-config.yaml:
--------------------------------------------------------------------------------
 1 | repos:
 2 |   # Use pre-commit repo, v3.4.0
 3 |   - repo: https://github.com/pre-commit/pre-commit-hooks
 4 |     rev: "v3.4.0"
 5 |     hooks:
 6 |       # Check for files that contain merge conflict strings.
 7 |       - id: check-merge-conflict
 8 |         stages: [ commit, push ]
 9 |       # Simply check whether files parse as valid python.
10 |       - id: check-ast
11 |         stages: [ commit ]
12 | 
13 |     # Use locally installed hooks
14 |   - repo: local
15 | 
16 |     hooks:
17 |       - id: black
18 |         name: black
19 |         entry: poetry
20 |         args:
21 |           - run
22 |           - black
23 |         language: system
24 |         types: [ python ]
25 |         stages: [ commit ]
26 |         # Black should use the config from the pyproject.toml file
27 | 
28 |       - id: isort
29 |         name: isort
30 |         entry: poetry
31 |         args:
32 |           - run
33 |           - isort
34 |         language: system
35 |         types: [ python ]
36 |         stages: [ commit ]
37 |         # isort's config is also stored in pyproject.toml
38 | 
39 |       - id: flake8
40 |         name: flake8
41 |         entry: poetry
42 |         args:
43 |           - run
44 |           - flake8
45 |         language: system
46 |         always_run: true
47 |         pass_filenames: false
48 |         stages: [ push ]


--------------------------------------------------------------------------------
/rss_reader/converter/html_template.jinja2:
--------------------------------------------------------------------------------
 1 | {# Basic html template #}
 2 | <!DOCTYPE html>
 3 | <html lang="{{ rss.language }}">
 4 | <head>
 5 | 	<meta charset="UTF-8">
 6 | 	<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
 7 | 	<title>{{ rss.title }}</title>
 8 | 	<style>
 9 | 		header {
10 | 			padding: 2rem;
11 | 		}
12 | 
13 | 		.feed {
14 | 			padding: 1rem;
15 | 		}
16 | 
17 | 		.feed_item {
18 | 			padding-bottom: 1rem;
19 | 		}
20 | 
21 | 		.description_image {
22 | 			max-width: 240px;
23 | 		}
24 | 	</style>
25 | </head>
26 | <body>
27 | 	<header>
28 | 		<h1 class="rss_title">{{ rss.title }}</h1>
29 | 		<h2>{{ rss.description }}</h2>
30 | 	</header>
31 | 	<main>
32 | 		<section class="feed">
33 | 			{% for item in rss.feed %}
34 | 				<article class="feed_item">
35 | 					<h3 class="item_title">{{ item.title }}</h3>
36 | 					{% if item.publish_date %}
37 | 						<p class="publish_date">{{ item.publish_date }}</p>
38 | 					{% endif %}
39 | 					{% if item.category %}
40 | 						<p class="category">{{ item.category }}</p>
41 | 					{% endif %}
42 | 					{% if item.link %}
43 | 						<a href="{{ item.link }}">{{ item.link }}</a>
44 | 					{% endif %}
45 | 					<div class="description">
46 | 						<p class="description_text">{{ item.description }}</p>
47 | 						<ul>
48 | 							{% for link in item.description_links %}
49 | 								<li class="description_link">{{ link }}</li>
50 | 							{% endfor %}
51 | 						</ul>
52 | 						{% for image in item.description_images %}
53 | 							<img class="description_image" src="{{ image.source }}" alt="{{ image.alt }}">
54 | 						{% endfor %}
55 | 					</div>
56 | 				</article>
57 | 			{% endfor %}
58 | 		</section>
59 | 	</main>
60 | </body>
61 | </html>


--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
  1 | .vscode
  2 | #pipenv
  3 | Pipfile
  4 | Pipfile.lock
  5 | *.sh
  6 | 
  7 | #PyCharm
  8 | .idea
  9 | 
 10 | # Byte-compiled / optimized / DLL files
 11 | __pycache__/
 12 | *.py[cod]
 13 | *$py.class
 14 | 
 15 | # C extensions
 16 | *.so
 17 | 
 18 | # Distribution / packaging
 19 | .Python
 20 | build/
 21 | develop-eggs/
 22 | dist/
 23 | downloads/
 24 | eggs/
 25 | .eggs/
 26 | lib/
 27 | lib64/
 28 | parts/
 29 | sdist/
 30 | var/
 31 | wheels/
 32 | *.egg-info/
 33 | .installed.cfg
 34 | *.egg
 35 | MANIFEST
 36 | 
 37 | # PyInstaller
 38 | #  Usually these files are written by a python script from a template
 39 | #  before PyInstaller builds the exe, so as to inject date/other infos into it.
 40 | *.manifest
 41 | *.spec
 42 | 
 43 | # Installer logs
 44 | pip-log.txt
 45 | pip-delete-this-directory.txt
 46 | 
 47 | # Unit test / coverage reports
 48 | htmlcov/
 49 | .tox/
 50 | .coverage
 51 | .coverage.*
 52 | .cache
 53 | nosetests.xml
 54 | coverage.xml
 55 | *.cover
 56 | .hypothesis/
 57 | .pytest_cache/
 58 | 
 59 | # Translations
 60 | *.mo
 61 | *.pot
 62 | 
 63 | # Django stuff:
 64 | *.log
 65 | local_settings.py
 66 | db.sqlite3
 67 | 
 68 | # Flask stuff:
 69 | instance/
 70 | .webassets-cache
 71 | 
 72 | # Scrapy stuff:
 73 | .scrapy
 74 | 
 75 | # Sphinx documentation
 76 | docs/_build/
 77 | 
 78 | # PyBuilder
 79 | target/
 80 | 
 81 | # Jupyter Notebook
 82 | .ipynb_checkpoints
 83 | 
 84 | # pyenv
 85 | .python-version
 86 | 
 87 | # celery beat schedule file
 88 | celerybeat-schedule
 89 | 
 90 | # SageMath parsed files
 91 | *.sage.py
 92 | 
 93 | # Environments
 94 | .env
 95 | .venv
 96 | env/
 97 | venv/
 98 | ENV/
 99 | env.bak/
100 | venv.bak/
101 | 
102 | # Spyder project settings
103 | .spyderproject
104 | .spyproject
105 | 
106 | # Rope project settings
107 | .ropeproject
108 | 
109 | # mkdocs documentation
110 | /site
111 | 
112 | # mypy
113 | .mypy_cache/
114 | 
115 | .rss-reader
116 | poetry.lock
117 | 


--------------------------------------------------------------------------------
/pyproject.toml:
--------------------------------------------------------------------------------
 1 | [tool.poetry]
 2 | name = "rss-reader"
 3 | version = "3.5.1"
 4 | description = "A simple CLI rss reader"
 5 | authors = ["dhvcc <1337kwiz@gmail.com>"]
 6 | license = "GPLv3"
 7 | readme = "README.md"
 8 | keywords = [
 9 |     "python",
10 |     "python3",
11 |     "cli",
12 |     "rss",
13 |     "reader",
14 |     "gplv3",
15 |     "typed",
16 |     "typed-python",
17 | ]
18 | classifiers = [
19 |     "Natural Language :: English",
20 |     "Intended Audience :: Developers",
21 |     "Intended Audience :: End Users/Desktop",
22 |     "License :: OSI Approved :: MIT License",
23 |     "Development Status :: 5 - Production/Stable",
24 |     "Typing :: Typed",
25 |     "Operating System :: OS Independent",
26 |     "Programming Language :: Python :: 3.7",
27 |     "Programming Language :: Python :: 3.8",
28 | ]
29 | 
30 | [tool.poetry.scripts]
31 | rss-reader = "rss_reader.__main__:main"
32 | 
33 | [tool.poetry.urls]
34 | "Homepage" = "https://dhvcc.github.io/rss-reader"
35 | "Source" = "https://github.com/dhvcc/rss-reader"
36 | "Bug Tracker" = "https://github.com/dhvcc/rss-reader/issues"
37 | 
38 | [tool.poetry.dependencies]
39 | python = "^3.7"
40 | rss-parser = "^0.2.3"
41 | pathvalidate = "^2.4.1"
42 | requests = "*"
43 | pydantic = "*"
44 | weasyprint = "^51"
45 | colorama = "^0.4.3"
46 | Jinja2 = "*"
47 | ebooklib = "^0.17.1"
48 | 
49 | [tool.poetry.extras]
50 | speedups = ["ujson"]
51 | 
52 | [tool.poetry.dev-dependencies]
53 | black = "^20.8b1"
54 | pre-commit = "^2.12.0"
55 | flake8 = "^3.9.0"
56 | isort = "^5.8.0"
57 | 
58 | [build-system]
59 | requires = ["poetry-core>=1.0.0"]
60 | build-backend = "poetry.core.masonry.api"
61 | 
62 | [tool.black]
63 | line-length = 88
64 | target-version = ['py37', 'py38']
65 | exclude = '''
66 | (
67 |     \.eggs
68 |   | \.git
69 |   | build
70 |   | dist
71 |   | venv
72 |   | .venv
73 | )
74 | '''
75 | 
76 | [tool.isort]
77 | multi_line_output = 3
78 | include_trailing_comma = true
79 | force_grid_wrap = 0
80 | use_parentheses = true
81 | ensure_newline_before_comments = true
82 | line_length = 88
83 | skip_gitignore = true
84 | skip_glob = ['**/.venv/**']
85 | 


--------------------------------------------------------------------------------
/rss_reader/argument_parser/_parser.py:
--------------------------------------------------------------------------------
 1 | import argparse
 2 | 
 3 | from rss_reader.config import OUTPUT_DIR
 4 | 
 5 | from .types import directory, filename, unsigned_int
 6 | 
 7 | 
 8 | class ArgParser:
 9 |     def __init__(self):
10 |         self.parser = argparse.ArgumentParser(
11 |             description="Pure Python command-line RSS reader.", add_help=True
12 |         )
13 |         self.parser.add_argument(
14 |             "source", help="RSS source URL or a file path", type=str
15 |         )
16 |         self.parser.add_argument(
17 |             "--version",
18 |             help="print version info",
19 |             action="version",
20 |             version="rss-reader 3.5",
21 |         )
22 |         self.parser.add_argument(
23 |             "--verbose", help="output verbose status messages", action="store_true"
24 |         )
25 |         self.parser.add_argument(
26 |             "-o",
27 |             "--output",
28 |             help="console output type",
29 |             choices=["console", "colorized", "json", "none"],
30 |             type=str,
31 |         )
32 |         self.parser.add_argument(
33 |             "-c",
34 |             "--convert",
35 |             help="convert feed and save as a file",
36 |             choices=["json", "html", "pdf", "epub"],
37 |             type=str,
38 |         )
39 |         self.parser.add_argument(
40 |             "--convert-dir",
41 |             help=f"convert output dir path instead of {OUTPUT_DIR}",
42 |             type=directory,
43 |         )
44 |         self.parser.add_argument(
45 |             "--convert-file", help="convert output filename", type=filename
46 |         )
47 |         self.parser.add_argument(
48 |             "-l",
49 |             "--limit",
50 |             help="limit news topics if this parameter is provided",
51 |             type=unsigned_int,
52 |         )
53 |         self.parser.add_argument(
54 |             "--pretty", help="prettify html and pdf", action="store_true"
55 |         )
56 | 
57 |     def print_help(self):
58 |         """Shortcut for parser.print_help"""
59 |         self.parser.print_help()
60 | 
61 |     def get_args(self) -> argparse.Namespace:
62 |         return self.parser.parse_args()
63 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | # Rss reader
 2 | 
 3 | [![Downloads](https://pepy.tech/badge/rss-reader)](https://pepy.tech/project/rss-reader)
 4 | [![Downloads](https://pepy.tech/badge/rss-reader/month)](https://pepy.tech/project/rss-reader/month)
 5 | [![Downloads](https://pepy.tech/badge/rss-reader/week)](https://pepy.tech/project/rss-reader/week)
 6 | 
 7 | [![PyPI version](https://img.shields.io/pypi/v/rss-reader)](https://pypi.org/project/rss-reader)
 8 | [![Python versions](https://img.shields.io/pypi/pyversions/rss-reader)](https://pypi.org/project/rss-reader)
 9 | [![Wheel status](https://img.shields.io/pypi/wheel/rss-reader)](https://pypi.org/project/rss-reader)
10 | [![License](https://img.shields.io/pypi/l/rss-reader?color=success)](https://github.com/dhvcc/rss-reader/blob/master/LICENSE)
11 | [![GitHub Pages](https://badgen.net/github/status/dhvcc/rss-reader/gh-pages?label=docs)](https://dhvcc.github.io/rss-reader#documentation)
12 | 
13 | [![Code checks](https://github.com/dhvcc/rss-reader/workflows/Code%20checks/badge.svg)](https://github.com/dhvcc/rss-reader/actions?query=workflow%3A%22Code+checks%22)
14 | [![Pypi publish](https://github.com/dhvcc/rss-reader/workflows/Pypi%20publish/badge.svg)](https://github.com/dhvcc/rss-reader/actions?query=workflow%3A%22Pypi+publish%22)
15 | 
16 | ## What is this?
17 | 
18 | `rss-reader` is a command line utility that allows you to view RSS feeds
19 | 
20 | You can also convert RSS feeds to `html`/`pdf`/`epub` for more convenient reading
21 | 
22 | Command-line arguments, local and global INI configs, environment variables **are supported**
23 | 
24 | ## What is RSS?
25 | 
26 | RSS stands for “Really Simple Syndication,”
27 | or, depending on who you ask, “Rich Site Summary.” At it's heart, RSS is
28 | just simple text files with basic updated information—news pieces,
29 | articles, that sort of thing. That stripped-down content is usually
30 | plugged into what is called a “feed reader” or an interface that quickly
31 | converts the RSS text files into a stream of the latest updates from
32 | around the web.
33 | 
34 | ## Contributing
35 | 
36 | Pull requests are welcome. For major changes, please open an issue first
37 | to discuss what you would like to change.
38 | 
39 | Install dependencies with `poetry install` (`pip install poetry`)
40 | 
41 | `pre-commit` usage is highly recommended. To install hooks run
42 | 
43 | ```bash
44 | poetry run pre-commit install -t=pre-commit -t=pre-push
45 | ```
46 | 
47 | ## License
48 | 
49 | [GPLv3](https://github.com/dhvcc/rss-reader/blob/master/LICENSE)
50 | 


--------------------------------------------------------------------------------
/rss_reader/converter/pretty_html_template.jinja2:
--------------------------------------------------------------------------------
 1 | {# Pretty html template with bootstrap #}
 2 | <!DOCTYPE html>
 3 | <html lang="{{ rss.language }}">
 4 | <head>
 5 | 	<meta charset="UTF-8">
 6 | 	<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
 7 | 	<title>{{ rss.title }}</title>
 8 | 	<link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.5.2/css/bootstrap.min.css"
 9 | 		  integrity="sha384-JcKb8q3iqJ61gNV9KGb8thSsNjpSL0n8PARn9HuZOnIxN0hoP+VmmDGMN5t9UJ0Z" crossorigin="anonymous">
10 | </head>
11 | <body>
12 | 	<div class="container-fluid px-5">
13 | 		<header class="mt-2">
14 | 			<div class="jumbotron text-center" style="background-color: transparent">
15 | 				<h1 class="rss_title">{{ rss.title }}</h1>
16 | 				<h2>{{ rss.description }}</h2>
17 | 			</div>
18 | 
19 | 		</header>
20 | 		<main>
21 | 			<section class="feed">
22 | 				<ol>
23 | 					{% for item in rss.feed %}
24 | 						<li>
25 | 							<article class="feed_item">
26 | 								{% if item.link %}
27 | 									<a href="{{ item.link }}" class="item_title text-decoration-none"
28 | 									   target="_blank"
29 | 									   style="font-size: 1.25rem">
30 | 										{{ item.title }}
31 | 									</a>
32 | 								{% else %}
33 | 									<h5 class="item_title">{{ item.title }}</h5>
34 | 								{% endif %}
35 | 								{% if item.publish_date %}
36 | 									<p class="publish_date text-monospace mb-1">{{ item.publish_date }}</p>
37 | 								{% endif %}
38 | 								{% if item.category %}
39 | 									<p class="category font-italic mb-1">{{ item.category }}</p>
40 | 								{% endif %}
41 | 								<div class="description p-3">
42 | 									<p class="description_text">{{ item.description }}</p>
43 | 									<ul>
44 | 										{% for link in item.description_links %}
45 | 											<li class="description_link">{{ link }}</li>
46 | 										{% endfor %}
47 | 									</ul>
48 | 									{% for image in item.description_images %}
49 | 										<img class="img-thumbnail description_image" src="{{ image.source }}"
50 | 											 alt="{{ image.alt }}">
51 | 									{% endfor %}
52 | 								</div>
53 | 							</article>
54 | 						</li>
55 | 						<hr>
56 | 					{% endfor %}
57 | 				</ol>
58 | 			</section>
59 | 		</main>
60 | 	</div>
61 | 	<script src="https://code.jquery.com/jquery-3.5.1.slim.min.js"
62 | 			integrity="sha384-DfXdz2htPH0lsSSs5nCTpuj/zy4C+OGpamoFVy38MVBnE+IbbVYUew+OrCXaRkfj"
63 | 			crossorigin="anonymous"></script>
64 | 	<script src="https://cdn.jsdelivr.net/npm/popper.js@1.16.1/dist/umd/popper.min.js"
65 | 			integrity="sha384-9/reFTGAW83EW2RDu2S0VKaIzap3H66lZH81PoYlFhbGU+6BZp6G7niu735Sk7lN"
66 | 			crossorigin="anonymous"></script>
67 | 	<script src="https://stackpath.bootstrapcdn.com/bootstrap/4.5.2/js/bootstrap.min.js"
68 | 			integrity="sha384-B4gt1jrGC7Jh4AgTPSdUtOBvfO8shuf57BaghqFfPlYxofvL8/KUEfYiJOMMV+rV"
69 | 			crossorigin="anonymous"></script>
70 | </body>
71 | </html>


--------------------------------------------------------------------------------
/rss_reader/reader/_reader.py:
--------------------------------------------------------------------------------
 1 | import logging
 2 | from pathlib import Path
 3 | 
 4 | from requests import exceptions, get
 5 | from rss_parser import Parser
 6 | from rss_parser.models import RSSFeed
 7 | 
 8 | from rss_reader.config import MODULE_DIR, data_config
 9 | from rss_reader.converter import Converter
10 | from rss_reader.printer import Printer
11 | 
12 | logger = logging.getLogger("rss-reader")
13 | 
14 | 
15 | class Reader:
16 |     def __init__(self):
17 |         self.config = data_config
18 | 
19 |         self.source = self.config.source
20 | 
21 |         self.rss_response = None
22 |         self.rss = None
23 |         self.rss_raw: dict = {}
24 | 
25 |     def get_parser(self):
26 |         source_path = Path(self.source)
27 |         if source_path.is_file():
28 |             logger.info("Source is a file")
29 |             try:
30 |                 with open(self.source) as file:
31 |                     return Parser(file.read(), self.config.limit)
32 |             except Exception as e:
33 |                 logger.warning("Source is invalid")
34 |                 logger.exception(e)
35 |                 raise e
36 |         else:
37 |             logger.info("Source is not a file, should be a link")
38 |             try:
39 |                 self.rss_response = get(self.source)
40 |                 return Parser(self.rss_response.content, self.config.limit)
41 |             except exceptions.RequestException as e:
42 |                 logger.warning("Source is invalid")
43 |                 logger.exception(e)
44 |                 raise e
45 | 
46 |     def enable_verbose(self):
47 |         formatter = logging.Formatter(
48 |             "[%(levelname)s] %(asctime)s (%(funcName)s) = %(message)s"
49 |         )
50 | 
51 |         logger_ = logging.getLogger("rss-reader")
52 |         logger_.setLevel("DEBUG")
53 |         s_handler = logging.StreamHandler()
54 |         s_handler.setFormatter(formatter)
55 | 
56 |         logger_.addHandler(s_handler)
57 | 
58 |         logger_.info("Enabled verbose mode")
59 |         logger.debug(self.config)
60 |         logger.debug(f"Module dir {MODULE_DIR}")
61 | 
62 |     def start(self):
63 |         """Setup and print"""
64 |         if self.config.verbose:
65 |             self.enable_verbose()
66 |         else:
67 |             logger.addHandler(logging.NullHandler())
68 |             logger.propagate = False
69 | 
70 |         parser = self.get_parser()
71 |         self.rss: RSSFeed = parser.parse()
72 |         self.rss_raw = parser.raw_data
73 | 
74 |         self.print()
75 | 
76 |     def print(self):
77 |         """
78 |         Call print and convert
79 |         getattr returns (attribute) method depending on arg value
80 |         """
81 |         printer = Printer(self.rss, self.rss_raw)
82 |         logger.info(f"Calling printer.{self.config.output}()")
83 |         getattr(printer, self.config.output)()
84 | 
85 |         converter = Converter(
86 |             self.rss, self.config.convert_dir, self.config.convert_file, self.rss_raw
87 |         )
88 |         logger.info(f"Calling converter.{self.config.convert}()")
89 |         getattr(converter, self.config.convert)()
90 | 


--------------------------------------------------------------------------------
/rss_reader/printer/_printer.py:
--------------------------------------------------------------------------------
 1 | """For info read __init__.py docstring"""
 2 | from colorama import Back, Fore, Style
 3 | from rss_parser.models import RSSFeed
 4 | 
 5 | from rss_reader.imports import json
 6 | 
 7 | 
 8 | class Printer:
 9 |     def __init__(self, rss: RSSFeed, rss_raw: dict = None):
10 |         self.rss = rss
11 |         self.rss_raw = rss_raw
12 | 
13 |     def none(self):
14 |         """Empty method which is called if output argument is 'none'"""
15 |         pass
16 | 
17 |     def console(self):
18 |         print(
19 |             f"\nFeed (RSS{self.rss.version or ''} {self.rss.language or ''}): {self.rss.title}"
20 |         )
21 |         print(self.rss.description)
22 |         for item in self.rss.feed:
23 |             print(f"\n\nTitle: {item.title}")
24 |             if item.publish_date:
25 |                 print(f"Publication date: {item.publish_date}")
26 |             if item.category:
27 |                 print(f"Category: {item.category}")
28 |             if item.link:
29 |                 print(f"Link: {item.link}")
30 |             print(f"\n{item.description}\n")
31 |             if item.description_images:
32 |                 print("Description images:")
33 |                 for num, image in enumerate(item.description_images, 1):
34 |                     print(f"[{num}][{image.alt}]: {image.source}")
35 |             if item.description_links:
36 |                 print("Description links:")
37 |                 for num, link in enumerate(item.description_links, 1):
38 |                     print(f"[{num}]: {link}")
39 | 
40 |     def colorized(self):
41 |         # TODO: Wrap printer in a module and add colors.py that contains color scheme tuples
42 |         print()
43 |         print(Style.NORMAL, Back.WHITE, Fore.BLACK, end="\b\b")
44 |         print(
45 |             f"Feed (RSS{self.rss.version or ''} {self.rss.language or ''}): {self.rss.title}",
46 |             Style.RESET_ALL,
47 |         )
48 |         print(Style.NORMAL, Back.WHITE, Fore.BLACK, end="\b\b")
49 |         print(self.rss.description, Style.RESET_ALL)
50 |         for item in self.rss.feed:
51 |             print(2 * "\n")
52 |             print(Style.NORMAL, Back.WHITE, Fore.BLACK, end="\b\b")
53 |             print(f"Title: {item.title}", Style.RESET_ALL)
54 | 
55 |             if item.publish_date:
56 |                 print(Style.BRIGHT, Fore.WHITE, end="\b")
57 |                 print(f"Publication date: {item.publish_date}", Style.RESET_ALL)
58 |             if item.category:
59 |                 print(Style.BRIGHT, Fore.WHITE, end="\b")
60 |                 print(f"Category: {item.category}", Style.RESET_ALL)
61 |             if item.link:
62 |                 print(Style.BRIGHT, Fore.WHITE, end="\b")
63 |                 print(f"Link: {item.link}", Style.RESET_ALL)
64 | 
65 |             print(Style.BRIGHT, Fore.YELLOW)
66 |             print(f"{item.description}\n", Style.RESET_ALL)
67 | 
68 |             if item.description_images:
69 |                 print(Style.BRIGHT, Fore.WHITE, end="\b")
70 |                 print("Description images:")
71 |                 for num, image in enumerate(item.description_images, 1):
72 |                     print(f"[{num}][{image.alt}]: {image.source}")
73 |             if item.description_links:
74 |                 print("Description links:")
75 |                 for num, link in enumerate(item.description_links, 1):
76 |                     print(f"[{num}]: {link}")
77 |             print(Style.RESET_ALL, end="")
78 | 
79 |     def json(self):
80 |         if self.rss_raw:
81 |             print(json.dumps(self.rss_raw, indent=4))
82 |         else:
83 |             # If raw dict rss was not provided then create dict and dump it
84 |             # dumps indent does not work on str
85 |             loaded: dict = json.loads(self.rss.json())
86 |             print(json.dumps(loaded, indent=4))
87 | 


--------------------------------------------------------------------------------
/rss_reader/converter/_converter.py:
--------------------------------------------------------------------------------
  1 | """For info read __init__.py docstring"""
  2 | import logging
  3 | from os.path import join
  4 | from pathlib import Path
  5 | from typing import Union
  6 | 
  7 | import weasyprint
  8 | from ebooklib import epub
  9 | from jinja2 import Template
 10 | from rss_parser.models import FeedItem, RSSFeed
 11 | 
 12 | from rss_reader.imports import json
 13 | 
 14 | logger = logging.getLogger("rss-reader")
 15 | 
 16 | 
 17 | class Converter:
 18 |     def __init__(
 19 |         self,
 20 |         rss: RSSFeed,
 21 |         convert_dir: str,
 22 |         convert_file: str,
 23 |         pretty: Union[None, bool],
 24 |         rss_raw: dict = None,
 25 |     ):
 26 |         self.rss = rss
 27 |         self.rss_raw = rss_raw
 28 |         self.convert_dir = convert_dir
 29 |         self.convert_file = convert_file
 30 | 
 31 |         self.pretty: str = "pretty_" if pretty else ""
 32 |         self.module_dir = Path(__file__).parent
 33 | 
 34 |     def none(self):
 35 |         """Empty method which is called if convert argument is 'none'"""
 36 |         pass
 37 | 
 38 |     def json(self):
 39 |         file_path = join(self.convert_dir, self.convert_file or "rss_feed.json")
 40 |         with open(file_path, "w") as file:
 41 |             if self.rss_raw:
 42 |                 file.write(json.dumps(self.rss_raw, indent=4))
 43 |             else:
 44 |                 # If raw dict rss was not provided then create dict and dump it
 45 |                 # dumps indent does not work on str
 46 |                 loaded: dict = json.loads(self.rss.json())
 47 |                 file.write(json.dumps(loaded, indent=4))
 48 | 
 49 |         logger.info(f"Saved json in {file_path}")
 50 | 
 51 |     def get_html(self, **kwargs):
 52 |         template = Template(
 53 |             open(join(self.module_dir, f"{self.pretty}html_template.jinja2")).read()
 54 |         )
 55 |         return template.render(**kwargs)
 56 | 
 57 |     def html(self):
 58 |         file_path = join(self.convert_dir, self.convert_file or "rss_feed.html")
 59 |         with open(file_path, "w") as file:
 60 |             file.write(self.get_html(rss=self.rss))
 61 | 
 62 |         logger.info(f"Saved html in {file_path}")
 63 | 
 64 |     def pdf(self):
 65 |         file_path = join(self.convert_dir, self.convert_file or "rss_feed.pdf")
 66 |         output_html = self.get_html(rss=self.rss)
 67 |         weasyprinted_html = weasyprint.HTML(string=output_html)
 68 |         weasyprinted_html.write_pdf(file_path)
 69 | 
 70 |         logger.info(f"Saved pdf in {file_path}")
 71 | 
 72 |     def get_xhtml(self, feed_item: FeedItem, language: str = "") -> str:
 73 |         template = Template(open(join(self.module_dir, "xhtml_template.jinja2")).read())
 74 |         return template.render(item=feed_item, language=language)
 75 | 
 76 |     def epub(self):
 77 |         file_path = join(self.convert_dir, self.convert_file or "rss_feed.epub")
 78 |         book = epub.EpubBook()
 79 |         book.set_identifier("id")
 80 |         book.set_title(self.rss.title)
 81 |         book.set_language(self.rss.language)
 82 |         book.add_author(self.rss.title)
 83 | 
 84 |         toc = []
 85 |         spine = ["nav"]
 86 | 
 87 |         for num, item in enumerate(self.rss.feed, 1):
 88 |             chapter = epub.EpubHtml(title=item.title, file_name=f"{num}.xhtml")
 89 |             chapter.content = self.get_xhtml(item, self.rss.language)
 90 | 
 91 |             book.add_item(chapter)
 92 |             spine.append(chapter)
 93 |             toc.append(epub.Section(item.title))
 94 |             toc.append(chapter)
 95 | 
 96 |         book.toc = tuple(toc)
 97 |         book.spine = spine
 98 | 
 99 |         book.add_item(epub.EpubNcx())
100 |         book.add_item(epub.EpubNav())
101 | 
102 |         epub.write_epub(file_path, book)
103 | 
104 |         logger.info(f"Saved epub in {file_path}")
105 | 


--------------------------------------------------------------------------------
/rss_reader/config/_data.py:
--------------------------------------------------------------------------------
  1 | """Data config module which parses cli args, ini configs and env"""
  2 | from configparser import ConfigParser
  3 | from os import environ
  4 | from os.path import join
  5 | from pathlib import Path
  6 | from typing import Union
  7 | 
  8 | from rss_reader.argument_parser import ArgParser, ArgsModel, types
  9 | 
 10 | from ._base import OUTPUT_DIR
 11 | 
 12 | 
 13 | class DataConfig:
 14 |     def __init__(self):
 15 |         self.source: Union[None, str] = None
 16 |         self.verbose: Union[None, bool] = None
 17 |         self.output: Union[None, str] = None
 18 |         self.convert: Union[None, str] = None
 19 |         self.convert_dir: Union[None, str] = None
 20 |         self.convert_file: Union[None, str] = None
 21 |         self.limit: Union[None, int] = None
 22 |         self.pretty: Union[None, bool] = None
 23 | 
 24 |     def load(
 25 |         self,
 26 |         arguments_: ArgsModel,
 27 |         local_config_: ConfigParser,
 28 |         global_config_: ConfigParser,
 29 |         environment_,
 30 |     ):
 31 |         self.load_cli(arguments_)
 32 |         self.load_ini(local_config_)
 33 |         self.load_environ(environment_)
 34 |         self.load_ini(global_config_)
 35 | 
 36 |         self.set_defaults()
 37 | 
 38 |     def load_cli(self, arguments: ArgsModel):
 39 |         self.source = arguments.source
 40 |         self.verbose = arguments.verbose
 41 |         self.output = arguments.output
 42 |         self.convert = arguments.convert
 43 |         self.convert_dir = arguments.convert_dir
 44 |         self.convert_file = arguments.convert_file
 45 |         self.limit = arguments.limit
 46 |         self.pretty = arguments.pretty
 47 | 
 48 |     def load_ini(self, config: ConfigParser):
 49 |         if "rss-reader" not in config.sections():
 50 |             return
 51 | 
 52 |         if not self.output and config["rss-reader"].get("OUTPUT"):
 53 |             self.output = types.output_enum(config["rss-reader"]["OUTPUT"])
 54 | 
 55 |         if not self.convert and config["rss-reader"].get("CONVERT"):
 56 |             self.convert = types.convert_enum(config["rss-reader"]["CONVERT"])
 57 | 
 58 |         if not self.convert_dir and config["rss-reader"].get("CONVERT_DIR"):
 59 |             self.convert_dir = types.directory(config["rss-reader"]["CONVERT_DIR"])
 60 | 
 61 |         if not self.convert_file and config["rss-reader"].get("CONVERT_FILE"):
 62 |             self.convert_file = types.filename(config["rss-reader"]["CONVERT_FILE"])
 63 | 
 64 |     def load_environ(self, environment):
 65 |         if self.output is None:
 66 |             self.output = environment.get("RSS_READER_OUTPUT")
 67 | 
 68 |         if self.convert is None:
 69 |             self.convert = environment.get("RSS_READER_CONVERT")
 70 | 
 71 |         if self.convert_dir is None:
 72 |             self.convert_dir = environment.get("RSS_READER_CONVERT_DIR")
 73 | 
 74 |         if self.convert_file is None:
 75 |             self.convert_file = environment.get("RSS_READER_CONVERT_FILE")
 76 | 
 77 |     def set_defaults(self):
 78 |         if self.convert_dir is None:
 79 |             self.convert_dir = OUTPUT_DIR
 80 |         if self.output is None:
 81 |             self.output = "console"
 82 |         if self.convert is None:
 83 |             self.convert = "none"
 84 |         if self.pretty is None:
 85 |             self.pretty = False
 86 | 
 87 |     def __repr__(self):
 88 |         return (
 89 |             f"<{self.__class__.__name__}"
 90 |             f"({', '.join([f'{k}={v}' for k, v in self.__dict__.items() if not k.startswith('_')])})>"
 91 |         )
 92 | 
 93 | 
 94 | # cli
 95 | arg_parser = ArgParser()
 96 | # local ini
 97 | local_config = ConfigParser()
 98 | local_config.read(".rss-reader")
 99 | # global ini
100 | global_config = ConfigParser()
101 | global_config.read(join(str(Path.home()), ".rss-reader"))
102 | 
103 | data_config = DataConfig()
104 | data_config.load(
105 |     arguments_=arg_parser.get_args(),
106 |     local_config_=local_config,
107 |     environment_=environ,
108 |     global_config_=global_config,
109 | )
110 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
  1 |                       GNU GENERAL PUBLIC LICENSE
  2 |                        Version 3, 29 June 2007
  3 | 
  4 |  Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
  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 |     <one line to give the program's name and a brief idea of what it does.>
635 |     Copyright (C) <year>  <name of author>
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 <https://www.gnu.org/licenses/>.
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 |     <program>  Copyright (C) <year>  <name of author>
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 | <https://www.gnu.org/licenses/>.
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 | <https://www.gnu.org/licenses/why-not-lgpl.html>.
675 | 


--------------------------------------------------------------------------------