Permalink
Browse files

added barebone project structure

  • Loading branch information...
1 parent 4ed3dfc commit 36d292558168f07dd518eb60a6b3b0b10b088706 @stefanfoulis committed Jul 12, 2011
Showing with 75 additions and 0 deletions.
  1. +22 −0 LICENSE
  2. +17 −0 README.rst
  3. +1 −0 notifyme_onsite/__init__.py
  4. +35 −0 setup.py
View
@@ -0,0 +1,22 @@
+Copyright (c) 2011 Stefan Foulis and contributors.
+
+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.
View
@@ -5,3 +5,20 @@ django-notifyme-onsite
``django-notifyme-onsite`` is a delivery backend for django-notifyme. It allows displaying notifications on the
website and keeps a list of per user notifications in the database. It contains hook for users to *dismiss* a
a sticky notification.
+
+Installation
+============
+
+Dependencies:
+ * django-notifyme
+
+::
+
+ pip install django-notifyme-onsite
+
+Add ``notifyme_onsite`` to ``INSTALLED_APPS`` and register the backend somewhere in your project code (best in a
+models.py)::
+
+ import notifyme.delivery
+ from notifyme_onsite.delivery import OnsiteStickyBackend
+ notifyme.delivery.backend.register(OnsiteStickyBackend)
@@ -0,0 +1 @@
+__version__ = '0.0.1'
View
@@ -0,0 +1,35 @@
+from setuptools import setup, find_packages
+import os
+
+version = __import__('notifyme_onsite').__version__
+
+def read(fname):
+ # read the contents of a text file
+ return open(os.path.join(os.path.dirname(__file__), fname)).read()
+
+install_requires = [
+]
+
+setup(
+ name = "django-notifyme-onsite",
+ version = version,
+ url = 'http://github.com/stefanfoulis/django-notifyme-onsite',
+ license = 'BSD',
+ platforms=['OS Independent'],
+ description = "A notification framework for django",
+ long_description = read('README.rst'),
+ author = 'Stefan Foulis',
+ author_email = 'stefan.foulis@gmail.com',
+ packages=find_packages(),
+ install_requires = install_requires,
+ include_package_data=True,
+ zip_safe=False,
+ classifiers = [
+ 'Framework :: Django',
+ 'Intended Audience :: Developers',
+ 'License :: OSI Approved :: BSD License',
+ 'Operating System :: OS Independent',
+ 'Programming Language :: Python',
+ 'Topic :: Internet :: WWW/HTTP',
+ ]
+)

0 comments on commit 36d2925

Please sign in to comment.