Reformatted readme and license

Move some setup values to package Added .gitignore
2014-05-31 09:19:27 +02:00 · 2014-05-31 09:19:27 +02:00 · 97d27f7589
commit 97d27f7589
parent 18df0f2c78
5 changed files with 64 additions and 20 deletions
--- a/.gitignore
+++ b/.gitignore
@ -0,0 +1,10 @@
+# tools, IDEs, build folders
+/.coverage/
+/.idea/
+/build/
+/dist/
+/docs/build/
+/*.egg-info/
+
+# Django and Python
+*.py[cod]
--- a/27
+++ b/27
@ -1,12 +1,27 @@
-Copyright (c) 2010, Scot Hacker, Birdhouse Arts
+Copyright (c) 2010, Scot Hacker, Birdhouse Arts and individual contributors.
 All rights reserved.

-Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:

-Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+    1. Redistributions of source code must retain the above copyright notice,
+       this list of conditions and the following disclaimer.

-Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+    2. Redistributions in binary form must reproduce the above copyright
+       notice, this list of conditions and the following disclaimer in the
+       documentation and/or other materials provided with the distribution.

-Neither the name of Birdhouse Arts nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+    3. Neither the name of Birdhouse Arts nor the names of its contributors
+       may be used to endorse or promote products derived from this software
+       without specific prior written permission.

-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
--- a/README.rst
+++ b/README.rst
@ -1,16 +1,23 @@
-django-todo is a pluggable multi-user, multi-group task management and 
-assignment application for Django. It can serve as anything from a 
-personal to-do system to a complete, working ticketing system for organizations.
+===========
+django todo
+===========
+
+django-todo is a pluggable multi-user, multi-group task management and
+assignment application for Django. It can serve as anything from a  personal
+to-do system to a complete, working ticketing system for organizations.
+
+Documentation
+=============

 For documentation, see the django-todo wiki pages:

-Overview and screenshots
-http://github.com/shacker/django-todo/wiki/Overview-and-screenshots
+- `Overview and screenshots
+  <http://github.com/shacker/django-todo/wiki/Overview-and-screenshots>`_

-Requirements and installation
-http://github.com/shacker/django-todo/wiki/Requirements-and-Installation
+- `Requirements and installation
+  <http://github.com/shacker/django-todo/wiki/Requirements-and-Installation>`_

 This is version 1.3

-Version history
-http://github.com/shacker/django-todo/wiki/Version-history
+- `Version history
+  <http://github.com/shacker/django-todo/wiki/Version-history>`_
--- a/setup.py
+++ b/setup.py
@ -1,12 +1,16 @@
+# !/usr/bin/env python
+#
 from setuptools import setup, find_packages
- 
+import todo
+
 setup(
    name='django-todo',
-    version='1.3',
+    version=todo.__version__,
    description='A multi-user, multi-group task management and assignment system for Django.',
-    author='Scot Hacker',
-    author_email='shacker@birdhouse.org',
-    url='http://github.com/shacker/django-todo',
+    author=todo.__author__,
+    author_email=todo.__email__,
+    url=todo.__url__,
+    license=todo.__license__,
    packages=find_packages(),
    classifiers=[
        'Development Status :: 4 - Beta',
--- a/todo/init.py
+++ b/todo/init.py
@ -0,0 +1,8 @@
+"""django todo"""
+__version__ = '1.4.dev'
+
+__author__ = 'Scot Hacker'
+__email__ = 'shacker@birdhouse.org'
+
+__url__ = 'https://github.com/shacker/django-todo'
+__license__ = 'BSD License'