Create ytdl2rss

This is the initial version of ytdl2rss, a script for converting
youtube-dl metadata into podcast RSS.

Use the Unlicense to match youtube-dl for easier code sharing.

Signed-off-by: Kevin Locke <kevin@kevinlocke.name>

LICENSE.txt

@@ -1,121 +1,24 @@
-Creative Commons Legal Code
-
-CC0 1.0 Universal
-
- CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE
- LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN
- ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS
- INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES
- REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS
- PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM
- THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED
- HEREUNDER.
-
-Statement of Purpose
-
-The laws of most jurisdictions throughout the world automatically confer
-exclusive Copyright and Related Rights (defined below) upon the creator
-and subsequent owner(s) (each and all, an "owner") of an original work of
-authorship and/or a database (each, a "Work").
-
-Certain owners wish to permanently relinquish those rights to a Work for
-the purpose of contributing to a commons of creative, cultural and
-scientific works ("Commons") that the public can reliably and without fear
-of later claims of infringement build upon, modify, incorporate in other
-works, reuse and redistribute as freely as possible in any form whatsoever
-and for any purposes, including without limitation commercial purposes.
-These owners may contribute to the Commons to promote the ideal of a free
-culture and the further production of creative, cultural and scientific
-works, or to gain reputation or greater distribution for their Work in
-part through the use and efforts of others.
-
-For these and/or other purposes and motivations, and without any
-expectation of additional consideration or compensation, the person
-associating CC0 with a Work (the "Affirmer"), to the extent that he or she
-is an owner of Copyright and Related Rights in the Work, voluntarily
-elects to apply CC0 to the Work and publicly distribute the Work under its
-terms, with knowledge of his or her Copyright and Related Rights in the
-Work and the meaning and intended legal effect of CC0 on those rights.
-
-1. Copyright and Related Rights. A Work made available under CC0 may be
-protected by copyright and related or neighboring rights ("Copyright and
-Related Rights"). Copyright and Related Rights include, but are not
-limited to, the following:
-
- i. the right to reproduce, adapt, distribute, perform, display,
- communicate, and translate a Work;
- ii. moral rights retained by the original author(s) and/or performer(s);
-iii. publicity and privacy rights pertaining to a person's image or
- likeness depicted in a Work;
- iv. rights protecting against unfair competition in regards to a Work,
- subject to the limitations in paragraph 4(a), below;
- v. rights protecting the extraction, dissemination, use and reuse of data
- in a Work;
- vi. database rights (such as those arising under Directive 96/9/EC of the
- European Parliament and of the Council of 11 March 1996 on the legal
- protection of databases, and under any national implementation
- thereof, including any amended or successor version of such
- directive); and
-vii. other similar, equivalent or corresponding rights throughout the
- world based on applicable law or treaty, and any national
- implementations thereof.
-
-2. Waiver. To the greatest extent permitted by, but not in contravention
-of, applicable law, Affirmer hereby overtly, fully, permanently,
-irrevocably and unconditionally waives, abandons, and surrenders all of
-Affirmer's Copyright and Related Rights and associated claims and causes
-of action, whether now known or unknown (including existing as well as
-future claims and causes of action), in the Work (i) in all territories
-worldwide, (ii) for the maximum duration provided by applicable law or
-treaty (including future time extensions), (iii) in any current or future
-medium and for any number of copies, and (iv) for any purpose whatsoever,
-including without limitation commercial, advertising or promotional
-purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each
-member of the public at large and to the detriment of Affirmer's heirs and
-successors, fully intending that such Waiver shall not be subject to
-revocation, rescission, cancellation, termination, or any other legal or
-equitable action to disrupt the quiet enjoyment of the Work by the public
-as contemplated by Affirmer's express Statement of Purpose.
-
-3. Public License Fallback. Should any part of the Waiver for any reason
-be judged legally invalid or ineffective under applicable law, then the
-Waiver shall be preserved to the maximum extent permitted taking into
-account Affirmer's express Statement of Purpose. In addition, to the
-extent the Waiver is so judged Affirmer hereby grants to each affected
-person a royalty-free, non transferable, non sublicensable, non exclusive,
-irrevocable and unconditional license to exercise Affirmer's Copyright and
-Related Rights in the Work (i) in all territories worldwide, (ii) for the
-maximum duration provided by applicable law or treaty (including future
-time extensions), (iii) in any current or future medium and for any number
-of copies, and (iv) for any purpose whatsoever, including without
-limitation commercial, advertising or promotional purposes (the
-"License"). The License shall be deemed effective as of the date CC0 was
-applied by Affirmer to the Work. Should any part of the License for any
-reason be judged legally invalid or ineffective under applicable law, such
-partial invalidity or ineffectiveness shall not invalidate the remainder
-of the License, and in such case Affirmer hereby affirms that he or she
-will not (i) exercise any of his or her remaining Copyright and Related
-Rights in the Work or (ii) assert any associated claims and causes of
-action with respect to the Work, in either case contrary to Affirmer's
-express Statement of Purpose.
-
-4. Limitations and Disclaimers.
-
- a. No trademark or patent rights held by Affirmer are waived, abandoned,
- surrendered, licensed or otherwise affected by this document.
- b. Affirmer offers the Work as-is and makes no representations or
- warranties of any kind concerning the Work, express, implied,
- statutory or otherwise, including without limitation warranties of
- title, merchantability, fitness for a particular purpose, non
- infringement, or the absence of latent or other defects, accuracy, or
- the present or absence of errors, whether or not discoverable, all to
- the greatest extent permissible under applicable law.
- c. Affirmer disclaims responsibility for clearing rights of other persons
- that may apply to the Work or any use thereof, including without
- limitation any person's Copyright and Related Rights in the Work.
- Further, Affirmer disclaims responsibility for obtaining any necessary
- consents, permissions or other rights required for any use of the
- Work.
- d. Affirmer understands and acknowledges that Creative Commons is not a
- party to this document and has no duty or obligation with respect to
- this CC0 or use of the Work.
+This is free and unencumbered software released into the public domain.
+
+Anyone is free to copy, modify, publish, use, compile, sell, or
+distribute this software, either in source code form or as a compiled
+binary, for any purpose, commercial or non-commercial, and by any
+means.
+
+In jurisdictions that recognize copyright laws, the author or authors
+of this software dedicate any and all copyright interest in the
+software to the public domain. We make this dedication for the benefit
+of the public at large and to the detriment of our heirs and
+successors. We intend this dedication to be an overt act of
+relinquishment in perpetuity of all present and future rights to this
+software under copyright law.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
+OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.
+
+For more information, please refer to <http://unlicense.org/>

docs/cli.rst

@@ -3,6 +3,6 @@ Command Line Interface
 ======================
 
 .. argparse::
- :module: packagename.cli
+ :module: ytdl2rss
  :func: _build_argument_parser
- :prog: packagename
+ :prog: ytdl2rss

docs/conf.py

@@ -19,7 +19,7 @@
 except ImportError:
  from ConfigParser import ConfigParser
 
-# Add parent dir to path for importing __version__ from packagename below
+# Add parent dir to path for importing __version__ from ytdl2rss below
 _project_path = os.path.dirname(os.path.dirname(os.path.realpath(__file__)))
 sys.path.insert(0, os.path.join(_project_path, 'src'))
 
@@ -45,7 +45,7 @@
 
 # The full version, including alpha/beta/rc tags
 # pylint: disable=import-error
-from packagename import __version__ as release # noqa: E402
+from ytdl2rss import __version__ as release # noqa: E402
 
 # pylint: enable=import-error
 
@@ -139,7 +139,7 @@
 # -- Options for HTMLHelp output ---------------------------------------------
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'python-project-templatedoc'
+htmlhelp_basename = 'ytdl2rssdoc'
 
 
 # -- Options for LaTeX output ------------------------------------------------
@@ -168,8 +168,8 @@
 latex_documents = [
  (
  master_doc,
- 'python-project-template.tex',
- 'python-project-template Documentation',
+ 'ytdl2rss.tex',
+ 'ytdl2rss Documentation',
  'Kevin Locke \\textless{}kevin@kevinlocke.name\\textgreater{}',
  'manual',
  )
@@ -183,8 +183,8 @@
 man_pages = [
  (
  master_doc,
- 'python-project-template',
- 'python-project-template Documentation',
+ 'ytdl2rss',
+ 'ytdl2rss Documentation',
  [author],
  1,
  )
@@ -199,10 +199,10 @@
 texinfo_documents = [
  (
  master_doc,
- 'python-project-template',
- 'python-project-template Documentation',
+ 'ytdl2rss',
+ 'ytdl2rss Documentation',
  author,
- 'python-project-template',
+ 'ytdl2rss',
  'One line description of project.',
  'Miscellaneous',
  )

docs/index.rst

@@ -11,8 +11,8 @@ Documentation Contents
  cli
  api/modules
  contributing
- Issue Tracker <https://github.com/kevinoid/python-project-template/issues>
- License <https://github.com/kevinoid/python-project-template/raw/master/LICENSE.txt>
+ Issue Tracker <https://github.com/kevinoid/ytdl2rss/issues>
+ License <https://github.com/kevinoid/ytdl2rss/raw/master/LICENSE.txt>
 
 
 Indices and Tables

setup.cfg

@@ -2,11 +2,11 @@
 # https://setuptools.readthedocs.io/en/latest/setuptools.html#configuring-setup-using-setup-cfg-files
 
 [metadata]
-name = python-project-template
+name = ytdl2rss
 # Human "friendly" project name for sphinx and other non-setup uses
-friendly_name = Python Project Template
-version = attr: packagename.__version__
-description = Short description of this package and its purpose.
+friendly_name = ytdl2rss
+version = attr: ytdl2rss.__version__
+description = Create podcast RSS from youtube-dl info JSON.
 long_description = file: README.rst
 # Note: license is only needed for deviations/exceptions to License classifier
 # https://packaging.python.org/guides/distributing-packages-using-setuptools/?highlight=keywords#license
@@ -17,17 +17,17 @@ author = Kevin Locke
 author_email = kevin@kevinlocke.name
 # Copyright statement for sphinx and other non-setup uses
 copyright = Copyright 2019-2020 Kevin Locke <kevin@kevinlocke.name>
-url = https://github.com/kevinoid/python-project-template
+url = https://github.com/kevinoid/ytdl2rss
 # Project URLs for specific purposes
 # https://packaging.python.org/guides/distributing-packages-using-setuptools/?highlight=keywords#project-urls
 project_urls =
- Source = https://github.com/kevinoid/python-project-template
- Tracker = https://github.com/kevinoid/python-project-template/issues
+ Source = https://github.com/kevinoid/ytdl2rss
+ Tracker = https://github.com/kevinoid/ytdl2rss/issues
 # From PyPI classifiers list: https://pypi.org/classifiers/
 classifiers =
  Development Status :: 3 - Alpha
- Intended Audience :: Developers
- License :: CC0 1.0 Universal (CC0 1.0) Public Domain Dedication
+ Environment :: Console
+ License :: Public Domain
  Operating System :: OS Independent
  Programming Language :: Python
  Programming Language :: Python :: 2
@@ -38,22 +38,22 @@ classifiers =
  Programming Language :: Python :: 3.6
  Programming Language :: Python :: 3.7
  Programming Language :: Python :: 3.8
- Topic :: Software Development
+ Topic :: Multimedia :: Sound/Audio
+ Topic :: Multimedia :: Video
 # (Optional) Additional keywords used to assist searching.
-keywords = sample setuptools development
+keywords = podcast rss youtube youtube-dl
 
 [options]
 zip_safe = True
-include_package_data = True
 package_dir =
  = src
 # Use packages for directories, py_modules for single-file modules
 # See https://packaging.python.org/guides/distributing-packages-using-setuptools/#packages
-# py_modules = packagename
-packages = find:
+py_modules = ytdl2rss
+# packages = find:
 # Generate a CLI script for a named entry point
 console_scripts =
- packagename = packagename:main
+ ytdl2rss = ytdl2rss:main
 # Note: install_requires and tests_require from requirements*.in by setup.py
 
 [options.packages.find]
@@ -67,11 +67,6 @@ universal = true
 [aliases]
 test = pytest
 
-# Additional data files to include in the package
-# https://setuptools.readthedocs.io/en/latest/setuptools.html#including-data-files
-[options.package_data]
-packagename = *.dat
-
 [coverage:run]
 branch = True
 omit =
@@ -101,7 +96,7 @@ per-file-ignores =
  test_*.py:D101,D102,D103,D105,D107
 
 [isort]
-known_first_party = packagename
+known_first_party = ytdl2rss
 # __init__.py is ignored by default. Un-ignore it.
 # See https://github.com/timothycrosley/isort/issues/690
 not_skip = __init__.py
@@ -123,6 +118,6 @@ add_select = D
 add_ignore = D203,D212
 
 [tool:pytest]
-addopts = --cov=packagename
+addopts = --cov=ytdl2rss
 
 # vim: set ft=dosini :

setup.py

@@ -1,5 +1,5 @@
 #!/usr/bin/env python3
-# This file is part of packagename <https://github.com/kevinoid/packagename>
+# This file is part of ytdl2rss <https://github.com/kevinoid/ytdl2rss>
 # Made available under CC0 1.0 Universal, see LICENSE.txt
 # Copyright 2019-2020 Kevin Locke <kevin@kevinlocke.name>
 """