renamed feedgenerator to feedgen

This commit is contained in:
Lars Kiesow 2013-05-04 22:54:43 +02:00
parent e1a5a8e7a0
commit 66f8f3d8e9
17 changed files with 51 additions and 51 deletions

View file

@ -3,8 +3,8 @@ sdist: doc
clean: doc-clean clean: doc-clean
@echo Removing binary files... @echo Removing binary files...
@rm -f `find feedgenerator -name '*.pyc'` @rm -f `find feedgen -name '*.pyc'`
@rm -f `find feedgenerator -name '*.pyo'` @rm -f `find feedgen -name '*.pyo'`
@echo Removing source distribution files... @echo Removing source distribution files...
@rm -rf dist/ @rm -rf dist/
@rm MANIFEST @rm MANIFEST

View file

@ -3,5 +3,5 @@
<div class="apititle"><b>Contents</b></div> <div class="apititle"><b>Contents</b></div>
<div class="apitoc"></div> <div class="apitoc"></div>
.. automodule:: feedgenerator.entry .. automodule:: feedgen.entry
:members: :members:

View file

@ -3,5 +3,5 @@
<div class="apititle"><b>Contents</b></div> <div class="apititle"><b>Contents</b></div>
<div class="apitoc"></div> <div class="apitoc"></div>
.. automodule:: feedgenerator.feed .. automodule:: feedgen.feed
:members: :members:

View file

@ -3,5 +3,5 @@
<div class="apititle"><b>Contents</b></div> <div class="apititle"><b>Contents</b></div>
<div class="apitoc"></div> <div class="apitoc"></div>
.. automodule:: feedgenerator.podcast .. automodule:: feedgen.podcast
:members: :members:

View file

@ -3,5 +3,5 @@
<div class="apititle"><b>Contents</b></div> <div class="apititle"><b>Contents</b></div>
<div class="apitoc"></div> <div class="apitoc"></div>
.. automodule:: feedgenerator.podcast_entry .. automodule:: feedgen.podcast_entry
:members: :members:

View file

@ -2,7 +2,7 @@
API Documentation API Documentation
================= =================
.. automodule:: feedgenerator .. automodule:: feedgen
:members: :members:
Contents: Contents:

View file

@ -3,5 +3,5 @@
<div class="apititle"><b>Contents</b></div> <div class="apititle"><b>Contents</b></div>
<div class="apitoc"></div> <div class="apitoc"></div>
.. automodule:: feedgenerator.util .. automodule:: feedgen.util
:members: :members:

View file

