Commits

Ian Lewis  committed 024a99b

Added CHANGES and LICENSE

  • Participants
  • Parent commits c91809e
  • Tags 1.1

Comments (0)

Files changed (6)

+CHANGES
+=======
+
+1.1
+------
+
+- Fixed issues running tests on Django 1.2 and Django 1.5.
+
+1.0
+-------
+
+- Initial Release
+The MIT License (MIT)
+
+Copyright (c) 2012 Ian Lewis
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+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 OR COPYRIGHT HOLDERS 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.
+include README.rst CHANGES.rst LICENSE tests.py

File README

-====================
-django-ical
-====================
-
-django-ical is a simple library/framework for creating `ical
-<http://www.ietf.org/rfc/rfc2445.txt>`_ feeds based in Django's `syndication
-feed framework
-<https://docs.djangoproject.com/en/1.4/ref/contrib/syndication/>`_. This
-documentation is modeled after the documentation for the syndication feed
-framework so you can think of it as a simple extension.
-
-If you are familiar with the Django syndication feed framework you should be
-able to be able to use django-ical fairly quickly. It works the same way as
-the Django syndication framework but adds a few extension properties to
-support iCalendar feeds.
-
-django-ical uses the `icalendar <http://pypi.python.org/pypi/icalendar/>`_ library
-under the hood to generate iCalendar feeds.
-
-Requirements
-===================
-
-* `Django <http://www.djangoproject.com/>`_ >= 1.3
-* `icalendar <http://pypi.python.org/pypi/icalendar/>`_ >= 2.0.1
-
-The high-level framework
-========================
-
-Overview
-------------------------
-
-The high level ical feed-generating is supplied by the :class:`ICalFeed
-<django_ical.views.ICalFeed>` class.  To create a feed, write a
-:class:`ICalFeed <django_ical.views.ICalFeed>` class and point to an instance
-of it in your `URLconf <https://docs.djangoproject.com/en/1.4/topics/http/urls/>`_.
-
-With RSS feeds, the items in the feed represent articles or simple web pages.
-The :class:`ICalFeed <django_ical.views.ICalFeed>` class represents an
-iCalendar calendar. Calendars contain items which are events.
-
-Let's look at a simple example. Here the item_start_datetime is a django-ical
-extension that supplies the start time of the event.
-
-::
-
-    from django_ical.views import ICalFeed
-    from examplecom.models import Event
-
-    class EventFeed(ICalFeed):
-        """
-        A simple event calender
-        """
-        product_id = '-//example.com//Example//EN'
-        timezone = 'UTC'
-
-        def items(self):
-            return Event.objects.all().order_by('-start_datetime')
-
-        def item_title(self, item):
-            return item.title
-
-        def item_description(self, item):
-            return item.description
-        
-        def item_start_datetime(self, item):
-            return item.start_datetime
-
-To connect a URL to this calendar, put an instance of the EventFeed object in
-your URLconf. For example:
-
-::
-
-    from django.conf.urls import patterns, url, include
-    from myproject.feeds import EventFeed
-
-    urlpatterns = patterns('',
-        # ...
-        (r'^latest/feed/$', EventFeed()),
-        # ...
-    )
-
-
-Property Reference and Extensions
---------------------------------------
-
-django-ical adds a number of extensions to the base syndication framework in
-order to support iCalendar feeds and ignores many fields used in RSS feeds.
-Here is a table of all of the fields that django-ical supports.
-
-+-----------------------+-----------------------+-----------------------------+
-| Property name         | iCalendar field name  | Description                 |
-+=======================+=======================+=============================+
-| product_id            | PRODID                | The calendar product ID     |
-+-----------------------+-----------------------+-----------------------------+
-| timezone              | X-WR-TIMEZONE         | The calendar timezone       |
-+-----------------------+-----------------------+-----------------------------+
-| title                 | X-WR-CALNAME          | The calendar name/title     |
-+-----------------------+-----------------------+-----------------------------+
-| description           | X-WR-CALDESC          | The calendar name/title     |
-+-----------------------+-----------------------+-----------------------------+
-| method                | METHOD                | The calendar method such as |
-|                       |                       | meeting requests.           |
-+-----------------------+-----------------------+-----------------------------+
-| item_guid             | UID                   | The event's unique id.      |
-|                       |                       | This id should be           |
-|                       |                       | *globally* unique so you    |
-|                       |                       | should add an               | 
-|                       |                       | @<domain_name> to your id.  |
-+-----------------------+-----------------------+-----------------------------+
-| item_title            | SUMMARY               | The event name/title        |
-+-----------------------+-----------------------+-----------------------------+
-| item_description      | DESCRIPTION           | The event description       |
-+-----------------------+-----------------------+-----------------------------+
-| item_link             | URL                   | The event url               |
-+-----------------------+-----------------------+-----------------------------+
-| item_class            | CLASS                 | The event class             |
-|                       |                       | (e.g. PUBLIC, PRIVATE,      |
-|                       |                       | CONFIDENTIAL)               |
-+-----------------------+-----------------------+-----------------------------+
-| item_created          | CREATED               | The event create time       |
-+-----------------------+-----------------------+-----------------------------+
-| item_modified         | CREATED               | The event modified time     |
-+-----------------------+-----------------------+-----------------------------+
-| item_start_datetime   | DTSTART               | The event start time        |
-+-----------------------+-----------------------+-----------------------------+
-| item_end_datetime     | DTEND                 | The event end time          |
-+-----------------------+-----------------------+-----------------------------+
-| item_location         | LOCATION              | The event lociation         |
-+-----------------------+-----------------------+-----------------------------+
-| item_transparency     | TRANSP                | The event transparency.     |
-|                       |                       | Defines whether the event   |
-|                       |                       | shows up in busy searches.  |
-|                       |                       | (e.g. OPAQUE, TRANSPARENT)  |
-+-----------------------+-----------------------+-----------------------------+
-
-Note:
-
-* django-ical does not use the ``link`` property required by the Django
-  syndication framework.
-
-The low-level framework
-========================
-
-Behind the scenes, the high-level iCalendar framework uses a lower-level
-framework for generating feeds' ical data. This framework lives in a single
-module: :mod:`django_ical.feedgenerator`.
-
-You use this framework on your own, for lower-level feed generation. You can
-also create custom feed generator subclasses for use with the feed_type
-option.
-
-See: `The syndication feed framework: Specifying the type of feed <https://docs.djangoproject.com/en/1.4/ref/contrib/syndication/#specifying-the-type-of-feed>`_
-
+====================
+django-ical
+====================
+
+django-ical is a simple library/framework for creating `ical
+<http://www.ietf.org/rfc/rfc2445.txt>`_ feeds based in Django's `syndication
+feed framework
+<https://docs.djangoproject.com/en/1.4/ref/contrib/syndication/>`_. This
+documentation is modeled after the documentation for the syndication feed
+framework so you can think of it as a simple extension.
+
+If you are familiar with the Django syndication feed framework you should be
+able to be able to use django-ical fairly quickly. It works the same way as
+the Django syndication framework but adds a few extension properties to
+support iCalendar feeds.
+
+django-ical uses the `icalendar <http://pypi.python.org/pypi/icalendar/>`_ library
+under the hood to generate iCalendar feeds.
+
+Requirements
+===================
+
+* `Django <http://www.djangoproject.com/>`_ >= 1.3
+* `icalendar <http://pypi.python.org/pypi/icalendar/>`_ >= 2.0.1
+
+The high-level framework
+========================
+
+Overview
+------------------------
+
+The high level ical feed-generating is supplied by the :class:`ICalFeed
+<django_ical.views.ICalFeed>` class.  To create a feed, write a
+:class:`ICalFeed <django_ical.views.ICalFeed>` class and point to an instance
+of it in your `URLconf <https://docs.djangoproject.com/en/1.4/topics/http/urls/>`_.
+
+With RSS feeds, the items in the feed represent articles or simple web pages.
+The :class:`ICalFeed <django_ical.views.ICalFeed>` class represents an
+iCalendar calendar. Calendars contain items which are events.
+
+Let's look at a simple example. Here the item_start_datetime is a django-ical
+extension that supplies the start time of the event.
+
+::
+
+    from django_ical.views import ICalFeed
+    from examplecom.models import Event
+
+    class EventFeed(ICalFeed):
+        """
+        A simple event calender
+        """
+        product_id = '-//example.com//Example//EN'
+        timezone = 'UTC'
+
+        def items(self):
+            return Event.objects.all().order_by('-start_datetime')
+
+        def item_title(self, item):
+            return item.title
+
+        def item_description(self, item):
+            return item.description
+        
+        def item_start_datetime(self, item):
+            return item.start_datetime
+
+To connect a URL to this calendar, put an instance of the EventFeed object in
+your URLconf. For example:
+
+::
+
+    from django.conf.urls import patterns, url, include
+    from myproject.feeds import EventFeed
+
+    urlpatterns = patterns('',
+        # ...
+        (r'^latest/feed/$', EventFeed()),
+        # ...
+    )
+
+
+Property Reference and Extensions
+--------------------------------------
+
+django-ical adds a number of extensions to the base syndication framework in
+order to support iCalendar feeds and ignores many fields used in RSS feeds.
+Here is a table of all of the fields that django-ical supports.
+
++-----------------------+-----------------------+-----------------------------+
+| Property name         | iCalendar field name  | Description                 |
++=======================+=======================+=============================+
+| product_id            | PRODID                | The calendar product ID     |
++-----------------------+-----------------------+-----------------------------+
+| timezone              | X-WR-TIMEZONE         | The calendar timezone       |
++-----------------------+-----------------------+-----------------------------+
+| title                 | X-WR-CALNAME          | The calendar name/title     |
++-----------------------+-----------------------+-----------------------------+
+| description           | X-WR-CALDESC          | The calendar name/title     |
++-----------------------+-----------------------+-----------------------------+
+| method                | METHOD                | The calendar method such as |
+|                       |                       | meeting requests.           |
++-----------------------+-----------------------+-----------------------------+
+| item_guid             | UID                   | The event's unique id.      |
+|                       |                       | This id should be           |
+|                       |                       | *globally* unique so you    |
+|                       |                       | should add an               | 
+|                       |                       | @<domain_name> to your id.  |
++-----------------------+-----------------------+-----------------------------+
+| item_title            | SUMMARY               | The event name/title        |
++-----------------------+-----------------------+-----------------------------+
+| item_description      | DESCRIPTION           | The event description       |
++-----------------------+-----------------------+-----------------------------+
+| item_link             | URL                   | The event url               |
++-----------------------+-----------------------+-----------------------------+
+| item_class            | CLASS                 | The event class             |
+|                       |                       | (e.g. PUBLIC, PRIVATE,      |
+|                       |                       | CONFIDENTIAL)               |
++-----------------------+-----------------------+-----------------------------+
+| item_created          | CREATED               | The event create time       |
++-----------------------+-----------------------+-----------------------------+
+| item_modified         | CREATED               | The event modified time     |
++-----------------------+-----------------------+-----------------------------+
+| item_start_datetime   | DTSTART               | The event start time        |
++-----------------------+-----------------------+-----------------------------+
+| item_end_datetime     | DTEND                 | The event end time          |
++-----------------------+-----------------------+-----------------------------+
+| item_location         | LOCATION              | The event lociation         |
++-----------------------+-----------------------+-----------------------------+
+| item_transparency     | TRANSP                | The event transparency.     |
+|                       |                       | Defines whether the event   |
+|                       |                       | shows up in busy searches.  |
+|                       |                       | (e.g. OPAQUE, TRANSPARENT)  |
++-----------------------+-----------------------+-----------------------------+
+
+Note:
+
+* django-ical does not use the ``link`` property required by the Django
+  syndication framework.
+
+The low-level framework
+========================
+
+Behind the scenes, the high-level iCalendar framework uses a lower-level
+framework for generating feeds' ical data. This framework lives in a single
+module: :mod:`django_ical.feedgenerator`.
+
+You use this framework on your own, for lower-level feed generation. You can
+also create custom feed generator subclasses for use with the feed_type
+option.
+
+See: `The syndication feed framework: Specifying the type of feed <https://docs.djangoproject.com/en/1.4/ref/contrib/syndication/#specifying-the-type-of-feed>`_
+
  
 setup (
     name='django-ical',
-    version='1.0',
+    version='1.1',
     description="iCal feeds for Django based on Django's syndication feed framework.",
+    long_description=open('README.rst').read() + '\n' + open('CHANGES.rst').read(),
     author='Ian Lewis',
     author_email='IanMLewis@gmail.com',
     license='MIT License',
       'Topic :: Software Development :: Libraries :: Python Modules',
     ],
     install_requires = [
-        'Django>=1.1',
+        'Django>=1.2',
         'icalendar>=2.0.1',
     ],
     packages=find_packages(),