diff --git a/Makefile b/Makefile index a1d45ba..cf2686d 100644 --- a/Makefile +++ b/Makefile @@ -1,3 +1,6 @@ +# Modified work Copyright 2016, Thorben Dahl +# See license.* for more details + sdist: doc python setup.py sdist diff --git a/doc/conf.py b/doc/conf.py index 37953c4..dbdafcb 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -45,7 +45,7 @@ # General information about the project. project = u'PodGen' -copyright = u'2014, Lars Kiesow and 2016, Thorben Dahl' +copyright = u'2014, Lars Kiesow. Modified work © 2016, Thorben Dahl' # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the diff --git a/license.bsd b/license.bsd index a8e1879..f328eee 100644 --- a/license.bsd +++ b/license.bsd @@ -2,6 +2,8 @@ Copyright 2011 Lars Kiesow. All rights reserved. http://www.larskiesow.de +Modified work Copyright 2016 Thorben Dahl. All rights reserved. + Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: diff --git a/podgen/__init__.py b/podgen/__init__.py index 8b0bfe0..4c041e3 100644 --- a/podgen/__init__.py +++ b/podgen/__init__.py @@ -1,4 +1,15 @@ # -*- coding: utf-8 -*- +""" + podgen + ~~~~~~ + + Package which makes it easy to generate podcast RSS using Python. + + See the official documentation at https://podgen.readthedocs.org + + :copyright: 2016, Thorben Dahl + :license: FreeBSD and LGPL, see license.* for more details. +""" from .podcast import Podcast from .episode import Episode from .media import Media diff --git a/podgen/__main__.py b/podgen/__main__.py index fce63c0..cc6a948 100644 --- a/podgen/__main__.py +++ b/podgen/__main__.py @@ -1,10 +1,10 @@ # -*- coding: utf-8 -*- ''' podgen - ~~~~~~~ - - :copyright: 2013, Lars Kiesow + ~~~~~~ + :copyright: 2013, Lars Kiesow and 2016, Thorben Dahl + :license: FreeBSD and LGPL, see license.* for more details. ''' diff --git a/podgen/category.py b/podgen/category.py index 2d18b32..d236c99 100644 --- a/podgen/category.py +++ b/podgen/category.py @@ -1,3 +1,13 @@ +# -*- coding: utf-8 -*- +""" + podgen.category + ~~~~~~~~~~~~~~~ + + This module contains Category, which represents a single iTunes category. + + :copyright: 2016, Thorben Dahl + :license: FreeBSD and LGPL, see license.* for more details. +""" class Category(object): """Immutable class representing an iTunes category. diff --git a/podgen/episode.py b/podgen/episode.py index baeede5..2db4381 100644 --- a/podgen/episode.py +++ b/podgen/episode.py @@ -1,9 +1,10 @@ # -*- coding: utf-8 -*- """ - podgen.entry - ~~~~~~~~~~~~~ + podgen.episode + ~~~~~~~~~~~~~~ - :copyright: 2013, Lars Kiesow + :copyright: 2013, Lars Kiesow and 2016, Thorben Dahl + :license: FreeBSD and LGPL, see license.* for more details. """ diff --git a/podgen/media.py b/podgen/media.py index 558bc2f..4a18bde 100644 --- a/podgen/media.py +++ b/podgen/media.py @@ -1,3 +1,14 @@ +# -*- coding: utf-8 -*- +""" + podgen.media + ~~~~~~~~~~~~ + + This file contains the Media class, which represents a pointer to a media + file. + + :copyright: 2016, Thorben Dahl + :license: FreeBSD and LGPL, see license.* for more details. +""" import warnings from future.moves.urllib.parse import urlparse import datetime diff --git a/podgen/not_supported_by_itunes_warning.py b/podgen/not_supported_by_itunes_warning.py index 7c5f8ad..76fa011 100644 --- a/podgen/not_supported_by_itunes_warning.py +++ b/podgen/not_supported_by_itunes_warning.py @@ -1,2 +1,13 @@ +# -*- coding: utf-8 -*- +""" + podgen.not_supported_by_itunes_warning + ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + + This file contains the NotSupportedByItunesWarning, which is used when the + library is used in a way that is not compatible with iTunes. + + :copyright: 2016, Thorben Dahl + :license: FreeBSD and LGPL, see license.* for more details. +""" class NotSupportedByItunesWarning(UserWarning): pass diff --git a/podgen/person.py b/podgen/person.py index 9100ec6..50929d5 100644 --- a/podgen/person.py +++ b/podgen/person.py @@ -1,3 +1,14 @@ +# -*- coding: utf-8 -*- +""" + podgen.person + ~~~~~~~~~~~~~ + + This file contains the Person class, which is used to represent a person or + an entity. + + :copyright: 2016, Thorben Dahl + :license: FreeBSD and LGPL, see license.* for more details. +""" class Person(object): """Data-oriented class representing a single person or entity. diff --git a/podgen/podcast.py b/podgen/podcast.py index 87c1c79..8dc077c 100644 --- a/podgen/podcast.py +++ b/podgen/podcast.py @@ -3,7 +3,8 @@ podgen.feed ~~~~~~~~~~~~ - :copyright: 2013, Lars Kiesow + :copyright: 2013, Lars Kiesow and 2016, Thorben Dahl + :license: FreeBSD and LGPL, see license.* for more details. diff --git a/podgen/tests/test_category.py b/podgen/tests/test_category.py index 1af4ad6..75476e2 100644 --- a/podgen/tests/test_category.py +++ b/podgen/tests/test_category.py @@ -1,3 +1,13 @@ +# -*- coding: utf-8 -*- +""" + podgen.tests.test_category + ~~~~~~~~~~~~~~~~~~~~~~~~~~ + + Module for testing the Category class. + + :copyright: 2016, Thorben Dahl + :license: FreeBSD and LGPL, see license.* for more details. +""" import unittest from podgen import Category diff --git a/podgen/tests/test_episode.py b/podgen/tests/test_episode.py index 7c9082e..538032f 100644 --- a/podgen/tests/test_episode.py +++ b/podgen/tests/test_episode.py @@ -1,9 +1,12 @@ # -*- coding: utf-8 -*- - """ -Tests for a basic entry + podgen.tests.test_episode + ~~~~~~~~~~~~~~~~~~~~~~~~~ + + Test the Episode class. -These are test cases for a basic entry. + :copyright: 2016, Thorben Dahl + :license: FreeBSD and LGPL, see license.* for more details. """ import unittest diff --git a/podgen/tests/test_media.py b/podgen/tests/test_media.py index d0f8ce4..5d25801 100644 --- a/podgen/tests/test_media.py +++ b/podgen/tests/test_media.py @@ -1,3 +1,13 @@ +# -*- coding: utf-8 -*- +""" + podgen.tests.test_media + ~~~~~~~~~~~~~~~~~~~~~~~ + + Test the Media class, which represents a pointer to a media file. + + :copyright: 2016, Thorben Dahl + :license: FreeBSD and LGPL, see license.* for more details. +""" from future.utils import iteritems import unittest import warnings diff --git a/podgen/tests/test_person.py b/podgen/tests/test_person.py index 430203c..7e5d49d 100644 --- a/podgen/tests/test_person.py +++ b/podgen/tests/test_person.py @@ -1,3 +1,13 @@ +# -*- coding: utf-8 -*- +""" + podgen.tests.test_person + ~~~~~~~~~~~~~~~~~~~~~~~~ + + Test the Person class, which represents a person or an entity. + + :copyright: 2016, Thorben Dahl + :license: FreeBSD and LGPL, see license.* for more details. +""" import unittest from podgen import Person diff --git a/podgen/tests/test_podcast.py b/podgen/tests/test_podcast.py index a0faf5c..3db631c 100644 --- a/podgen/tests/test_podcast.py +++ b/podgen/tests/test_podcast.py @@ -1,10 +1,12 @@ # -*- coding: utf-8 -*- - """ -Tests for a basic feed + podgen.tests.test_podcast + ~~~~~~~~~~~~~~~~~~~~~~~~~ + + Test the Podcast alone, without any Episode objects. -These are test cases for a basic feed. -A basic feed does not contain entries so far. + :copyright: 2016, Thorben Dahl + :license: FreeBSD and LGPL, see license.* for more details. """ import unittest diff --git a/podgen/tests/test_util.py b/podgen/tests/test_util.py index 61c5562..1c9b4eb 100644 --- a/podgen/tests/test_util.py +++ b/podgen/tests/test_util.py @@ -1,3 +1,13 @@ +# -*- coding: utf-8 -*- +""" + podgen.tests.test_util + ~~~~~~~~~~~~~~~~~~~~~~ + + Test some of the functions found in the util module. + + :copyright: 2016, Thorben Dahl + :license: FreeBSD and LGPL, see license.* for more details. +""" import unittest from podgen import util diff --git a/podgen/util.py b/podgen/util.py index 196eb39..27c29a5 100644 --- a/podgen/util.py +++ b/podgen/util.py @@ -5,7 +5,8 @@ This file contains helper functions for the feed generator module. - :copyright: 2013, Lars Kiesow + :copyright: 2013, Lars Kiesow and 2016, Thorben Dahl + :license: FreeBSD and LGPL, see license.* for more details. """ import sys, locale diff --git a/podgen/version.py b/podgen/version.py index ccacf85..2e88cfe 100644 --- a/podgen/version.py +++ b/podgen/version.py @@ -3,7 +3,8 @@ podgen.version ~~~~~~~~~~~~~~~ - :copyright: 2013-2015, Lars Kiesow + :copyright: 2013-2015, Lars Kiesow and 2016, Thorben Dahl + :license: FreeBSD and LGPL, see license.* for more details.