@ -37,7 +37,7 @@ source_encoding = 'utf-8-sig'
master_doc = 'index' master_doc = 'index'
# General information about the project. # General information about the project.
project = u'pyFeedGenerator' project = u'pyFeedGen'
copyright = u'2013, Lars Kiesow' copyright = u'2013, Lars Kiesow'
# The version info for the project you're documenting, acts as replacement for # 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 #html_file_suffix = None
# Output file base name for HTML help builder. # Output file base name for HTML help builder.
htmlhelp_basename = 'pyFeedGenerator' htmlhelp_basename = 'pyFeedGen'
# -- Options for LaTeX output -------------------------------------------------- # -- Options for LaTeX output --------------------------------------------------
@ -183,7 +183,7 @@ latex_elements = {
# Grouping the document tree into LaTeX files. List of tuples # Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass [howto/manual]). # (source start file, target name, title, author, documentclass [howto/manual]).
latex_documents = [ latex_documents = [
('index', 'pyFeedGenerator.tex', u'pyFeedGenerator Documentation', ('index', 'pyFeedGen.tex', u'pyFeedGen Documentation',
u'Lars Kiesow', 'manual'), u'Lars Kiesow', 'manual'),
] ]
@ -213,7 +213,7 @@ latex_documents = [
# One entry per manual page. List of tuples # One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section). # (source start file, name, description, authors, manual section).
man_pages = [ man_pages = [
('index', 'pyFeedGenerator.tex', u'pyFeedGenerator Documentation', ('index', 'pyFeedGen.tex', u'pyFeedGen Documentation',
[u'Lars Kiesow'], 1) [u'Lars Kiesow'], 1)
] ]
@ -227,7 +227,7 @@ man_pages = [
# (source start file, target name, title, author, # (source start file, target name, title, author,
# dir menu entry, description, category) # dir menu entry, description, category)
texinfo_documents = [ texinfo_documents = [
('index', 'pyFeedGenerator.tex', u'pyFeedGenerator Documentation', ('index', 'pyFeedGen.tex', u'pyFeedGen Documentation',
u'Lars Kiesow', 'Lernfunk3', 'One line description of project.', u'Lars Kiesow', 'Lernfunk3', 'One line description of project.',
'Miscellaneous'), 'Miscellaneous'),
] ]

View file

@ -1,8 +1,8 @@
# -*- coding: utf-8 -*- # -*- coding: utf-8 -*-
""" """
============= =======
feedgenerator feedgen
============= =======
This module can be used to generate web feeds in both ATOM and RSS format. This module can be used to generate web feeds in both ATOM and RSS format.
The included PodcastGenerator furthermore includes all of Apples RSS 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 To create a feed simply instanciate the FeedGenerator class and insert some
data:: data::
>>> from feedgenerator.feed import FeedGenerator >>> from feedgen.feed import FeedGenerator
>>> fg = FeedGenerator() >>> fg = FeedGenerator()
>>> fg.id('http://lernfunk.de/media/654321') >>> fg.id('http://lernfunk.de/media/654321')
>>> fg.title('Some Testfeed') >>> fg.title('Some Testfeed')
@ -78,12 +78,12 @@
----------------- -----------------
A podcast is an RSS feed with some additional elements for ITunes. The 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. FeedGenerator which you can use to set these additional fields.
To produce a podcast simply do something like this:: To produce a podcast simply do something like this::
>>> from feedgenerator.podcast import PodcastGenerator >>> from feedgen.podcast import PodcastGenerator
>>> fg = PodcastGenerator() >>> fg = PodcastGenerator()
... ...
>>> fg.podcast_str(pretty=True) >>> fg.podcast_str(pretty=True)
@ -102,6 +102,6 @@
You can test the module by simply executing:: You can test the module by simply executing::
%> pythom -m feedgenerator %> pythom -m feedgen
""" """

View file

@ -1,16 +1,16 @@
#!/bin/env python #!/bin/env python
# -*- coding: utf-8 -*- # -*- coding: utf-8 -*-
''' '''
feedgenerator feedgen
~~~~~~~~~~~~~ ~~~~~~~
:copyright: 2013, Lars Kiesow <lkiesow@uos.de> :copyright: 2013, Lars Kiesow <lkiesow@uos.de>
:license: FreeBSD and LGPL, see license.* for more details. :license: FreeBSD and LGPL, see license.* for more details.
''' '''
from feedgenerator.feed import FeedGenerator from feedgen.feed import FeedGenerator
from feedgenerator.podcast import PodcastGenerator from feedgen.podcast import PodcastGenerator
import sys import sys
@ -21,7 +21,7 @@ if __name__ == '__main__':
or sys.argv[1].endswith('atom') \ or sys.argv[1].endswith('atom') \
or sys.argv[1].endswith('podcast') ): or sys.argv[1].endswith('podcast') ):
print 'Usage: %s ( <file>.atom | atom | <file>.rss | rss | podcast )' % \ print 'Usage: %s ( <file>.atom | atom | <file>.rss | rss | podcast )' % \
'pythom -m feedgenerator' 'pythom -m feedgen'
print '' print ''
print ' atom -- Generate ATOM test output and print it to stdout.' print ' atom -- Generate ATOM test output and print it to stdout.'
print ' rss -- Generate RSS test output and print it to stdout.' print ' rss -- Generate RSS test output and print it to stdout.'

View file

@ -1,8 +1,8 @@
#!/bin/env python #!/bin/env python
# -*- coding: utf-8 -*- # -*- coding: utf-8 -*-
''' '''
feedgenerator.entry feedgen.entry
~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~
:copyright: 2013, Lars Kiesow <lkiesow@uos.de> :copyright: 2013, Lars Kiesow <lkiesow@uos.de>
@ -13,7 +13,7 @@ from lxml import etree
from datetime import datetime from datetime import datetime
import dateutil.parser import dateutil.parser
import dateutil.tz import dateutil.tz
from feedgenerator.util import ensure_format from feedgen.util import ensure_format
class FeedEntry(object): class FeedEntry(object):

View file

@ -1,8 +1,8 @@
#!/bin/env python #!/bin/env python
# -*- coding: utf-8 -*- # -*- coding: utf-8 -*-
''' '''
feedgenerator.feed feedgen.feed
~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~
:copyright: 2013, Lars Kiesow <lkiesow@uos.de> :copyright: 2013, Lars Kiesow <lkiesow@uos.de>
@ -14,8 +14,8 @@ from lxml import etree
from datetime import datetime from datetime import datetime
import dateutil.parser import dateutil.parser
import dateutil.tz import dateutil.tz
from feedgenerator.entry import FeedEntry from feedgen.entry import FeedEntry
from feedgenerator.util import ensure_format from feedgen.util import ensure_format
class FeedGenerator(object): class FeedGenerator(object):

View file

@ -1,10 +1,10 @@
#!/bin/env python #!/bin/env python
# -*- coding: utf-8 -*- # -*- coding: utf-8 -*-
''' '''
feedgenerator.podcast feedgen.podcast
~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~
Extends the feedgenerator to produce podcasts. Extends the FeedGenerator to produce podcasts.
:copyright: 2013, Lars Kiesow <lkiesow@uos.de> :copyright: 2013, Lars Kiesow <lkiesow@uos.de>
@ -15,9 +15,9 @@ from lxml import etree
from datetime import datetime from datetime import datetime
import dateutil.parser import dateutil.parser
import dateutil.tz import dateutil.tz
from feedgenerator.feed import FeedGenerator from feedgen.feed import FeedGenerator
from feedgenerator.podcast_entry import PodcastEntry from feedgen.podcast_entry import PodcastEntry
from feedgenerator.util import ensure_format from feedgen.util import ensure_format
class PodcastGenerator(FeedGenerator): class PodcastGenerator(FeedGenerator):

View file

@ -1,10 +1,10 @@
#!/bin/env python #!/bin/env python
# -*- coding: utf-8 -*- # -*- 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 <lkiesow@uos.de> :copyright: 2013, Lars Kiesow <lkiesow@uos.de>
@ -15,8 +15,8 @@ from lxml import etree
from datetime import datetime from datetime import datetime
import dateutil.parser import dateutil.parser
import dateutil.tz import dateutil.tz
from feedgenerator.entry import FeedEntry from feedgen.entry import FeedEntry
from feedgenerator.util import ensure_format from feedgen.util import ensure_format
class PodcastEntry(FeedEntry): class PodcastEntry(FeedEntry):

View file

@ -1,8 +1,8 @@
#!/bin/env python #!/bin/env python
# -*- coding: utf-8 -*- # -*- coding: utf-8 -*-
''' '''
feedgenerator.util feedgen.util
~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~
This file contains helper functions for the feed generator module. This file contains helper functions for the feed generator module.

View file

@ -18,7 +18,7 @@ Create a Feed
To create a feed simply instantiate the FeedGenerator class and insert some To create a feed simply instantiate the FeedGenerator class and insert some
data:: data::
>>> from feedgenerator.feed import FeedGenerator >>> from feedgen.feed import FeedGenerator
>>> fg = FeedGenerator() >>> fg = FeedGenerator()
>>> fg.id('http://lernfunk.de/media/654321') >>> fg.id('http://lernfunk.de/media/654321')
>>> fg.title('Some Testfeed') >>> fg.title('Some Testfeed')
@ -77,12 +77,12 @@ Produce a Podcast
----------------- -----------------
A podcast is an RSS feed with some additional elements for ITunes. The 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. FeedGenerator which you can use to set these additional fields.
To produce a podcast simply do something like this:: To produce a podcast simply do something like this::
>>> from feedgenerator.podcast import PodcastGenerator >>> from feedgen.podcast import PodcastGenerator
>>> fg = PodcastGenerator() >>> fg = PodcastGenerator()
... ...
>>> fg.podcast_str(pretty=True) >>> fg.podcast_str(pretty=True)
@ -101,7 +101,7 @@ Testing the Generator
You can test the module by simply executing:: 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 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 example for a whole feed generation process, you can find it in the

View file

@ -3,8 +3,8 @@
from distutils.core import setup from distutils.core import setup
setup( setup(
name = 'feedgenerator', name = 'feedgen',
packages = ['feedgenerator'], packages = ['feedgen'],
version = '0.1', version = '0.1',
description = 'Feed Generator (ATOM, RSS, Podcasts)', description = 'Feed Generator (ATOM, RSS, Podcasts)',
author = 'Lars Kiesow', author = 'Lars Kiesow',