Skip to content

Commit

Permalink
- moved change log entries to CHANGES.txt
Browse files Browse the repository at this point in the history
- fixed typos in README.txt
- dropped test dependency on zope.app.testing
- include CHANGES.txt in long_description
  • Loading branch information
Michael Howitz committed Oct 2, 2010
1 parent d15282a commit b2f0edf
Show file tree
Hide file tree
Showing 4 changed files with 39 additions and 44 deletions.
22 changes: 14 additions & 8 deletions CHANGES.txt
Original file line number Diff line number Diff line change
@@ -1,21 +1,27 @@

=======
CHANGES
=======

1.1 (unreleased)
----------------
================

* Removed test dependency on `zope.app.testing`.

* ...

1.0 (2007-12-06)
----------------
================

* Updated dependency to zope.session instead of zope.app.session to get rid of
* Updated dependency to `zope.session` instead of `zope.app.session` to get rid of
deprecation warnings.


Before 1.0
----------
1.0b2 (2007-09-12)
==================

* Bugfix: When there was more than one message in a source not all messages
would be returned by the receiver.

1.0b1 (2007-08-22)
==================

No changes were tracked.
* Initial public release.
19 changes: 13 additions & 6 deletions setup.py
Original file line number Diff line number Diff line change
@@ -1,19 +1,24 @@
import os.path
from setuptools import setup, find_packages

def read(*path_elements):
return "\n\n" + file(os.path.join(*path_elements)).read()


setup(
name = "z3c.flashmessage",
version = "1.1dev",
author = "Jasper Op de Coul, Christian Theune",
author_email = "jasper@infrae.com, ct@gocept.com",
description = "A package for sending `flash messages` to users.",
long_description=file(os.path.join(
os.path.dirname(__file__), 'src', 'z3c', 'flashmessage',
'README.txt')).read(),
long_description=(
'.. contents::\n\n' +
read('src', 'z3c', 'flashmessage', 'README.txt') +
read('CHANGES.txt')
),
url = 'http://pypi.python.org/pypi/z3c.flashmessage/',
license = "ZPL 2.1",
keywords = "zope3",
keywords = "zope3 message zope session",
zip_safe=False,
packages = find_packages('src'),
include_package_data = True,
Expand All @@ -25,6 +30,8 @@
'zope.component',
'zope.session',
'zope.security'],
extras_require=dict(test=['zope.app.testing',
'zope.app.zcmlfiles'])
extras_require=dict(test=[
'zope.app.zcmlfiles',
'zope.testing',
])
)
16 changes: 3 additions & 13 deletions src/z3c/flashmessage/README.txt
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ Global receiver
There is a global receiver that queries all message sources that are set up as
utilities. Let's set up a session message source as a utility:

>>> from zope.component import provideUtility
>>> from zope.component import provideUtility
>>> provideUtility(source)
>>> source.send(u'Test!')

Expand Down Expand Up @@ -116,8 +116,8 @@ views, and conflict errors under heavy load.

One solution is to configure your system to store flashmessages in
RAM. You would do this by configuring a utility providing
z3c.flashmessages.interfaces.IMessageSource with the factory set to
z3c.flashmessages.sources.RAMMessageSource, and a specific name if
``z3c.flashmessage.interfaces.IMessageSource`` with the factory set to
``z3c.flashmessage.sources.RAMMessageSource``, and a specific name if
your application expects one.

RAM storage is much faster and removes the persistence issues
Expand All @@ -128,13 +128,3 @@ servers using e.g. ZEO, you must also ensure that your load-balancer
supports session affinity (so a specific client always hits the same
back end server). This somewhat reduces the performance benefits of
clustering.


Changes
=======

1.0b2
-----

* Bugfix: When there was more than one message in a source not all messages
would be returned by the receiver.
26 changes: 9 additions & 17 deletions src/z3c/flashmessage/tests.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,18 +4,14 @@
# $Id$
"""Test harness"""

import unittest
import doctest
import os

from zope.app.testing.functional import FunctionalDocFileSuite, ZCMLLayer
import zope.security.management
import z3c.flashmessage
import zope.app.wsgi.testlayer
import zope.publisher.browser
import zope.security.management


FlashMessageLayer = ZCMLLayer(
os.path.join(os.path.dirname(__file__), 'ftesting.zcml'),
__name__, 'FlashMessageLayer', allow_teardown=True)
FlashMessageLayer = zope.app.wsgi.testlayer.BrowserLayer(z3c.flashmessage)


def setUp(test):
Expand All @@ -24,15 +20,11 @@ def setUp(test):
interaction = zope.security.management.getInteraction()
interaction.add(request)

def tearDown(test):
pass

def test_suite():
suite = unittest.TestSuite()
test = FunctionalDocFileSuite('README.txt',
optionflags=doctest.ELLIPSIS,
setUp=setUp,
tearDown=tearDown)
test.layer = FlashMessageLayer
suite.addTest(test)
suite = doctest.DocFileSuite(
'README.txt',
optionflags=doctest.ELLIPSIS,
setUp=setUp)
suite.layer = FlashMessageLayer
return suite

0 comments on commit b2f0edf

Please sign in to comment.