diff --git a/.gitignore b/.gitignore
deleted file mode 100644
index a1c3e77..0000000
--- a/.gitignore
+++ /dev/null
@@ -1,146 +0,0 @@
-# Byte-compiled / optimized / DLL files
-__pycache__/
-*.py[cod]
-*$py.class
-
-# C extensions
-*.so
-
-# Distribution / packaging
-.Python
-build/
-develop-eggs/
-dist/
-downloads/
-eggs/
-.eggs/
-lib/
-lib64/
-parts/
-sdist/
-var/
-wheels/
-pip-wheel-metadata/
-share/python-wheels/
-*.egg-info/
-.installed.cfg
-*.egg
-MANIFEST
-
-# PyInstaller
-# Usually these files are written by a python script from a template
-# before PyInstaller builds the exe, so as to inject date/other infos into it.
-*.manifest
-*.spec
-
-# Installer logs
-pip-log.txt
-pip-delete-this-directory.txt
-
-# Unit test / coverage reports
-htmlcov/
-.tox/
-.nox/
-.coverage
-.coverage.*
-.cache
-nosetests.xml
-coverage.xml
-*.cover
-*.py,cover
-.hypothesis/
-.pytest_cache/
-
-# Translations
-*.mo
-*.pot
-
-# Django stuff:
-*.log
-local_settings.py
-db.sqlite3
-db.sqlite3-journal
-
-# Flask stuff:
-instance/
-.webassets-cache
-
-# Scrapy stuff:
-.scrapy
-
-# Sphinx documentation
-docs/_build/
-
-# PyBuilder
-target/
-
-# Jupyter Notebook
-.ipynb_checkpoints
-
-# IPython
-profile_default/
-ipython_config.py
-
-# pyenv
-.python-version
-
-# pipenv
-# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
-# However, in case of collaboration, if having platform-specific dependencies or dependencies
-# having no cross-platform support, pipenv may install dependencies that don't work, or not
-# install all needed dependencies.
-#Pipfile.lock
-
-# PEP 582; used by e.g. github.com/David-OConnor/pyflow
-__pypackages__/
-
-# Celery stuff
-celerybeat-schedule
-celerybeat.pid
-
-# SageMath parsed files
-*.sage.py
-
-# Environments
-.env
-.venv
-env/
-venv/
-ENV/
-env.bak/
-venv.bak/
-
-# Spyder project settings
-.spyderproject
-.spyproject
-
-# Rope project settings
-.ropeproject
-
-# mkdocs documentation
-/site
-
-# mypy
-.mypy_cache/
-.dmypy.json
-dmypy.json
-
-# Pyre type checker
-.pyre/
-
-# Exclude all Markdown, reStructuredText and JSON files.
-*.md
-*.rst
-*.json
-
-# Exclude Cookie data
-*.cookies
-
-# Except for README files
-!README.md
-!README.rst
-
-# Files related to tests
-test.output.*
-test.failures.log
-*.tests
diff --git a/.pylintrc b/.pylintrc
deleted file mode 100644
index c88a7fa..0000000
--- a/.pylintrc
+++ /dev/null
@@ -1,433 +0,0 @@
-[MASTER]
-
-# A comma-separated list of package or module names from where C extensions may
-# be loaded. Extensions are loading into the active Python interpreter and may
-# run arbitrary code
-extension-pkg-whitelist=
-
-# Add files or directories to the blacklist. They should be base names, not
-# paths.
-ignore=CVS
-
-# Add files or directories matching the regex patterns to the blacklist. The
-# regex matches against base names, not paths.
-ignore-patterns=
-
-# Python code to execute, usually for sys.path manipulation such as
-# pygtk.require().
-#init-hook=
-
-# Use multiple processes to speed up Pylint.
-# jobs=1
-jobs=2
-
-# List of plugins (as comma separated values of python modules names) to load,
-# usually to register additional checkers.
-load-plugins=
-
-# Pickle collected data for later comparisons.
-persistent=yes
-
-# Specify a configuration file.
-#rcfile=
-
-# Allow loading of arbitrary C extensions. Extensions are imported into the
-# active Python interpreter and may run arbitrary code.
-unsafe-load-any-extension=no
-
-
-[MESSAGES CONTROL]
-
-# Only show warnings with the listed confidence levels. Leave empty to show
-# all. Valid levels: HIGH, INFERENCE, INFERENCE_FAILURE, UNDEFINED
-confidence=
-
-# Disable the message, report, category or checker with the given id(s). You
-# can either give multiple identifiers separated by comma (,) or put this
-# option multiple times (only on the command line, not in the configuration
-# file where it should appear only once).You can also use "--disable=all" to
-# disable everything first and then reenable specific checks. For example, if
-# you want to run only the similarities checker, you can use "--disable=all
-# --enable=similarities". If you want to run only the classes checker, but have
-# no Warning level messages displayed, use"--disable=all --enable=classes
-# --disable=W"
-# disable=import-error,print-statement,parameter-unpacking,unpacking-in-except,old-raise-syntax,backtick,long-suffix,old-ne-operator,old-octal-literal,import-star-module-level,raw-checker-failed,bad-inline-option,locally-disabled,locally-enabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,apply-builtin,basestring-builtin,buffer-builtin,cmp-builtin,coerce-builtin,execfile-builtin,file-builtin,long-builtin,raw_input-builtin,reduce-builtin,standarderror-builtin,unicode-builtin,xrange-builtin,coerce-method,delslice-method,getslice-method,setslice-method,no-absolute-import,old-division,dict-iter-method,dict-view-method,next-method-called,metaclass-assignment,indexing-exception,raising-string,reload-builtin,oct-method,hex-method,nonzero-method,cmp-method,input-builtin,round-builtin,intern-builtin,unichr-builtin,map-builtin-not-iterating,zip-builtin-not-iterating,range-builtin-not-iterating,filter-builtin-not-iterating,using-cmp-argument,eq-without-hash,div-method,idiv-method,rdiv-method,exception-message-attribute,invalid-str-codec,sys-max-int,bad-python3-import,deprecated-string-function,deprecated-str-translate-call
-disable=too-many-instance-attributes,len-as-condition,too-few-public-methods,anomalous-backslash-in-string,no-else-return,simplifiable-if-statement,too-many-arguments,duplicate-code,no-name-in-module,no-member,print-statement,parameter-unpacking,unpacking-in-except,old-raise-syntax,backtick,long-suffix,old-ne-operator,old-octal-literal,import-star-module-level,raw-checker-failed,bad-inline-option,locally-disabled,locally-enabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,apply-builtin,basestring-builtin,buffer-builtin,cmp-builtin,coerce-builtin,execfile-builtin,file-builtin,long-builtin,raw_input-builtin,reduce-builtin,standarderror-builtin,unicode-builtin,xrange-builtin,coerce-method,delslice-method,getslice-method,setslice-method,no-absolute-import,old-division,dict-iter-method,dict-view-method,next-method-called,metaclass-assignment,indexing-exception,raising-string,reload-builtin,oct-method,hex-method,nonzero-method,cmp-method,input-builtin,round-builtin,intern-builtin,unichr-builtin,map-builtin-not-iterating,zip-builtin-not-iterating,range-builtin-not-iterating,filter-builtin-not-iterating,using-cmp-argument,eq-without-hash,div-method,idiv-method,rdiv-method,exception-message-attribute,invalid-str-codec,sys-max-int,bad-python3-import,deprecated-string-function,deprecated-str-translate-call,import-error,missing-docstring,invalid-name,bad-whitespace,consider-using-enumerate,unexpected-keyword-arg
-
-# Enable the message, report, category or checker with the given id(s). You can
-# either give multiple identifier separated by comma (,) or put this option
-# multiple time (only on the command line, not in the configuration file where
-# it should appear only once). See also the "--disable" option for examples.
-enable=
-
-
-[REPORTS]
-
-# Python expression which should return a note less than 10 (10 is the highest
-# note). You have access to the variables errors warning, statement which
-# respectively contain the number of errors / warnings messages and the total
-# number of statements analyzed. This is used by the global evaluation report
-# (RP0004).
-evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10)
-
-# Template used to display messages. This is a python new-style format string
-# used to format the message information. See doc for all details
-msg-template='{path} {line}: {msg} ({symbol})'
-
-# Set the output format. Available formats are text, parseable, colorized, json
-# and msvs (visual studio).You can also give a reporter class, eg
-# mypackage.mymodule.MyReporterClass.
-output-format=text
-
-# Tells whether to display a full report or only the messages
-reports=no
-
-# Activate the evaluation score.
-score=yes
-
-
-[REFACTORING]
-
-# Maximum number of nested blocks for function / method body
-max-nested-blocks=5
-
-
-[LOGGING]
-
-# Logging modules to check that the string format arguments are in logging
-# function parameter format
-logging-modules=logging
-
-
-[SPELLING]
-
-# Spelling dictionary name. Available dictionaries: none. To make it working
-# install python-enchant package.
-spelling-dict=
-
-# List of comma separated words that should not be checked.
-spelling-ignore-words=
-
-# A path to a file that contains private dictionary; one word per line.
-spelling-private-dict-file=
-
-# Tells whether to store unknown words to indicated private dictionary in
-# --spelling-private-dict-file option instead of raising a message.
-spelling-store-unknown-words=no
-
-
-[MISCELLANEOUS]
-
-# List of note tags to take in consideration, separated by a comma.
-# notes=FIXME,XXX,TODO
-notes=FIXME,XXX
-
-
-[TYPECHECK]
-
-# List of decorators that produce context managers, such as
-# contextlib.contextmanager. Add to this list to register other decorators that
-# produce valid context managers.
-contextmanager-decorators=contextlib.contextmanager
-
-# List of members which are set dynamically and missed by pylint inference
-# system, and so shouldn't trigger E1101 when accessed. Python regular
-# expressions are accepted.
-generated-members=
-
-# Tells whether missing members accessed in mixin class should be ignored. A
-# mixin class is detected if its name ends with "mixin" (case insensitive).
-ignore-mixin-members=yes
-
-# This flag controls whether pylint should warn about no-member and similar
-# checks whenever an opaque object is returned when inferring. The inference
-# can return multiple potential results while evaluating a Python object, but
-# some branches might not be evaluated, which results in partial inference. In
-# that case, it might be useful to still emit no-member and other checks for
-# the rest of the inferred objects.
-ignore-on-opaque-inference=yes
-
-# List of class names for which member attributes should not be checked (useful
-# for classes with dynamically set attributes). This supports the use of
-# qualified names.
-ignored-classes=optparse.Values,thread._local,_thread._local
-
-# List of module names for which member attributes should not be checked
-# (useful for modules/projects where namespaces are manipulated during runtime
-# and thus existing member attributes cannot be deduced by static analysis. It
-# supports qualified module names, as well as Unix pattern matching.
-ignored-modules=
-
-# Show a hint with possible names when a member name was not found. The aspect
-# of finding the hint is based on edit distance.
-missing-member-hint=yes
-
-# The minimum edit distance a name should have in order to be considered a
-# similar match for a missing member name.
-missing-member-hint-distance=1
-
-# The total number of similar names that should be taken in consideration when
-# showing a hint for a missing member.
-missing-member-max-choices=1
-
-
-[VARIABLES]
-
-# List of additional names supposed to be defined in builtins. Remember that
-# you should avoid to define new builtins when possible.
-additional-builtins=
-
-# Tells whether unused global variables should be treated as a violation.
-allow-global-unused-variables=yes
-
-# List of strings which can identify a callback function by name. A callback
-# name must start or end with one of those strings.
-callbacks=cb_,_cb
-
-# A regular expression matching the name of dummy variables (i.e. expectedly
-# not used).
-dummy-variables-rgx=_+$|(_[a-zA-Z0-9_]*[a-zA-Z0-9]+?$)|dummy|^ignored_|^unused_
-
-# Argument names that match this expression will be ignored. Default to name
-# with leading underscore
-ignored-argument-names=_.*|^ignored_|^unused_
-
-# Tells whether we should check for unused import in __init__ files.
-init-import=no
-
-# List of qualified module names which can have objects that can redefine
-# builtins.
-redefining-builtins-modules=six.moves,future.builtins
-
-
-[FORMAT]
-
-# Expected format of line ending, e.g. empty (any line ending), LF or CRLF.
-# expected-line-ending-format=
-expected-line-ending-format=LF
-
-# Regexp for a line that is allowed to be longer than the limit.
-ignore-long-lines=^\s*(# )??$
-
-# Number of spaces of indent required inside a hanging or continued line.
-indent-after-paren=4
-
-# String used as indentation unit. This is usually " " (4 spaces) or "\t" (1
-# tab).
-indent-string=' '
-
-# Maximum number of characters on a single line.
-max-line-length=100
-
-# Maximum number of lines in a module
-max-module-lines=1000
-
-# List of optional constructs for which whitespace checking is disabled. `dict-
-# separator` is used to allow tabulation in dicts, etc.: {1 : 1,\n222: 2}.
-# `trailing-comma` allows a space between comma and closing bracket: (a, ).
-# `empty-line` allows space-only lines.
-no-space-check=trailing-comma,dict-separator
-
-# Allow the body of a class to be on the same line as the declaration if body
-# contains single statement.
-single-line-class-stmt=no
-
-# Allow the body of an if to be on the same line as the test if there is no
-# else.
-single-line-if-stmt=no
-
-
-[SIMILARITIES]
-
-# Ignore comments when computing similarities.
-ignore-comments=yes
-
-# Ignore docstrings when computing similarities.
-ignore-docstrings=yes
-
-# Ignore imports when computing similarities.
-ignore-imports=no
-
-# Minimum lines number of a similarity.
-min-similarity-lines=4
-
-
-[BASIC]
-
-# Naming hint for argument names
-argument-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$
-
-# Regular expression matching correct argument names
-argument-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$
-
-# Naming hint for attribute names
-attr-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$
-
-# Regular expression matching correct attribute names
-attr-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$
-
-# Bad variable names which should always be refused, separated by a comma
-bad-names=foo,bar,baz,toto,tutu,tata
-
-# Naming hint for class attribute names
-class-attribute-name-hint=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$
-
-# Regular expression matching correct class attribute names
-class-attribute-rgx=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$
-
-# Naming hint for class names
-# class-name-hint=[A-Z_][a-zA-Z0-9]+$
-class-name-hint=[A-Z_][a-zA-Z0-9_]+$
-
-# Regular expression matching correct class names
-# class-rgx=[A-Z_][a-zA-Z0-9]+$
-class-rgx=[A-Z_][a-zA-Z0-9_]+$
-
-# Naming hint for constant names
-const-name-hint=(([A-Z_][A-Z0-9_]*)|(__.*__))$
-
-# Regular expression matching correct constant names
-const-rgx=(([A-Z_][A-Z0-9_]*)|(__.*__))$
-
-# Minimum line length for functions/classes that require docstrings, shorter
-# ones are exempt.
-docstring-min-length=-1
-
-# Naming hint for function names
-function-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$
-
-# Regular expression matching correct function names
-function-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$
-
-# Good variable names which should always be accepted, separated by a comma
-# good-names=i,j,k,ex,Run,_
-good-names=r,g,b,w,i,j,k,n,x,y,z,ex,ok,Run,_
-
-# Include a hint for the correct naming format with invalid-name
-include-naming-hint=no
-
-# Naming hint for inline iteration names
-inlinevar-name-hint=[A-Za-z_][A-Za-z0-9_]*$
-
-# Regular expression matching correct inline iteration names
-inlinevar-rgx=[A-Za-z_][A-Za-z0-9_]*$
-
-# Naming hint for method names
-method-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$
-
-# Regular expression matching correct method names
-method-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$
-
-# Naming hint for module names
-module-name-hint=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$
-
-# Regular expression matching correct module names
-module-rgx=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$
-
-# Colon-delimited sets of names that determine each other's naming style when
-# the name regexes allow several styles.
-name-group=
-
-# Regular expression which should only match function or class names that do
-# not require a docstring.
-no-docstring-rgx=^_
-
-# List of decorators that produce properties, such as abc.abstractproperty. Add
-# to this list to register other decorators that produce valid properties.
-property-classes=abc.abstractproperty
-
-# Naming hint for variable names
-variable-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$
-
-# Regular expression matching correct variable names
-variable-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$
-
-
-[IMPORTS]
-
-# Allow wildcard imports from modules that define __all__.
-allow-wildcard-with-all=no
-
-# Analyse import fallback blocks. This can be used to support both Python 2 and
-# 3 compatible code, which means that the block might have code that exists
-# only in one or another interpreter, leading to false positives when analysed.
-analyse-fallback-blocks=no
-
-# Deprecated modules which should not be used, separated by a comma
-deprecated-modules=optparse,tkinter.tix
-
-# Create a graph of external dependencies in the given file (report RP0402 must
-# not be disabled)
-ext-import-graph=
-
-# Create a graph of every (i.e. internal and external) dependencies in the
-# given file (report RP0402 must not be disabled)
-import-graph=
-
-# Create a graph of internal dependencies in the given file (report RP0402 must
-# not be disabled)
-int-import-graph=
-
-# Force import order to recognize a module as part of the standard
-# compatibility libraries.
-known-standard-library=
-
-# Force import order to recognize a module as part of a third party library.
-known-third-party=enchant
-
-
-[CLASSES]
-
-# List of method names used to declare (i.e. assign) instance attributes.
-defining-attr-methods=__init__,__new__,setUp
-
-# List of member names, which should be excluded from the protected access
-# warning.
-exclude-protected=_asdict,_fields,_replace,_source,_make
-
-# List of valid names for the first argument in a class method.
-valid-classmethod-first-arg=cls
-
-# List of valid names for the first argument in a metaclass class method.
-valid-metaclass-classmethod-first-arg=mcs
-
-
-[DESIGN]
-
-# Maximum number of arguments for function / method
-max-args=5
-
-# Maximum number of attributes for a class (see R0902).
-# max-attributes=7
-max-attributes=11
-
-# Maximum number of boolean expressions in a if statement
-max-bool-expr=5
-
-# Maximum number of branch for function / method body
-max-branches=12
-
-# Maximum number of locals for function / method body
-max-locals=15
-
-# Maximum number of parents for a class (see R0901).
-max-parents=7
-
-# Maximum number of public methods for a class (see R0904).
-max-public-methods=20
-
-# Maximum number of return / yield for function / method body
-max-returns=6
-
-# Maximum number of statements in function / method body
-max-statements=50
-
-# Minimum number of public methods for a class (see R0903).
-min-public-methods=1
-
-
-[EXCEPTIONS]
-
-# Exceptions that will emit a warning when being caught. Defaults to
-# "Exception"
-overgeneral-exceptions=Exception
diff --git a/LICENSE b/LICENSE
deleted file mode 100644
index f288702..0000000
--- a/LICENSE
+++ /dev/null
@@ -1,674 +0,0 @@
- GNU GENERAL PUBLIC LICENSE
- Version 3, 29 June 2007
-
- Copyright (C) 2007 Free Software Foundation, Inc.
- Everyone is permitted to copy and distribute verbatim copies
- of this license document, but changing it is not allowed.
-
- Preamble
-
- The GNU General Public License is a free, copyleft license for
-software and other kinds of works.
-
- The licenses for most software and other practical works are designed
-to take away your freedom to share and change the works. By contrast,
-the GNU General Public License is intended to guarantee your freedom to
-share and change all versions of a program--to make sure it remains free
-software for all its users. We, the Free Software Foundation, use the
-GNU General Public License for most of our software; it applies also to
-any other work released this way by its authors. You can apply it to
-your programs, too.
-
- When we speak of free software, we are referring to freedom, not
-price. Our General Public Licenses are designed to make sure that you
-have the freedom to distribute copies of free software (and charge for
-them if you wish), that you receive source code or can get it if you
-want it, that you can change the software or use pieces of it in new
-free programs, and that you know you can do these things.
-
- To protect your rights, we need to prevent others from denying you
-these rights or asking you to surrender the rights. Therefore, you have
-certain responsibilities if you distribute copies of the software, or if
-you modify it: responsibilities to respect the freedom of others.
-
- For example, if you distribute copies of such a program, whether
-gratis or for a fee, you must pass on to the recipients the same
-freedoms that you received. You must make sure that they, too, receive
-or can get the source code. And you must show them these terms so they
-know their rights.
-
- Developers that use the GNU GPL protect your rights with two steps:
-(1) assert copyright on the software, and (2) offer you this License
-giving you legal permission to copy, distribute and/or modify it.
-
- For the developers' and authors' protection, the GPL clearly explains
-that there is no warranty for this free software. For both users' and
-authors' sake, the GPL requires that modified versions be marked as
-changed, so that their problems will not be attributed erroneously to
-authors of previous versions.
-
- Some devices are designed to deny users access to install or run
-modified versions of the software inside them, although the manufacturer
-can do so. This is fundamentally incompatible with the aim of
-protecting users' freedom to change the software. The systematic
-pattern of such abuse occurs in the area of products for individuals to
-use, which is precisely where it is most unacceptable. Therefore, we
-have designed this version of the GPL to prohibit the practice for those
-products. If such problems arise substantially in other domains, we
-stand ready to extend this provision to those domains in future versions
-of the GPL, as needed to protect the freedom of users.
-
- Finally, every program is threatened constantly by software patents.
-States should not allow patents to restrict development and use of
-software on general-purpose computers, but in those that do, we wish to
-avoid the special danger that patents applied to a free program could
-make it effectively proprietary. To prevent this, the GPL assures that
-patents cannot be used to render the program non-free.
-
- The precise terms and conditions for copying, distribution and
-modification follow.
-
- TERMS AND CONDITIONS
-
- 0. Definitions.
-
- "This License" refers to version 3 of the GNU General Public License.
-
- "Copyright" also means copyright-like laws that apply to other kinds of
-works, such as semiconductor masks.
-
- "The Program" refers to any copyrightable work licensed under this
-License. Each licensee is addressed as "you". "Licensees" and
-"recipients" may be individuals or organizations.
-
- To "modify" a work means to copy from or adapt all or part of the work
-in a fashion requiring copyright permission, other than the making of an
-exact copy. The resulting work is called a "modified version" of the
-earlier work or a work "based on" the earlier work.
-
- A "covered work" means either the unmodified Program or a work based
-on the Program.
-
- To "propagate" a work means to do anything with it that, without
-permission, would make you directly or secondarily liable for
-infringement under applicable copyright law, except executing it on a
-computer or modifying a private copy. Propagation includes copying,
-distribution (with or without modification), making available to the
-public, and in some countries other activities as well.
-
- To "convey" a work means any kind of propagation that enables other
-parties to make or receive copies. Mere interaction with a user through
-a computer network, with no transfer of a copy, is not conveying.
-
- An interactive user interface displays "Appropriate Legal Notices"
-to the extent that it includes a convenient and prominently visible
-feature that (1) displays an appropriate copyright notice, and (2)
-tells the user that there is no warranty for the work (except to the
-extent that warranties are provided), that licensees may convey the
-work under this License, and how to view a copy of this License. If
-the interface presents a list of user commands or options, such as a
-menu, a prominent item in the list meets this criterion.
-
- 1. Source Code.
-
- The "source code" for a work means the preferred form of the work
-for making modifications to it. "Object code" means any non-source
-form of a work.
-
- A "Standard Interface" means an interface that either is an official
-standard defined by a recognized standards body, or, in the case of
-interfaces specified for a particular programming language, one that
-is widely used among developers working in that language.
-
- The "System Libraries" of an executable work include anything, other
-than the work as a whole, that (a) is included in the normal form of
-packaging a Major Component, but which is not part of that Major
-Component, and (b) serves only to enable use of the work with that
-Major Component, or to implement a Standard Interface for which an
-implementation is available to the public in source code form. A
-"Major Component", in this context, means a major essential component
-(kernel, window system, and so on) of the specific operating system
-(if any) on which the executable work runs, or a compiler used to
-produce the work, or an object code interpreter used to run it.
-
- The "Corresponding Source" for a work in object code form means all
-the source code needed to generate, install, and (for an executable
-work) run the object code and to modify the work, including scripts to
-control those activities. However, it does not include the work's
-System Libraries, or general-purpose tools or generally available free
-programs which are used unmodified in performing those activities but
-which are not part of the work. For example, Corresponding Source
-includes interface definition files associated with source files for
-the work, and the source code for shared libraries and dynamically
-linked subprograms that the work is specifically designed to require,
-such as by intimate data communication or control flow between those
-subprograms and other parts of the work.
-
- The Corresponding Source need not include anything that users
-can regenerate automatically from other parts of the Corresponding
-Source.
-
- The Corresponding Source for a work in source code form is that
-same work.
-
- 2. Basic Permissions.
-
- All rights granted under this License are granted for the term of
-copyright on the Program, and are irrevocable provided the stated
-conditions are met. This License explicitly affirms your unlimited
-permission to run the unmodified Program. The output from running a
-covered work is covered by this License only if the output, given its
-content, constitutes a covered work. This License acknowledges your
-rights of fair use or other equivalent, as provided by copyright law.
-
- You may make, run and propagate covered works that you do not
-convey, without conditions so long as your license otherwise remains
-in force. You may convey covered works to others for the sole purpose
-of having them make modifications exclusively for you, or provide you
-with facilities for running those works, provided that you comply with
-the terms of this License in conveying all material for which you do
-not control copyright. Those thus making or running the covered works
-for you must do so exclusively on your behalf, under your direction
-and control, on terms that prohibit them from making any copies of
-your copyrighted material outside their relationship with you.
-
- Conveying under any other circumstances is permitted solely under
-the conditions stated below. Sublicensing is not allowed; section 10
-makes it unnecessary.
-
- 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
-
- No covered work shall be deemed part of an effective technological
-measure under any applicable law fulfilling obligations under article
-11 of the WIPO copyright treaty adopted on 20 December 1996, or
-similar laws prohibiting or restricting circumvention of such
-measures.
-
- When you convey a covered work, you waive any legal power to forbid
-circumvention of technological measures to the extent such circumvention
-is effected by exercising rights under this License with respect to
-the covered work, and you disclaim any intention to limit operation or
-modification of the work as a means of enforcing, against the work's
-users, your or third parties' legal rights to forbid circumvention of
-technological measures.
-
- 4. Conveying Verbatim Copies.
-
- You may convey verbatim copies of the Program's source code as you
-receive it, in any medium, provided that you conspicuously and
-appropriately publish on each copy an appropriate copyright notice;
-keep intact all notices stating that this License and any
-non-permissive terms added in accord with section 7 apply to the code;
-keep intact all notices of the absence of any warranty; and give all
-recipients a copy of this License along with the Program.
-
- You may charge any price or no price for each copy that you convey,
-and you may offer support or warranty protection for a fee.
-
- 5. Conveying Modified Source Versions.
-
- You may convey a work based on the Program, or the modifications to
-produce it from the Program, in the form of source code under the
-terms of section 4, provided that you also meet all of these conditions:
-
- a) The work must carry prominent notices stating that you modified
- it, and giving a relevant date.
-
- b) The work must carry prominent notices stating that it is
- released under this License and any conditions added under section
- 7. This requirement modifies the requirement in section 4 to
- "keep intact all notices".
-
- c) You must license the entire work, as a whole, under this
- License to anyone who comes into possession of a copy. This
- License will therefore apply, along with any applicable section 7
- additional terms, to the whole of the work, and all its parts,
- regardless of how they are packaged. This License gives no
- permission to license the work in any other way, but it does not
- invalidate such permission if you have separately received it.
-
- d) If the work has interactive user interfaces, each must display
- Appropriate Legal Notices; however, if the Program has interactive
- interfaces that do not display Appropriate Legal Notices, your
- work need not make them do so.
-
- A compilation of a covered work with other separate and independent
-works, which are not by their nature extensions of the covered work,
-and which are not combined with it such as to form a larger program,
-in or on a volume of a storage or distribution medium, is called an
-"aggregate" if the compilation and its resulting copyright are not
-used to limit the access or legal rights of the compilation's users
-beyond what the individual works permit. Inclusion of a covered work
-in an aggregate does not cause this License to apply to the other
-parts of the aggregate.
-
- 6. Conveying Non-Source Forms.
-
- You may convey a covered work in object code form under the terms
-of sections 4 and 5, provided that you also convey the
-machine-readable Corresponding Source under the terms of this License,
-in one of these ways:
-
- a) Convey the object code in, or embodied in, a physical product
- (including a physical distribution medium), accompanied by the
- Corresponding Source fixed on a durable physical medium
- customarily used for software interchange.
-
- b) Convey the object code in, or embodied in, a physical product
- (including a physical distribution medium), accompanied by a
- written offer, valid for at least three years and valid for as
- long as you offer spare parts or customer support for that product
- model, to give anyone who possesses the object code either (1) a
- copy of the Corresponding Source for all the software in the
- product that is covered by this License, on a durable physical
- medium customarily used for software interchange, for a price no
- more than your reasonable cost of physically performing this
- conveying of source, or (2) access to copy the
- Corresponding Source from a network server at no charge.
-
- c) Convey individual copies of the object code with a copy of the
- written offer to provide the Corresponding Source. This
- alternative is allowed only occasionally and noncommercially, and
- only if you received the object code with such an offer, in accord
- with subsection 6b.
-
- d) Convey the object code by offering access from a designated
- place (gratis or for a charge), and offer equivalent access to the
- Corresponding Source in the same way through the same place at no
- further charge. You need not require recipients to copy the
- Corresponding Source along with the object code. If the place to
- copy the object code is a network server, the Corresponding Source
- may be on a different server (operated by you or a third party)
- that supports equivalent copying facilities, provided you maintain
- clear directions next to the object code saying where to find the
- Corresponding Source. Regardless of what server hosts the
- Corresponding Source, you remain obligated to ensure that it is
- available for as long as needed to satisfy these requirements.
-
- e) Convey the object code using peer-to-peer transmission, provided
- you inform other peers where the object code and Corresponding
- Source of the work are being offered to the general public at no
- charge under subsection 6d.
-
- A separable portion of the object code, whose source code is excluded
-from the Corresponding Source as a System Library, need not be
-included in conveying the object code work.
-
- A "User Product" is either (1) a "consumer product", which means any
-tangible personal property which is normally used for personal, family,
-or household purposes, or (2) anything designed or sold for incorporation
-into a dwelling. In determining whether a product is a consumer product,
-doubtful cases shall be resolved in favor of coverage. For a particular
-product received by a particular user, "normally used" refers to a
-typical or common use of that class of product, regardless of the status
-of the particular user or of the way in which the particular user
-actually uses, or expects or is expected to use, the product. A product
-is a consumer product regardless of whether the product has substantial
-commercial, industrial or non-consumer uses, unless such uses represent
-the only significant mode of use of the product.
-
- "Installation Information" for a User Product means any methods,
-procedures, authorization keys, or other information required to install
-and execute modified versions of a covered work in that User Product from
-a modified version of its Corresponding Source. The information must
-suffice to ensure that the continued functioning of the modified object
-code is in no case prevented or interfered with solely because
-modification has been made.
-
- If you convey an object code work under this section in, or with, or
-specifically for use in, a User Product, and the conveying occurs as
-part of a transaction in which the right of possession and use of the
-User Product is transferred to the recipient in perpetuity or for a
-fixed term (regardless of how the transaction is characterized), the
-Corresponding Source conveyed under this section must be accompanied
-by the Installation Information. But this requirement does not apply
-if neither you nor any third party retains the ability to install
-modified object code on the User Product (for example, the work has
-been installed in ROM).
-
- The requirement to provide Installation Information does not include a
-requirement to continue to provide support service, warranty, or updates
-for a work that has been modified or installed by the recipient, or for
-the User Product in which it has been modified or installed. Access to a
-network may be denied when the modification itself materially and
-adversely affects the operation of the network or violates the rules and
-protocols for communication across the network.
-
- Corresponding Source conveyed, and Installation Information provided,
-in accord with this section must be in a format that is publicly
-documented (and with an implementation available to the public in
-source code form), and must require no special password or key for
-unpacking, reading or copying.
-
- 7. Additional Terms.
-
- "Additional permissions" are terms that supplement the terms of this
-License by making exceptions from one or more of its conditions.
-Additional permissions that are applicable to the entire Program shall
-be treated as though they were included in this License, to the extent
-that they are valid under applicable law. If additional permissions
-apply only to part of the Program, that part may be used separately
-under those permissions, but the entire Program remains governed by
-this License without regard to the additional permissions.
-
- When you convey a copy of a covered work, you may at your option
-remove any additional permissions from that copy, or from any part of
-it. (Additional permissions may be written to require their own
-removal in certain cases when you modify the work.) You may place
-additional permissions on material, added by you to a covered work,
-for which you have or can give appropriate copyright permission.
-
- Notwithstanding any other provision of this License, for material you
-add to a covered work, you may (if authorized by the copyright holders of
-that material) supplement the terms of this License with terms:
-
- a) Disclaiming warranty or limiting liability differently from the
- terms of sections 15 and 16 of this License; or
-
- b) Requiring preservation of specified reasonable legal notices or
- author attributions in that material or in the Appropriate Legal
- Notices displayed by works containing it; or
-
- c) Prohibiting misrepresentation of the origin of that material, or
- requiring that modified versions of such material be marked in
- reasonable ways as different from the original version; or
-
- d) Limiting the use for publicity purposes of names of licensors or
- authors of the material; or
-
- e) Declining to grant rights under trademark law for use of some
- trade names, trademarks, or service marks; or
-
- f) Requiring indemnification of licensors and authors of that
- material by anyone who conveys the material (or modified versions of
- it) with contractual assumptions of liability to the recipient, for
- any liability that these contractual assumptions directly impose on
- those licensors and authors.
-
- All other non-permissive additional terms are considered "further
-restrictions" within the meaning of section 10. If the Program as you
-received it, or any part of it, contains a notice stating that it is
-governed by this License along with a term that is a further
-restriction, you may remove that term. If a license document contains
-a further restriction but permits relicensing or conveying under this
-License, you may add to a covered work material governed by the terms
-of that license document, provided that the further restriction does
-not survive such relicensing or conveying.
-
- If you add terms to a covered work in accord with this section, you
-must place, in the relevant source files, a statement of the
-additional terms that apply to those files, or a notice indicating
-where to find the applicable terms.
-
- Additional terms, permissive or non-permissive, may be stated in the
-form of a separately written license, or stated as exceptions;
-the above requirements apply either way.
-
- 8. Termination.
-
- You may not propagate or modify a covered work except as expressly
-provided under this License. Any attempt otherwise to propagate or
-modify it is void, and will automatically terminate your rights under
-this License (including any patent licenses granted under the third
-paragraph of section 11).
-
- However, if you cease all violation of this License, then your
-license from a particular copyright holder is reinstated (a)
-provisionally, unless and until the copyright holder explicitly and
-finally terminates your license, and (b) permanently, if the copyright
-holder fails to notify you of the violation by some reasonable means
-prior to 60 days after the cessation.
-
- Moreover, your license from a particular copyright holder is
-reinstated permanently if the copyright holder notifies you of the
-violation by some reasonable means, this is the first time you have
-received notice of violation of this License (for any work) from that
-copyright holder, and you cure the violation prior to 30 days after
-your receipt of the notice.
-
- Termination of your rights under this section does not terminate the
-licenses of parties who have received copies or rights from you under
-this License. If your rights have been terminated and not permanently
-reinstated, you do not qualify to receive new licenses for the same
-material under section 10.
-
- 9. Acceptance Not Required for Having Copies.
-
- You are not required to accept this License in order to receive or
-run a copy of the Program. Ancillary propagation of a covered work
-occurring solely as a consequence of using peer-to-peer transmission
-to receive a copy likewise does not require acceptance. However,
-nothing other than this License grants you permission to propagate or
-modify any covered work. These actions infringe copyright if you do
-not accept this License. Therefore, by modifying or propagating a
-covered work, you indicate your acceptance of this License to do so.
-
- 10. Automatic Licensing of Downstream Recipients.
-
- Each time you convey a covered work, the recipient automatically
-receives a license from the original licensors, to run, modify and
-propagate that work, subject to this License. You are not responsible
-for enforcing compliance by third parties with this License.
-
- An "entity transaction" is a transaction transferring control of an
-organization, or substantially all assets of one, or subdividing an
-organization, or merging organizations. If propagation of a covered
-work results from an entity transaction, each party to that
-transaction who receives a copy of the work also receives whatever
-licenses to the work the party's predecessor in interest had or could
-give under the previous paragraph, plus a right to possession of the
-Corresponding Source of the work from the predecessor in interest, if
-the predecessor has it or can get it with reasonable efforts.
-
- You may not impose any further restrictions on the exercise of the
-rights granted or affirmed under this License. For example, you may
-not impose a license fee, royalty, or other charge for exercise of
-rights granted under this License, and you may not initiate litigation
-(including a cross-claim or counterclaim in a lawsuit) alleging that
-any patent claim is infringed by making, using, selling, offering for
-sale, or importing the Program or any portion of it.
-
- 11. Patents.
-
- A "contributor" is a copyright holder who authorizes use under this
-License of the Program or a work on which the Program is based. The
-work thus licensed is called the contributor's "contributor version".
-
- A contributor's "essential patent claims" are all patent claims
-owned or controlled by the contributor, whether already acquired or
-hereafter acquired, that would be infringed by some manner, permitted
-by this License, of making, using, or selling its contributor version,
-but do not include claims that would be infringed only as a
-consequence of further modification of the contributor version. For
-purposes of this definition, "control" includes the right to grant
-patent sublicenses in a manner consistent with the requirements of
-this License.
-
- Each contributor grants you a non-exclusive, worldwide, royalty-free
-patent license under the contributor's essential patent claims, to
-make, use, sell, offer for sale, import and otherwise run, modify and
-propagate the contents of its contributor version.
-
- In the following three paragraphs, a "patent license" is any express
-agreement or commitment, however denominated, not to enforce a patent
-(such as an express permission to practice a patent or covenant not to
-sue for patent infringement). To "grant" such a patent license to a
-party means to make such an agreement or commitment not to enforce a
-patent against the party.
-
- If you convey a covered work, knowingly relying on a patent license,
-and the Corresponding Source of the work is not available for anyone
-to copy, free of charge and under the terms of this License, through a
-publicly available network server or other readily accessible means,
-then you must either (1) cause the Corresponding Source to be so
-available, or (2) arrange to deprive yourself of the benefit of the
-patent license for this particular work, or (3) arrange, in a manner
-consistent with the requirements of this License, to extend the patent
-license to downstream recipients. "Knowingly relying" means you have
-actual knowledge that, but for the patent license, your conveying the
-covered work in a country, or your recipient's use of the covered work
-in a country, would infringe one or more identifiable patents in that
-country that you have reason to believe are valid.
-
- If, pursuant to or in connection with a single transaction or
-arrangement, you convey, or propagate by procuring conveyance of, a
-covered work, and grant a patent license to some of the parties
-receiving the covered work authorizing them to use, propagate, modify
-or convey a specific copy of the covered work, then the patent license
-you grant is automatically extended to all recipients of the covered
-work and works based on it.
-
- A patent license is "discriminatory" if it does not include within
-the scope of its coverage, prohibits the exercise of, or is
-conditioned on the non-exercise of one or more of the rights that are
-specifically granted under this License. You may not convey a covered
-work if you are a party to an arrangement with a third party that is
-in the business of distributing software, under which you make payment
-to the third party based on the extent of your activity of conveying
-the work, and under which the third party grants, to any of the
-parties who would receive the covered work from you, a discriminatory
-patent license (a) in connection with copies of the covered work
-conveyed by you (or copies made from those copies), or (b) primarily
-for and in connection with specific products or compilations that
-contain the covered work, unless you entered into that arrangement,
-or that patent license was granted, prior to 28 March 2007.
-
- Nothing in this License shall be construed as excluding or limiting
-any implied license or other defenses to infringement that may
-otherwise be available to you under applicable patent law.
-
- 12. No Surrender of Others' Freedom.
-
- If conditions are imposed on you (whether by court order, agreement or
-otherwise) that contradict the conditions of this License, they do not
-excuse you from the conditions of this License. If you cannot convey a
-covered work so as to satisfy simultaneously your obligations under this
-License and any other pertinent obligations, then as a consequence you may
-not convey it at all. For example, if you agree to terms that obligate you
-to collect a royalty for further conveying from those to whom you convey
-the Program, the only way you could satisfy both those terms and this
-License would be to refrain entirely from conveying the Program.
-
- 13. Use with the GNU Affero General Public License.
-
- Notwithstanding any other provision of this License, you have
-permission to link or combine any covered work with a work licensed
-under version 3 of the GNU Affero General Public License into a single
-combined work, and to convey the resulting work. The terms of this
-License will continue to apply to the part which is the covered work,
-but the special requirements of the GNU Affero General Public License,
-section 13, concerning interaction through a network will apply to the
-combination as such.
-
- 14. Revised Versions of this License.
-
- The Free Software Foundation may publish revised and/or new versions of
-the GNU General Public License from time to time. Such new versions will
-be similar in spirit to the present version, but may differ in detail to
-address new problems or concerns.
-
- Each version is given a distinguishing version number. If the
-Program specifies that a certain numbered version of the GNU General
-Public License "or any later version" applies to it, you have the
-option of following the terms and conditions either of that numbered
-version or of any later version published by the Free Software
-Foundation. If the Program does not specify a version number of the
-GNU General Public License, you may choose any version ever published
-by the Free Software Foundation.
-
- If the Program specifies that a proxy can decide which future
-versions of the GNU General Public License can be used, that proxy's
-public statement of acceptance of a version permanently authorizes you
-to choose that version for the Program.
-
- Later license versions may give you additional or different
-permissions. However, no additional obligations are imposed on any
-author or copyright holder as a result of your choosing to follow a
-later version.
-
- 15. Disclaimer of Warranty.
-
- THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
-APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
-HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
-OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
-THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
-PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
-IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
-ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
-
- 16. Limitation of Liability.
-
- IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
-WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
-THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
-GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
-USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
-DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
-PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
-EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
-SUCH DAMAGES.
-
- 17. Interpretation of Sections 15 and 16.
-
- If the disclaimer of warranty and limitation of liability provided
-above cannot be given local legal effect according to their terms,
-reviewing courts shall apply local law that most closely approximates
-an absolute waiver of all civil liability in connection with the
-Program, unless a warranty or assumption of liability accompanies a
-copy of the Program in return for a fee.
-
- END OF TERMS AND CONDITIONS
-
- How to Apply These Terms to Your New Programs
-
- If you develop a new program, and you want it to be of the greatest
-possible use to the public, the best way to achieve this is to make it
-free software which everyone can redistribute and change under these terms.
-
- To do so, attach the following notices to the program. It is safest
-to attach them to the start of each source file to most effectively
-state the exclusion of warranty; and each file should have at least
-the "copyright" line and a pointer to where the full notice is found.
-
-
- Copyright (C)
-
- This program is free software: you can redistribute it and/or modify
- it under the terms of the GNU General Public License as published by
- the Free Software Foundation, either version 3 of the License, or
- (at your option) any later version.
-
- This program is distributed in the hope that it will be useful,
- but WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- GNU General Public License for more details.
-
- You should have received a copy of the GNU General Public License
- along with this program. If not, see .
-
-Also add information on how to contact you by electronic and paper mail.
-
- If the program does terminal interaction, make it output a short
-notice like this when it starts in an interactive mode:
-
- Copyright (C)
- This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
- This is free software, and you are welcome to redistribute it
- under certain conditions; type `show c' for details.
-
-The hypothetical commands `show w' and `show c' should show the appropriate
-parts of the General Public License. Of course, your program's commands
-might be different; for a GUI interface, you would use an "about box".
-
- You should also get your employer (if you work as a programmer) or school,
-if any, to sign a "copyright disclaimer" for the program, if necessary.
-For more information on this, and how to apply and follow the GNU GPL, see
-.
-
- The GNU General Public License does not permit incorporating your program
-into proprietary programs. If your program is a subroutine library, you
-may consider it more useful to permit linking proprietary applications with
-the library. If this is what you want to do, use the GNU Lesser General
-Public License instead of this License. But first, please read
-.
diff --git a/README.md b/README.md
deleted file mode 100644
index bde6ed9..0000000
--- a/README.md
+++ /dev/null
@@ -1,55 +0,0 @@
-# recipe-dl
-
-Recipe download script. Will format the recipe into JSON, Markdown,
-or reStructuredText. I tend to use more reStructuredText so that is the
-default output format.
-
-## Usage
-
-```
-usage: recipe-dl [-h] [-v] [-a] [-d] [-q] [-j] [-m] [-r] [-i INFILE]
- [-o OUTFILE] [-s]
- [URL [URL ...]]
-
-positional arguments:
- URL
-
-optional arguments:
- -h, --help show this help message and exit
- -v, --version show program's version number and exit
- -a, --authorize Force authorization of Cook Illustrated sites
- -d, --debug Add additional Output
- -q, --quiet Suppress most output aka Silent Mode.
- -j, --output-json Output results in JSON format.
- -m, --output-md Output results in Markdown format.
- -r, --output-rst Output results in reStructuredText format.
- -i INFILE, --infile INFILE
- Specify input json file infile.
- -o OUTFILE, --outfile OUTFILE
- Specify output file outfile.
- -s, --save-to-file Save output file(s).
- ```
-
-## Compatibility
-
-Currently this has been tested for the following sites:
-* [Cook's Illustrated](www.cooksillustrated.com) (Subscription Required)
-* [Cook's Country](www.cookscountry.com) (Subscription Required)
-* [America's Test Kitchen](www.americatestkitchen.com) (Subscription Required)
-* [New York Times](cooking.nytimes.com)
-* [Bon Appetit](www.bonappetit.com)
-* [FoodNetwork.com](www.foodnetwork.com)
-* [CookingChannelTV.com](www.cookingchanneltv.com)
-
-## Install
-Copy recipe-dl.sh to /opt.
-```sh
-curl https://raw.githubusercontent.com/rodneyshupe/recipe-dl/master/recipe-dl.sh --output /opt/recipe-dl.sh && chmod + x /opt/recipe-dl.sh
-curl https://raw.githubusercontent.com/rodneyshupe/recipe-dl/master/rst2recipe.sh --output /opt/recipe-dl.sh && chmod + x /opt/rst2recipe.sh
-```
-
-Create symbolic links to somewhere on the path.
-```sh
-ln -s /opt/rst2recipe.sh /usr/local/bin/rst2recipe
-ln -s /opt/rst2recipe.sh /usr/local/bin/rst2recipe
-```
diff --git a/recipe-dl/CustomExceptions.py b/recipe-dl/CustomExceptions.py
deleted file mode 100644
index dc310a7..0000000
--- a/recipe-dl/CustomExceptions.py
+++ /dev/null
@@ -1,15 +0,0 @@
-class Error(Exception):
- """Base class for exceptions in this module."""
- pass
-
-class UrlError(Error):
- """Exception raised for errors in the input.
-
- Attributes:
- url -- url for which the error occurred
- message -- explanation of the error
- """
-
- def __init__(self, url, message):
- self.url = url
- self.message = message
diff --git a/recipe-dl/CustomPrint.py b/recipe-dl/CustomPrint.py
deleted file mode 100644
index cc1cb51..0000000
--- a/recipe-dl/CustomPrint.py
+++ /dev/null
@@ -1,161 +0,0 @@
-import sys, traceback
-#import argparse
-
-class ansi_colors:
- # Reset
- Reset='\033[0m' # Text Reset
-
- # Regular Colors
- Black='\033[0;30m' # Black
- Red='\033[0;31m' # Red
- Green='\033[0;32m' # Green
- Yellow='\033[0;33m' # Yellow
- Blue='\033[0;34m' # Blue
- Purple='\033[0;35m' # Purple
- Cyan='\033[0;36m' # Cyan
- White='\033[0;37m' # White
-
- # Bold
- BBlack='\033[1;30m' # Black
- BRed='\033[1;31m' # Red
- BGreen='\033[1;32m' # Green
- BYellow='\033[1;33m' # Yellow
- BBlue='\033[1;34m' # Blue
- BPurple='\033[1;35m' # Purple
- BCyan='\033[1;36m' # Cyan
- BWhite='\033[1;37m' # White
-
- # Underline
- UBlack='\033[4;30m' # Black
- URed='\033[4;31m' # Red
- UGreen='\033[4;32m' # Green
- UYellow='\033[4;33m' # Yellow
- UBlue='\033[4;34m' # Blue
- UPurple='\033[4;35m' # Purple
- UCyan='\033[4;36m' # Cyan
- UWhite='\033[4;37m' # White
-
- # Background
- On_Black='\033[40m' # Black
- On_Red='\033[41m' # Red
- On_Green='\033[42m' # Green
- On_Yellow='\033[43m' # Yellow
- On_Blue='\033[44m' # Blue
- On_Purple='\033[45m' # Purple
- On_Cyan='\033[46m' # Cyan
- On_White='\033[47m' # White
-
- # High Intensity
- IBlack='\033[0;90m' # Black
- IRed='\033[0;91m' # Red
- IGreen='\033[0;92m' # Green
- IYellow='\033[0;93m' # Yellow
- IBlue='\033[0;94m' # Blue
- IPurple='\033[0;95m' # Purple
- ICyan='\033[0;96m' # Cyan
- IWhite='\033[0;97m' # White
-
- # Bold High Intensity
- BIBlack='\033[1;90m' # Black
- BIRed='\033[1;91m' # Red
- BIGreen='\033[1;92m' # Green
- BIYellow='\033[1;93m' # Yellow
- BIBlue='\033[1;94m' # Blue
- BIPurple='\033[1;95m' # Purple
- BICyan='\033[1;96m' # Cyan
- BIWhite='\033[1;97m' # White
-
- # High Intensity backgrounds
- On_IBlack='\033[0;100m' # Black
- On_IRed='\033[0;101m' # Red
- On_IGreen='\033[0;102m' # Green
- On_IYellow='\033[0;103m' # Yellow
- On_IBlue='\033[0;104m' # Blue
- On_IPurple='\033[0;105m' # Purple
- On_ICyan='\033[0;106m' # Cyan
- On_IWhite='\033[0;107m' # White
-
-class bcolors:
- HEADER = '\033[95m'
- DEBUG = '\033[94m'
- OKBLUE = '\033[94m'
- OKGREEN = '\033[92m'
- WARNING = '\033[93m'
- FAIL = '\033[91m'
- ERROR = '\033[91m'
- RESET = ansi_colors.Reset
- BOLD = '\033[1m'
- UNDERLINE = '\033[4m'
-
-
-def breadcrumbs(limit = None):
- def function_name(stack_lines):
- import re
-
- name = stack_lines.split('\n')[1].strip()
- name = re.sub('\([^\)]*\)', '', name)
- name = re.sub('[^=]*=', '', name).strip()
-
- return name
-
- breadcrumb=''
- seperator=' > '
- stack = traceback.format_stack()
- ignore = 3
- if len(stack) >= ignore:
- if limit is None:
- start = 0
- else:
- start = len(stack) - ignore - limit
- if start <= len(stack) - ignore:
- for trace_idx in range(start, len(stack) - ignore):
- function = function_name(stack[trace_idx])
- if trace_idx > start:
- breadcrumb = breadcrumb + seperator
- breadcrumb = breadcrumb + function
- if breadcrumb.strip() != '':
- breadcrumb = ': ' + breadcrumb
- return breadcrumb
-
-try: # Windows
- from msvcrt import putwch
-
- def print_to_console(message):
- for c in message:
- putwch(c)
- # newline
- putwch('\r')
- putwch('\n')
-except ImportError: # Unix
- import os
-
- fd = os.open('/dev/tty', os.O_WRONLY | os.O_NOCTTY)
- tty = os.fdopen(fd, 'w', 1)
- del fd
- def print_to_console(message, *, _file=tty):
- print(message, file=_file)
- del tty
-
-def print_info(args, msg):
- if args is None or not args.quiet:
- print_to_console (msg)
-
-def print_debug(args, msg):
- if args is None or args.debug:
- breadcrumb=breadcrumbs()
- print_info(args, f'[{bcolors.DEBUG} DEBUG{breadcrumb} {bcolors.RESET}] {msg}')
-
-def print_warning(args, msg):
- if not args is None and not args.quiet:
- breadcrumb = ''
- if args.debug:
- breadcrumb=breadcrumbs()
- print_info(args, f'[{bcolors.WARNING} WARNING{breadcrumb} {bcolors.RESET}] {msg}')
-
-def print_error(args, msg):
- breadcrumb = ''
- if args is None or args.debug:
- breadcrumb=breadcrumbs()
- else:
- breadcrumb=breadcrumbs(limit=1)
- print(f'[{bcolors.ERROR} ERROR{breadcrumb} {bcolors.RESET}] {msg}', file=sys.stderr)
diff --git a/recipe-dl/iso8601.py b/recipe-dl/iso8601.py
deleted file mode 100644
index f42b94d..0000000
--- a/recipe-dl/iso8601.py
+++ /dev/null
@@ -1,88 +0,0 @@
-def to_minutes( iso8601_duration ):
- """ Take iso8601 duration and returns minutes
- (rounded down to whole minute)
- """
- try:
- minutes = int(to_seconds(iso8601_duration)/60)
- except:
- minutes = 0
- return minutes
-
-def to_seconds( iso8601_duration ):
- """ Take iso8601 duration and returns seconds """
- from re import findall
-
- def year(number):
- return number * 365 * 24 * 60 * 60
-
- def month(number):
- return number * 30 * 24 * 60 * 60 # Assumes 30 days
-
- def week(number):
- return number * 7 * 24 * 60 * 60
-
- def day(number):
- return number * 24 * 60 * 60
-
- def hour(number):
- return number * 60 * 60
-
- def minute(number):
- return number * 60
-
- def second(number):
- return number
-
- switcher = {
- 'Y': year,
- 'M': month,
- 'W': week,
- 'D': day,
- 'H': hour,
- 'm': minute,
- 'S': second
- }
-
- if iso8601_duration[0] != 'P':
- raise ValueError('Not an ISO 8601 Duration string')
- seconds = 0
- # split by the 'T'
- for i, item in enumerate(iso8601_duration.split('T')):
- for number, unit in findall( '(?P\d+)(?PS|M|H|D|W|Y)', item ):
- # print '%s -> %s %s' % (d, number, unit )
- number = int(number)
- return_value = 0
- if unit == 'M' and i != 0:
- unit = 'm'
- func = switcher.get(unit, lambda: "Invalid ISO 8601 Duration string")
- seconds = seconds + func(number)
- return seconds
-
-def tests():
- """ Run a number of tests on to_minutes and to_seconds """
- test_data = [
- {'iso8601': 'PT10M', 'minutes': 10, 'seconds': 600},
- {'iso8601': 'PT5H', 'minutes': (5*60), 'seconds': (5*60*60)},
- {'iso8601': 'P3D', 'minutes': (3*24*60), 'seconds': (3*24*60*60)},
- {'iso8601': 'PT45S', 'minutes': (0), 'seconds': (45)},
- {'iso8601': 'P8W', 'minutes': (8*7*24*60), 'seconds': (8*7*24*60*60)},
- {'iso8601': 'P7Y', 'minutes': (7*365*24*60), 'seconds': (7*365*24*60*60)},
- {'iso8601': 'PT5H10M', 'minutes': (5*60+10), 'seconds': ((5*60+10)*60)},
- {'iso8601': 'P2YT3H10M', 'minutes': ((((2*365*24)+3)*60)+10), 'seconds': (((((2*365*24)+3)*60)+10)*60)},
- {'iso8601': 'P3Y6M4DT12H30M5S', 'minutes': ((((((3*365)+(6*30)+4)*24)+12)*60)+30), 'seconds': (((((((3*365)+(6*30)+4)*24)+12)*60)+30)*60+5)},
- {'iso8601': 'P23M', 'minutes': (23*30*24*60), 'seconds': (23*30*24*60*60)},
- {'iso8601': 'P2Y', 'minutes': (2*365*24*60), 'seconds': (2*365*24*60*60)}
- ]
- for test in test_data:
- seconds = to_seconds( test['iso8601'] )
- minutes = to_minutes( test['iso8601'] )
- if seconds == test['seconds']:
- seconds_result='pass (' + str(seconds) + ')'
- else:
- seconds_result='fail (expected ' + str(test['seconds']) + ' returned ' + str(seconds) + ')'
- if minutes == test['minutes']:
- minutes_result='pass (' + str(minutes) + ')'
- else:
- minutes_result='fail (expected ' + str(test['minutes']) + ' returned ' + str(minutes) + ')'
-
- print ("iso8601 duration Test: %-16s \t to_seconds %-16s \t to_minutes %-16s" % (test['iso8601'], seconds_result, minutes_result))
diff --git a/recipe-dl/recipe-dl.py b/recipe-dl/recipe-dl.py
index 8c29279..18a3c03 100755
--- a/recipe-dl/recipe-dl.py
+++ b/recipe-dl/recipe-dl.py
@@ -1,4 +1,5 @@
#!/usr/bin/env python
+# -*- coding: utf-8 -*-
import sys, os
import argparse
@@ -110,6 +111,12 @@ def parse_arguments(print_usage = False, detail = False):
default=False,
help="For the use of the recipe scraper where applicable.",
)
+ parser.add_argument(
+ "--quick-tests",
+ action="store_true",
+ dest="quick_tests",
+ default=False
+ )
parser.add_argument('URL', nargs='*', action="append", default=[],)
@@ -164,7 +171,7 @@ def url2publisher(url):
elif domain == 'www.epicurious.com':
publisher = "Epicurious"
elif domain == 'www.bonappetit.com':
- publisher = "Bon Appétit"
+ publisher = "Bon Appetit"
elif domain == 'www.foodnetwork.com':
publisher = "Food Network"
elif domain == 'cooking.nytimes.com':
@@ -626,12 +633,13 @@ def get_json(url):
return_value = None
page = requests.get(url)
- match = re.search(r']*type=.application/ld\+json.[^>]*>', page.text)
+ match = re.search(r']*type=.?application/ld\+json.?[^>]*>', page.text)
if match:
soup = BeautifulSoup(page.text, 'html5lib')
scripts = soup.findAll('script', attrs = {'type':'application/ld+json'})
for script in scripts:
- raw_json = json.loads(script.text)
+ json_stripped=re.sub('^[^\{\[]*', '', script.text)
+ raw_json = json.loads(json_stripped)
if type(raw_json) == list:
return_value = json_find_array_element(raw_json, '@type', 'Recipe')
try:
@@ -978,27 +986,29 @@ def quick_tests(args):
'https://www.saveur.com/perfect-brown-rice-recipe/',
'https://www.thechunkychef.com/easy-slow-cooker-mongolian-beef-recipe'
]
- for test in tests:
+ for test_url in tests:
print_info (args, "==========================")
- print_info (args, recipe_output(args, url2recipe_json(test)))
+ recipe_output(args, url2recipe_json(args, test_url))
print_info (args, "==========================")
def main(args):
print_debug (args, args)
-
- if not args.URL == [[]]:
- for url in args.URL[0]:
- recipe_json = url2recipe_json(args, url)
- recipe_output(args, recipe_json)
+ if args.quick_tests:
+ quick_tests(args)
else:
- if not args.infile is None and args.infile != "":
- print_info (args, "Processsing %s..." % args.infile)
- with open(args.infile) as json_file:
- recipe_json = json.load(json_file)
+ if not args.URL == [[]]:
+ for url in args.URL[0]:
+ recipe_json = url2recipe_json(args, url)
recipe_output(args, recipe_json)
else:
- print_error (args,"You must specify an input URL or input JSON file.\n")
- parse_arguments(print_usage=True)
+ if not args.infile is None and args.infile != "":
+ print_info (args, "Processsing %s..." % args.infile)
+ with open(args.infile) as json_file:
+ recipe_json = json.load(json_file)
+ recipe_output(args, recipe_json)
+ else:
+ print_error (args,"You must specify an input URL or input JSON file.\n")
+ parse_arguments(print_usage=True)
if __name__ == '__main__':
args = parse_arguments()
diff --git a/requirements.in b/requirements.in
deleted file mode 100644
index 5752f15..0000000
--- a/requirements.in
+++ /dev/null
@@ -1,5 +0,0 @@
-requests
-lxml
-bs4
-html5lib
-recipe-scrapers
diff --git a/requirements.txt b/requirements.txt
deleted file mode 100644
index fdf3fe3..0000000
--- a/requirements.txt
+++ /dev/null
@@ -1,18 +0,0 @@
-#
-# This file is autogenerated by pip-compile
-# To update, run:
-#
-# pip-compile requirements.in
-#
-beautifulsoup4==4.9.1 # via bs4
-bs4==0.0.1 # via -r requirements.in
-certifi==2020.6.20 # via requests
-chardet==3.0.4 # via requests
-html5lib==1.1 # via -r requirements.in
-idna==2.9 # via requests
-lxml==4.5.1 # via -r requirements.in
-requests==2.24.0 # via -r requirements.in
-six==1.15.0 # via html5lib
-soupsieve==2.0.1 # via beautifulsoup4
-urllib3==1.25.9 # via requests
-webencodings==0.5.1 # via html5lib
diff --git a/setup.py b/setup.py
deleted file mode 100644
index f8ed070..0000000
--- a/setup.py
+++ /dev/null
@@ -1,39 +0,0 @@
-#!/usr/bin/env python
-
-# Reference: https://packaging.python.org/tutorials/packaging-projects/
-
-import setuptools
-
-with open("README.md", "r") as fh:
- long_description = fh.read()
-
-print (setuptools.find_packages())
-exit(0)
-
-setuptools.setup(
-
- name="recipe-dl-YOUR-USERNAME-HERE", # Replace with your own username
- name = 'recipe-dl',
- version="0.1.0",
- author = 'Rodney Shupe',
- author_email = 'rodney@shupe.ca',
- description = 'Recipe Downloader - Download Recipies from many websites and output as JSON, Markdown or reStructuredText.',
- long_description=long_description,
- long_description_content_type="text/markdown",
- url = 'https://github.com/rodneyshupe/recipe-dl.py',
- #packages = ['recipe-dl'],
- packages = setuptools.find_packages(),
- download_url = 'https://github.com/PolBaladas/torsimany/tarball/1.0',
- keywords = ['recipe', 'download', 'json', 'markdown', 'md', 'restructuredtext', 'rst', 'convert'],
- entry_points={
- 'console_scripts': [
- 'recipe-dl = recipe-dl.recipe-dl:main'
- ]
- },
- classifiers=[
- "Programming Language :: Python :: 3",
- "License :: OSI Approved :: MIT License",
- "Operating System :: OS Independent",
- ],
- python_requires='>=3.6',
-)
diff --git a/tests/reference-files/README.md b/tests/reference-files/README.md
deleted file mode 100644
index 1ffa370..0000000
--- a/tests/reference-files/README.md
+++ /dev/null
@@ -1,10 +0,0 @@
-# Reference Files
-This directory stores the reference files for the tests. If a reference file is
-missing the first time the test is executed the file will be created.
-
-You can also reset all reference files with the `--reset-references` argument on
-the test script.
-
-```sh
-./tests.sh --reset-references
-```
diff --git a/tests/tests.sh b/tests/tests.sh
deleted file mode 100644
index 9e83ae9..0000000
--- a/tests/tests.sh
+++ /dev/null
@@ -1,390 +0,0 @@
-#!/usr/bin/env bash
-trap 'rc=$?; echo "ERR at line ${LINENO} (rc: $rc)"; exit $rc' ERR
-#trap 'rc=$?; echo "EXIT (rc: $rc)"; exit $rc' EXIT
-set -u
-
-### Script Constant
-declare -r SCRIPT_NAME=$0
-
-### Exit Constants
-declare -r -i EX_OK=0 # successful termination
-declare -r -i EX_USAGE=64 # command line usage error
-declare -r -i EX_NOINPUT=66 # cannot open input
-declare -r -i EX_OSFILE=72 # critical OS file missing
-declare -r -i EX_IOERR=74 # input/output error
-
-### Forground Color Constants
-declare -A -x COLORS=(
- ['normal']="$(tput sgr0)"
- ['red']="$(tput setaf 1)"
- ['green']="$(tput setaf 2)"
- ['yellow']="$(tput setaf 3)"
- ['blue']="$(tput setaf 4)"
- ['magenta']="$(tput setaf 5)"
- ['cyan']="$(tput setaf 6)"
- ['white']="$(tput setaf 7)"
- ['bold']="$(tput bold)"
-)
-COLORS+=( ['debug']="${COLORS['blue']}${COLORS['bold']}")
-COLORS+=( ['warning']="${COLORS['yellow']}")
-COLORS+=( ['error']="${COLORS['red']}" )
-
-COLORS+=( ['highlight']="${COLORS['cyan']}" )
-
-COLORS+=( ['pass']="${COLORS['green']}${COLORS['bold']}")
-COLORS+=( ['fail']="${COLORS['red']}${COLORS['bold']}")
-COLORS+=( ['missing']="${COLORS['yellow']}${COLORS['bold']}")
-
-### Flags
-declare -i FLAG_DEBUG=0
-declare -i FLAG_APPEND_LOG=0
-declare -i FLAG_SILENT=0
-declare -i FLAG_LOADTESTS=0
-declare -i FLAG_APPENDTESTS=0
-
-### Global Variables
-declare -a TESTS=()
-declare FAILURE_LOG_FILE=""
-
-declare SCRIPT_PATH=$(dirname $(readlink $0) 2>/dev/null || dirname $0) # relative
-SCRIPT_PATH="`( cd \"${SCRIPT_PATH}\" && pwd )`" # absolutized and normalized
-if [ -z "${SCRIPT_PATH}" ] ; then
- echo_error "For some reason, the path is not accessible to the script (e.g. permissions re-evaled after suid)"
- exit ${EX_IOERR} # fail
-fi
-
-declare -r PROJECT_PATH="`( cd \"${SCRIPT_PATH}/..\" && pwd )`" # absolutized and normalized
-if [ -z "${PROJECT_PATH}" ] ; then
- echo_error "For some reason, the path is not accessible to the script (e.g. permissions re-evaled after suid)"
- exit ${EX_IOERR} # fail
-fi
-
-declare -r REFERENCE_FILE_PATH="${SCRIPT_PATH}/reference-files"
-declare -r DEFAULT_TESTS_FILE="$SCRIPT_PATH/recipe-dl.tests"
-declare -r DEFAULT_FAILURE_LOG_FILE="${SCRIPT_PATH}/test.failures.log"
-
-declare -i COUNT_PASS=0
-declare -i COUNT_FAIL=0
-declare -i COUNT_SKIP=0
-
-function usage {
- echo "Usage: ${SCRIPT_NAME} [-d] [-h] [-r] [-t ] [-t ] ..."
- if [ $# -eq 0 ] || [ -z "$1" ]; then
- echo " -d|--debug Add additional Output"
- echo " -h|--help Display help"
- echo " -l|--log-file Specifiy Log File (Default: $DEFAULT_FAILURE_LOG_FILE) "
- echo " -a|--append-log Append to existing log."
- echo " -r|--reset-references Instead of tests resets the reference files"
- echo " -t|--test URL to test. Overrides default tests."
- echo " --load-tests load tests from file"
- echo " --append-tests Append manual tests to test file."
- fi
-}
-
-function parse_arguments () {
- TESTS=()
- FAILURE_LOG_FILE=""
- while (( "$#" )); do
- case "$1" in
- -d|--debug)
- FLAG_DEBUG=1
- shift
- ;;
- -h|--help)
- echo_info "$(usage)"
- exit 0
- ;;
- -r|--reset-references)
- reset_references
- shift
- exit 0
- ;;
- -l|--log-file)
- shift
- FAILURE_LOG_FILE="$1"
- shift
- ;;
- -a|--append-log)
- FLAG_APPEND_LOG=1
- shift
- ;;
- -t|--test)
- shift
- TESTS+=("$1|$2")
- shift
- shift
- ;;
- --load-tests)
- shift
- FLAG_LOADTESTS=1
- TESTS_FILE="${1}"
- load_tests "${TESTS_FILE}"
- shift
- ;;
- --append-tests)
- shift
- FLAG_APPENDTESTS=1
- ;;
- -*|--*=) # unsupported flags
- echo_error "ERROR: Unsupported flag $1"
- echo_error "$(usage)"
- exit ${EX_USAGE}
- ;;
- *) # preserve positional arguments
- echo_error "ERROR: Unsupported argument $1"
- echo_error "$(usage)"
- exit ${EX_USAGE}
- ;;
- esac
- done
- if [[ "${FAILURE_LOG_FILE}" == "" ]]; then
- FAILURE_LOG_FILE="${DEFAULT_FAILURE_LOG_FILE}"
- fi
- if [ ${#TESTS[@]} -eq 0 ]; then
- TESTS_FILE="${DEFAULT_TESTS_FILE}"
- load_tests "${TESTS_FILE}"
- fi
-}
-
-function command_exists() {
- command -v "$@" > /dev/null 2>&1
-}
-
-function echo_info() {
- echo "$@" >$(tty)
-}
-
-function echo_debug() {
- if [[ $FLAG_DEBUG -ne 0 ]]; then
- local _BREADCRUMB=$(basename ${SCRIPT_NAME})
- for (( idx=${#FUNCNAME[@]}-2 ; idx>=1 ; idx-- )) ; do
- _BREADCRUMB="${_BREADCRUMB}:${FUNCNAME[idx]}"
- done
- echo_info "[${COLORS['debug']} DEBUG: ${_BREADCRUMB} ${COLORS['normal']}] $@"
- fi
-}
-
-function echo_warning() {
- if [[ $FLAG_SILENT -eq 0 ]]; then
- local _BREADCRUMB=""
- if [[ $FLAG_DEBUG -ne 0 ]]; then
- _BREADCRUMB=$(basename ${SCRIPT_NAME})
- for (( idx=${#FUNCNAME[@]}-1 ; idx>=1 ; idx-- )) ; do
- _BREADCRUMB="${_BREADCRUMB}:${FUNCNAME[idx]}"
- done
- _BREADCRUMB=": ${_BREADCRUMB}"
- fi
- echo_info "[${COLORS['warning']} WARNING${_BREADCRUMB} ${COLORS['normal']}] $@"
- fi
-}
-
-function echo_error() {
- local _BREADCRUMB=""
- if [[ $FLAG_DEBUG -ne 0 ]]; then
- _BREADCRUMB=$(basename ${SCRIPT_NAME})
- for (( idx=${#FUNCNAME[@]}-1 ; idx>=1 ; idx-- )) ; do
- _BREADCRUMB="${_BREADCRUMB}:${FUNCNAME[idx]}"
- done
- _BREADCRUMB=": ${_BREADCRUMB}"
- fi
- echo_info "[${COLORS['error']} ERROR${_BREADCRUMB} ${COLORS['normal']}] $@" >&2
-}
-
-function check_requirements() {
- local MISSING=""
-
- command_exists cmp || MISSING="${MISSING}$(echo ' cmp')"
- command_exists diff || MISSING="${MISSING}$(echo ' diff')"
-
- if [[ -n "${MISSING}" ]]; then
- echo_error "Script requires the following commands which are not installed."
- echo_error "${MISSING}"
- echo_error "Aborting."
-
- exit ${EX_OSFILE}
- fi
-}
-
-function option_from_file() {
- local _REFERENCE_FILE="${1}"
-
- echo_debug "Param: _REFERENCE_FILE=$_REFERENCE_FILE"
- local FILENAME=$(basename -- "$_REFERENCE_FILE")
- local EXTENTION="${FILENAME##*.}"
- #echo_debug "FILENAME=${FILENAME}"
- echo_debug "EXTENTION=${EXTENTION}"
-
- case "${EXTENTION}" in
- rst)
- OPTION="-r"
- ;;
- md)
- OPTION="-m"
- ;;
- json)
- OPTION="-j"
- ;;
- esac
- echo_debug "OPTION=${OPTION}"
- echo ${OPTION}
-}
-
-function load_tests() {
- local _TESTS_FILE=${1:-}
-
- if [ -s "${_TESTS_FILE}" ]; then
- echo_info "Loading tests from file: ${_TESTS_FILE}"
- TESTS=()
- IFS=
- while read -r TEST_LINE; do
- TEST_LINE="$(echo "${TEST_LINE}" | sed 's/\#.*$//g' | sed 's/^[[:space:]]*//g' | sed 's/[[:space:]]*$//g')"
- if [[ "${TEST_LINE}" != "" ]] ; then
- #echo_debug "Adding Test: \"${TEST_LINE}\"" # Not sure why this is not working but is being added to the file 'not a tty'
- TESTS+=("${TEST_LINE}")
- fi
- done < "${_TESTS_FILE}"
- unset IFS
- echo_debug "Loaded ${#TESTS[@]} tests."
- else
- echo_error "Tests File (${_TESTS_FILE}) is missing."
- exit ${EX_NOINPUT}
- fi
- unset _TESTS_FILE
-}
-
-function append_tests() {
- if [ $FLAG_APPENDTESTS -ne 0 ] && [ ${#TESTS[@]} -gt 0 ]; then
- if [ $FLAG_LOADTESTS -ne 0 ]; then
- rm "${TESTS_FILE}" >/dev/null 2>&1
- fi
- for TEST in "${TESTS[@]}"; do
- echo "${TEST}" >> "${TESTS_FILE}"
- done
- fi
-}
-
-function log_failure() {
- local _OPTIONS="${1:-}"
- local _URL="${2}"
- local _REFERENCE_FILE="${3}"
- local _TMP_OUTPUT_FILE="${4}"
-
- local PRINT_WIDTH=80
- echo "$(head -c $[PRINT_WIDTH] < /dev/zero | tr '\0' '=')" >> "${FAILURE_LOG_FILE}"
- echo "Reference File: \"${REFERENCE_FILE_PATH}/${_REFERENCE_FILE}\"" >> "${FAILURE_LOG_FILE}"
- echo "URL: \"${_URL}\"" >> "${FAILURE_LOG_FILE}"
- if [ $FLAG_DEBUG -ne 0 ]; then
- echo "Option used: \"${_OPTIONS}\"" >> "${FAILURE_LOG_FILE}"
- echo "Temp Compare File: ${_TMP_OUTPUT_FILE}" >> "${FAILURE_LOG_FILE}"
- fi
- echo "" >> "${FAILURE_LOG_FILE}"
- echo "Differences detailed below" >> "${FAILURE_LOG_FILE}"
- echo "$(head -c $[PRINT_WIDTH] < /dev/zero | tr '\0' '=')" >> "${FAILURE_LOG_FILE}"
- echo "" >> "${FAILURE_LOG_FILE}"
- diff --ignore-trailing-space --ignore-blank-lines "${REFERENCE_FILE_PATH}/${_REFERENCE_FILE}" "${_TMP_OUTPUT_FILE}" >> "${FAILURE_LOG_FILE}" 2>&1
- echo "" >> "${FAILURE_LOG_FILE}"
- echo "$(head -c $[PRINT_WIDTH] < /dev/zero | tr '\0' '=')" >> "${FAILURE_LOG_FILE}"
-}
-
-function reset_references {
- # Lopp through the tests
- for TEST in "${TESTS[@]}"; do
- local URL=$(cut -d'|' -f1 <<< "${TEST}")
- local REFERENCE_FILE=$(cut -d'|' -f2 <<< "${TEST}")
-
- local OPTION=$(option_from_file "${REFERENCE_FILE}")
- echo_info " Resetting ${REFERENCE_FILE}"
- ${PROJECT_PATH}/recipe-dl/recipe-dl.py ${OPTION} -q -s -o "${REFERENCE_FILE_PATH}/${REFERENCE_FILE}" "${URL}" > /dev/null 2>/dev/null
- unset URL REFERENCE_FILE OPTION
- done
- unset TEST
-}
-
-function run_test() {
- local _URL="${1}"
- local _REFERENCE_FILE="${2:-}"
-
- local OPTION=$(option_from_file "${_REFERENCE_FILE}")
- local TMP_OUTPUT_FILE="$(mktemp ./test.output.XXXXXX)"
- rm "${TMP_OUTPUT_FILE}"
-
- echo_debug "Param: _URL=${_URL}"
- echo_debug "Param: _REFERENCE_FILE=${_REFERENCE_FILE}"
- echo_debug "Value: OPTION=${OPTION}"
- echo_debug "Value: TMP_OUTPUT_FILE=${TMP_OUTPUT_FILE}"
-
- local PRINT_WIDTH=$(tput cols)
- ((PRINT_WIDTH-=10))
- local PRINT_PARAM_WIDTH=$(($PRINT_WIDTH-13))
- local PRINT_OPTIONS=""
- PRINT_OPTIONS=$([ "${OPTION}" != "" ] && [ "${OPTION}" != " " ] && echo " (${OPTION})")
- local PRINT_URL=$(printf '%-'$(($PRINT_PARAM_WIDTH))'s' "${_URL}$PRINT_OPTIONS")
- if [ "${PRINT_URL:$(($PRINT_PARAM_WIDTH-1)):1}" == " " ]; then
- local PRINT_URL=$(printf '%.'$PRINT_PARAM_WIDTH's' "${_URL}${PRINT_OPTIONS}")
- else
- if [ "${PRINT_OPTIONS}" == "" ]; then
- PRINT_URL=$(printf '%.'$(($PRINT_PARAM_WIDTH-3))'s...' "${_URL}")
- else
- PRINT_URL=$(printf '%.'$(($PRINT_PARAM_WIDTH-8))'s...%s' "${_URL}" "${PRINT_OPTIONS}")
- fi
- fi
- printf 'Test: %-'$PRINT_PARAM_WIDTH's ' "${PRINT_URL}"
-
- if [ -s "${REFERENCE_FILE_PATH}/${_REFERENCE_FILE}" ]; then
- ${PROJECT_PATH}/recipe-dl/recipe-dl.py ${OPTION} -q -s -o "${TMP_OUTPUT_FILE}" "${_URL}" > /dev/null 2>/dev/null
-
- local TMP_OUTPUT_FILE_EXT="$(set -- $TMP_OUTPUT_FILE.*; echo "$1")"
- echo_debug "Compare File: \"$TMP_OUTPUT_FILE_EXT\""
-
- if diff --brief --ignore-trailing-space --ignore-blank-lines "${REFERENCE_FILE_PATH}/${_REFERENCE_FILE}" "${TMP_OUTPUT_FILE_EXT}" >/dev/null 2>&1 ; then
- ((COUNT_PASS++))
- echo "[${COLORS['pass']}PASS${COLORS['normal']}]"
- else
- ((COUNT_FAIL++))
- echo "[${COLORS['fail']}FAIL${COLORS['normal']}] see log"
- log_failure "${OPTION}" "${_URL}" "${_REFERENCE_FILE}" "${TMP_OUTPUT_FILE_EXT}"
- fi
- rm "${TMP_OUTPUT_FILE_EXT}" 2>/dev/null
- else
- ((COUNT_SKIP++))
- echo "[${COLORS['missing']}MISSING${COLORS['normal']}]"
- ${PROJECT_PATH}/recipe-dl/recipe-dl.py ${OPTION} -q -s -o "${REFERENCE_FILE_PATH}/${_REFERENCE_FILE}" "${_URL}" > /dev/null 2>/dev/null
- fi
-}
-
-function run_tests() {
- echo_info "Using reference file: ${REFERENCE_FILE_PATH}"
- if [ $FLAG_APPEND_LOG -eq 0 ] && [ ! -s $FLAG_APPEND_LOG ]; then
- echo_info "Failues will be logged to $FAILURE_LOG_FILE"
- rm "$FAILURE_LOG_FILE" 2>/dev/null
- else
- echo_info "Failues will be appended to $FAILURE_LOG_FILE"
- fi
- echo_info ""
- echo_info "Running Tests..."
- echo_info ""
- echo_info "$(head -c $(tput cols) < /dev/zero | tr '\0' '=')"
- echo_info ""
-
- COUNT_PASS=0
- COUNT_FAIL=0
- COUNT_SKIP=0
-
- # Loop through the tests
- for TEST in "${TESTS[@]}"; do
- local URL=$(cut -d'|' -f1 <<< "${TEST}")
- local REFERENCE_FILE=$(cut -d'|' -f2 <<< "${TEST}")
- run_test "${URL}" "${REFERENCE_FILE}"
- unset URL REFERENCE_FILE
- done
- unset TEST
- echo_info ""
- echo_info "$(head -c $(tput cols) < /dev/zero | tr '\0' '=')"
- echo_info ""
- echo_info "Results: ${COUNT_PASS} Passed ${COUNT_FAIL} Failed ${COUNT_SKIP} Skipped "
-}
-
-check_requirements
-parse_arguments "$@"
-run_tests
-append_tests