Permalink
Browse files

adding core project files: CHANGELOG, LICENSE, and such

  • Loading branch information...
kreneskyp committed Feb 26, 2011
1 parent 672c15a commit 62555acfb8f5629dd4242d0885b0c23c6d305797
Showing with 140 additions and 0 deletions.
  1. +12 −0 .gitignore
  2. +10 −0 CHANGELOG
  3. +21 −0 LICENSE
  4. +1 −0 MANIFEST.in
  5. +73 −0 README
  6. +23 −0 setup.py
View
@@ -0,0 +1,12 @@
+##
+# The following lists what should be ignored in this git directory
+##
+
+# All compiled python code
+*.pyc
+
+# Settings should be setup per install
+settings.py
+
+# Any sqlite database files created by the project
+*.db
View
@@ -0,0 +1,10 @@
+======================================
+Changelog
+======================================
+
+
+
+0.5
+---------
+
+ * Initial release
View
21 LICENSE
@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2011 Oregon State University
+
+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
@@ -0,0 +1 @@
+recursive-include object_log *.py *.png *.js *.html
View
73 README
@@ -0,0 +1,73 @@
+========================================
+Django Object Log
+========================================
+
+This app provides the ability to log user actions on model instances. Action
+types can be defined by app developers, and can reference multiple objects.
+Each action type defines it's own template used for rendering output of the
+message. It allows verbose messages specific to the action that occurred.
+
+Object Log includes shortcuts both for adding entries and building views to
+display them.
+
+
+Installation
+----------------------------------------
+
+There are several ways to install Object Log.
+
+Object Log ships a standard distutils setup.py. A classic invocation
+to install from setup.py might be::
+
+ $ python setup.py install
+
+You may need to add sudo in order to install to the system Python.
+
+::
+
+ $ sudo python setup.py install
+
+We also have Object Log on PyPI, so it can be installed using pip.
+(easy_install also works, but we do not recommend easy_install. Just use pip.)
+
+::
+
+ $ pip install django-object-log
+
+If you are installing Object Log directly into a Django app, and want
+to distribute Object Log with your app, simply copy the
+object_log folder into your Django project.
+
+Configuring Your Django Project
+----------------------------------------
+
+1) Add "object_log" to INSTALLED_APPS
+2) Run ./manage.py syncdb
+3) Add object_log.urls to urls if you wish to add views for displaying logs
+
+Using Object Log
+----------------------------------------
+
+First, register some action types. This can be done at any time but should
+ideally be done once in models.py. LogActions require both a key and a
+template used to render that Action type.
+
+>>> from object_log.models import LogAction
+>>> LogAction.objects.register('MY_ACTION', 'path/to/my/template.html')
+
+Now, that LogAction type can be used whenever that action occurs
+
+>>> from object_log.models import LogItem
+>>> log = LogItem.objects.log_action
+>>> log('MY_ACTION', user, some_object)
+>>> log('EDIT', user, some_object)
+>>> log('DELETE', user, some_object)
+
+See the wiki for more details:
+http://code.osuosl.org/projects/django-object-log/wiki
+
+Authors
+-------
+
+Object Log was originally implemented at the Oregon
+State University Open Source Lab (OSUOSL).
View
@@ -0,0 +1,23 @@
+#!/usr/bin/env python
+
+from setuptools import setup
+
+long_desc = open('README').read()
+
+setup(name='django-object-log',
+ version="0.5",
+ description='A method for logging user actions on models',
+ long_description=long_desc,
+ author='Peter Krenesky',
+ author_email='peter@osuosl.org',
+ maintainer="Peter Krenesky",
+ maintainer_email="peter@osuosl.org",
+ url='http://code.osuosl.org/projects/object-log',
+ packages=['object_log'],
+ include_package_data=True,
+ classifiers=[
+ "License :: OSI Approved :: MIT License",
+ 'Framework :: Django',
+ 'Topic :: Logging',
+ ],
+ )

0 comments on commit 62555ac

Please sign in to comment.