diff --git a/Makefile b/Makefile index 18581d6..22fe4e0 100644 --- a/Makefile +++ b/Makefile @@ -3,8 +3,8 @@ sdist: doc clean: doc-clean @echo Removing binary files... - @rm -f `find feedgenerator -name '*.pyc'` - @rm -f `find feedgenerator -name '*.pyo'` + @rm -f `find feedgen -name '*.pyc'` + @rm -f `find feedgen -name '*.pyo'` @echo Removing source distribution files... @rm -rf dist/ @rm MANIFEST diff --git a/doc/api.entry.rst b/doc/api.entry.rst index 7ef836d..eab7d2f 100644 --- a/doc/api.entry.rst +++ b/doc/api.entry.rst @@ -3,5 +3,5 @@
Contents
-.. automodule:: feedgenerator.entry +.. automodule:: feedgen.entry :members: diff --git a/doc/api.feed.rst b/doc/api.feed.rst index 1e0f90b..bc165c0 100644 --- a/doc/api.feed.rst +++ b/doc/api.feed.rst @@ -3,5 +3,5 @@
Contents
-.. automodule:: feedgenerator.feed +.. automodule:: feedgen.feed :members: diff --git a/doc/api.podcast.rst b/doc/api.podcast.rst index 909a86e..f3ccc42 100644 --- a/doc/api.podcast.rst +++ b/doc/api.podcast.rst @@ -3,5 +3,5 @@
Contents
-.. automodule:: feedgenerator.podcast +.. automodule:: feedgen.podcast :members: diff --git a/doc/api.podcast_entry.rst b/doc/api.podcast_entry.rst index dd30889..418ef74 100644 --- a/doc/api.podcast_entry.rst +++ b/doc/api.podcast_entry.rst @@ -3,5 +3,5 @@
Contents
-.. automodule:: feedgenerator.podcast_entry +.. automodule:: feedgen.podcast_entry :members: diff --git a/doc/api.rst b/doc/api.rst index eb82557..d4f377c 100644 --- a/doc/api.rst +++ b/doc/api.rst @@ -2,7 +2,7 @@ API Documentation ================= -.. automodule:: feedgenerator +.. automodule:: feedgen :members: Contents: diff --git a/doc/api.util.rst b/doc/api.util.rst index 7b905cf..47747d5 100644 --- a/doc/api.util.rst +++ b/doc/api.util.rst @@ -3,5 +3,5 @@
Contents
-.. automodule:: feedgenerator.util +.. automodule:: feedgen.util :members: diff --git a/doc/conf.py b/doc/conf.py index 37aff67..57479c2 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -37,7 +37,7 @@ source_encoding = 'utf-8-sig' master_doc = 'index' # General information about the project. -project = u'pyFeedGenerator' +project = u'pyFeedGen' copyright = u'2013, Lars Kiesow' # The version info for the project you're documenting, acts as replacement for @@ -164,7 +164,7 @@ html_static_path = ['_static'] #html_file_suffix = None # Output file base name for HTML help builder. -htmlhelp_basename = 'pyFeedGenerator' +htmlhelp_basename = 'pyFeedGen' # -- Options for LaTeX output -------------------------------------------------- @@ -183,7 +183,7 @@ latex_elements = { # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, author, documentclass [howto/manual]). latex_documents = [ - ('index', 'pyFeedGenerator.tex', u'pyFeedGenerator Documentation', + ('index', 'pyFeedGen.tex', u'pyFeedGen Documentation', u'Lars Kiesow', 'manual'), ] @@ -213,7 +213,7 @@ latex_documents = [ # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ - ('index', 'pyFeedGenerator.tex', u'pyFeedGenerator Documentation', + ('index', 'pyFeedGen.tex', u'pyFeedGen Documentation', [u'Lars Kiesow'], 1) ] @@ -227,7 +227,7 @@ man_pages = [ # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ - ('index', 'pyFeedGenerator.tex', u'pyFeedGenerator Documentation', + ('index', 'pyFeedGen.tex', u'pyFeedGen Documentation', u'Lars Kiesow', 'Lernfunk3', 'One line description of project.', 'Miscellaneous'), ] diff --git a/feedgen/__init__.py b/feedgen/__init__.py index db9edca..649c95e 100644 --- a/feedgen/__init__.py +++ b/feedgen/__init__.py @@ -1,8 +1,8 @@ # -*- coding: utf-8 -*- """ - ============= - feedgenerator - ============= + ======= + feedgen + ======= This module can be used to generate web feeds in both ATOM and RSS format. The included PodcastGenerator furthermore includes all of Apples RSS @@ -19,7 +19,7 @@ To create a feed simply instanciate the FeedGenerator class and insert some data:: - >>> from feedgenerator.feed import FeedGenerator + >>> from feedgen.feed import FeedGenerator >>> fg = FeedGenerator() >>> fg.id('http://lernfunk.de/media/654321') >>> fg.title('Some Testfeed') @@ -78,12 +78,12 @@ ----------------- A podcast is an RSS feed with some additional elements for ITunes. The - feedgenerator has a PodcastGenerator class as extension to the default + feedgen has a PodcastGenerator class as extension to the default FeedGenerator which you can use to set these additional fields. To produce a podcast simply do something like this:: - >>> from feedgenerator.podcast import PodcastGenerator + >>> from feedgen.podcast import PodcastGenerator >>> fg = PodcastGenerator() ... >>> fg.podcast_str(pretty=True) @@ -102,6 +102,6 @@ You can test the module by simply executing:: - %> pythom -m feedgenerator + %> pythom -m feedgen """ diff --git a/feedgen/__main__.py b/feedgen/__main__.py index 45ad733..7985161 100644 --- a/feedgen/__main__.py +++ b/feedgen/__main__.py @@ -1,16 +1,16 @@ #!/bin/env python # -*- coding: utf-8 -*- ''' - feedgenerator - ~~~~~~~~~~~~~ + feedgen + ~~~~~~~ :copyright: 2013, Lars Kiesow :license: FreeBSD and LGPL, see license.* for more details. ''' -from feedgenerator.feed import FeedGenerator -from feedgenerator.podcast import PodcastGenerator +from feedgen.feed import FeedGenerator +from feedgen.podcast import PodcastGenerator import sys @@ -21,7 +21,7 @@ if __name__ == '__main__': or sys.argv[1].endswith('atom') \ or sys.argv[1].endswith('podcast') ): print 'Usage: %s ( .atom | atom | .rss | rss | podcast )' % \ - 'pythom -m feedgenerator' + 'pythom -m feedgen' print '' print ' atom -- Generate ATOM test output and print it to stdout.' print ' rss -- Generate RSS test output and print it to stdout.' diff --git a/feedgen/entry.py b/feedgen/entry.py index bc6879d..3394e03 100644 --- a/feedgen/entry.py +++ b/feedgen/entry.py @@ -1,8 +1,8 @@ #!/bin/env python # -*- coding: utf-8 -*- ''' - feedgenerator.entry - ~~~~~~~~~~~~~~~~~~~ + feedgen.entry + ~~~~~~~~~~~~~ :copyright: 2013, Lars Kiesow @@ -13,7 +13,7 @@ from lxml import etree from datetime import datetime import dateutil.parser import dateutil.tz -from feedgenerator.util import ensure_format +from feedgen.util import ensure_format class FeedEntry(object): diff --git a/feedgen/feed.py b/feedgen/feed.py index 88ecef5..72fb9b1 100644 --- a/feedgen/feed.py +++ b/feedgen/feed.py @@ -1,8 +1,8 @@ #!/bin/env python # -*- coding: utf-8 -*- ''' - feedgenerator.feed - ~~~~~~~~~~~~~~~~~~ + feedgen.feed + ~~~~~~~~~~~~ :copyright: 2013, Lars Kiesow @@ -14,8 +14,8 @@ from lxml import etree from datetime import datetime import dateutil.parser import dateutil.tz -from feedgenerator.entry import FeedEntry -from feedgenerator.util import ensure_format +from feedgen.entry import FeedEntry +from feedgen.util import ensure_format class FeedGenerator(object): diff --git a/feedgen/podcast.py b/feedgen/podcast.py index d4ab31a..bb51591 100644 --- a/feedgen/podcast.py +++ b/feedgen/podcast.py @@ -1,10 +1,10 @@ #!/bin/env python # -*- coding: utf-8 -*- ''' - feedgenerator.podcast - ~~~~~~~~~~~~~~~~~~~~~ + feedgen.podcast + ~~~~~~~~~~~~~~~ - Extends the feedgenerator to produce podcasts. + Extends the FeedGenerator to produce podcasts. :copyright: 2013, Lars Kiesow @@ -15,9 +15,9 @@ from lxml import etree from datetime import datetime import dateutil.parser import dateutil.tz -from feedgenerator.feed import FeedGenerator -from feedgenerator.podcast_entry import PodcastEntry -from feedgenerator.util import ensure_format +from feedgen.feed import FeedGenerator +from feedgen.podcast_entry import PodcastEntry +from feedgen.util import ensure_format class PodcastGenerator(FeedGenerator): diff --git a/feedgen/podcast_entry.py b/feedgen/podcast_entry.py index 3782d0e..3c5405b 100644 --- a/feedgen/podcast_entry.py +++ b/feedgen/podcast_entry.py @@ -1,10 +1,10 @@ #!/bin/env python # -*- coding: utf-8 -*- ''' - feedgenerator.podcast_entry - ~~~~~~~~~~~~~~~~~~~~~~~~~~~ + feedgen.podcast_entry + ~~~~~~~~~~~~~~~~~~~~~ - Extends the feedgenerator to produce podcasts. + Extends the feedgen to produce podcasts. :copyright: 2013, Lars Kiesow @@ -15,8 +15,8 @@ from lxml import etree from datetime import datetime import dateutil.parser import dateutil.tz -from feedgenerator.entry import FeedEntry -from feedgenerator.util import ensure_format +from feedgen.entry import FeedEntry +from feedgen.util import ensure_format class PodcastEntry(FeedEntry): diff --git a/feedgen/util.py b/feedgen/util.py index a13477e..f199886 100644 --- a/feedgen/util.py +++ b/feedgen/util.py @@ -1,8 +1,8 @@ #!/bin/env python # -*- coding: utf-8 -*- ''' - feedgenerator.util - ~~~~~~~~~~~~~~~~~~ + feedgen.util + ~~~~~~~~~~~~ This file contains helper functions for the feed generator module. diff --git a/readme.md b/readme.md index ec89f50..4a4a9e2 100644 --- a/readme.md +++ b/readme.md @@ -18,7 +18,7 @@ Create a Feed To create a feed simply instantiate the FeedGenerator class and insert some data:: - >>> from feedgenerator.feed import FeedGenerator + >>> from feedgen.feed import FeedGenerator >>> fg = FeedGenerator() >>> fg.id('http://lernfunk.de/media/654321') >>> fg.title('Some Testfeed') @@ -77,12 +77,12 @@ Produce a Podcast ----------------- A podcast is an RSS feed with some additional elements for ITunes. The -feedgenerator has a PodcastGenerator class as extension to the default +feedgen has a PodcastGenerator class as extension to the default FeedGenerator which you can use to set these additional fields. To produce a podcast simply do something like this:: - >>> from feedgenerator.podcast import PodcastGenerator + >>> from feedgen.podcast import PodcastGenerator >>> fg = PodcastGenerator() ... >>> fg.podcast_str(pretty=True) @@ -101,7 +101,7 @@ Testing the Generator You can test the module by simply executing:: - %> pythom -m feedgenerator + %> pythom -m feedgen If you want to have a look at the code for this test to have a working code example for a whole feed generation process, you can find it in the diff --git a/setup.py b/setup.py index e051e68..f186841 100644 --- a/setup.py +++ b/setup.py @@ -3,8 +3,8 @@ from distutils.core import setup setup( - name = 'feedgenerator', - packages = ['feedgenerator'], + name = 'feedgen', + packages = ['feedgen'], version = '0.1', description = 'Feed Generator (ATOM, RSS, Podcasts)', author = 'Lars Kiesow',