From 592cbcfe7d898357b582720c7b88f517f764c765 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Norman=20J=C3=A4ckel?= Date: Thu, 25 Apr 2013 13:10:50 +0200 Subject: [PATCH] Update all meta files. --- .gitignore | 1 - CHANGELOG | 9 ++--- INSTALL.txt | 89 +++++++++++++++++++++++++++++++++--------------- README.txt | 16 ++++++--- THANKS | 5 +-- requirements.txt | 6 ++-- setup.py | 12 +++---- 7 files changed, 89 insertions(+), 49 deletions(-) diff --git a/.gitignore b/.gitignore index 4c24d609b..d56d1115a 100644 --- a/.gitignore +++ b/.gitignore @@ -17,7 +17,6 @@ docs/_build/* build/* dist/* .DS_Store -versiontools* # Unit test and coverage reports .coverage diff --git a/CHANGELOG b/CHANGELOG index 80e605d5b..4987b7b69 100644 --- a/CHANGELOG +++ b/CHANGELOG @@ -1,4 +1,7 @@ -CHANGELOG of OpenSlides +========================= + CHANGELOG of OpenSlides +========================= + http://openslides.org @@ -104,13 +107,11 @@ Participants: - Made OpenSlides user a child model of Django user model. - Appended tests. - Fixed error to allow admins to delete anonymous group - Other: - Added French translation (Thanks to Moira). - Updated setup.py to make an openslides python package. - Removed frontpage (welcome widget contains it's content) and redirect '/' to dashboard url. - -- Added LOCALE_PATHS to openslides_settings to avoid deprication in Django 1.5. +- Added LOCALE_PATHS to openslides_settings to avoid deprecation in Django 1.5. - Redesigned the DeleteView (append QuestionMixin to send question via the django message API). - Fixed encoding error in settings.py. (#349) - Renamed openslides_settings.py to openslides_global_settings.py. diff --git a/INSTALL.txt b/INSTALL.txt index 683740922..125c748f7 100644 --- a/INSTALL.txt +++ b/INSTALL.txt @@ -1,11 +1,12 @@ -Installation Instructions for OpenSlides 1.4 -============================================ +============================================== + Installation Instructions for OpenSlides 1.4 +============================================== Content -------- +======= -I. Installation on GNU/Linux and MacOSX using the Python Package Index (PyPI) -II. Installation on GNU/Linux and MacOSX using the sources +I. Installation on GNU/Linux and MacOSX using the Python Package Index (PyPI) +II. Installation on GNU/Linux and MacOSX using the sources III. Installation on Windows (32bit) using the Python Package Index (PyPI) If you need help ask on OpenSlides users mailing list. @@ -13,7 +14,7 @@ See http://openslides.org for more information. I. Installation on GNU/Linux and MacOSX using the Python Package Index (PyPI) ------------------------------------------------------------------------------ +============================================================================= 1. Check requirements: @@ -29,6 +30,9 @@ I. Installation on GNU/Linux and MacOSX using the Python Package Index (PyPI) You can setup a virtual environment to install OpenSlides as non-root user. + Make sure that you have installed Virtual Python Environment builder + on your system. + E. g. for Ubuntu run: $ sudo apt-get install python-virtualenv @@ -66,18 +70,26 @@ I. Installation on GNU/Linux and MacOSX using the Python Package Index (PyPI) Use 'openslides --help' to show all start options. + 5. Restart OpenSlides: + + To restart OpenSlides after closing the terminal activate the + virtual environment before starting the server: + + $ source .venv/bin/activate + $ openslides + II. Installation on GNU/Linux and MacOSX using the sources ----------------------------------------------------------- +========================================================== 1. Check requirements: Make sure that you have installed Python Programming Language 2 - (>= 2.6) and virtualenv (>= 1.4.1) on your system. You will also - need the Python development headers. + (>= 2.6) on your system. You will also need the Python + development headers. E. g. for Ubuntu run: - $ sudo apt-get install python-dev python-virtualenv + $ sudo apt-get install python-dev 2. Get OpenSlides: @@ -86,19 +98,21 @@ II. Installation on GNU/Linux and MacOSX using the sources OR b) Clone current master version from OpenSlides' GitHub repository - https://github.com/OpenSlides/OpenSlides. - - $ git clone git://github.com/OpenSlides/OpenSlides.git OpenSlides - - This requires Git (see http://git-scm.com/). - To install Git e.g. on Ubuntu run: + https://github.com/OpenSlides/OpenSlides. This requires Git + (see http://git-scm.com/). + + E. g. for Ubuntu run: $ sudo apt-get install git + $ git clone git://github.com/OpenSlides/OpenSlides.git 3. Setup a virtual environment with virtualenv (optional): You can setup a virtual environment to install OpenSlides as non-root user. + Make sure that you have installed Virtual Python Environment builder + on your system. + E. g. for Ubuntu run: $ sudo apt-get install python-virtualenv @@ -135,7 +149,7 @@ II. Installation on GNU/Linux and MacOSX using the sources III. Installation on Windows (32bit) using the Python Package Index (PyPI) --------------------------------------------------------------------------- +========================================================================== NOTE: There is a portable version of OpenSlides for Windows which does not required any install steps! If there is a reason that you can not use the @@ -150,30 +164,41 @@ portable version you should run the following install steps. a) Download and run 32bit MSI installer from http://www.python.org/: - http://python.org/ftp/python/2.7.3/python-2.7.3.msi + http://python.org/ftp/python/2.7.4/python-2.7.4.msi b) Add python dirs to PATH (via Control Panel > System > Advanced): ";C:\Python27;C:\Python27\Scripts" - c) Install Setuptools: + c) Download and run 32bit binary installer from http://pypi.python.org/pypi/setuptools: - Download and run 32bit binary installer from - http://pypi.python.org/pypi/setuptools: + https://pypi.python.org/packages/2.7/s/setuptools/setuptools-0.6c11.win32-py2.7.exe - http://pypi.python.org/packages/2.7/s/setuptools/setuptools-0.6c11.win32-py2.7.exe + 2. Setup a virtual environment with virtualenv (optional): - 2. Install OpenSlides: + You can setup a virtual environment to install OpenSlides as + non-root user. - Open command line (cmd) and run: + To setup and activate the virtual environment, create your + OpenSlides directory, open command line (cmd), change to the + directory and run: - easy_install openslides + > virtualenv .venv + > .venv\Scripts\activate - 3. Start OpenSlides server and open URL in your default browser: + 3. Install OpenSlides: - Open command line (cmd) and run: + Run on command line (cmd): - openslides + > pip install openslides + + OpenSlides will install all required python packages. + + 4. Start OpenSlides server and open URL in your default browser: + + Run on command line (cmd): + + > openslides If you run this script the first time a new database and the admin account are created. Please change the password after @@ -183,3 +208,11 @@ portable version you should run the following install steps. Password: admin Use 'openslides --help' to show all start options. + + 5. Restart OpenSlides: + + To restart OpenSlides after closing the command line activate the + virtual environment before starting the server: + + > .venv/Scripts/activate + > openslides diff --git a/README.txt b/README.txt index 51c06eb6f..caa34ff35 100644 --- a/README.txt +++ b/README.txt @@ -1,12 +1,13 @@ -================================== -English README file for OpenSlides -================================== +==================================== + English README file for OpenSlides +==================================== -This is OpenSlides, version 1.4-beta1-dev (unreleased). +This is OpenSlides, version 1.4b1-dev (unreleased). What is OpenSlides? =================== + OpenSlides is a free web-based presentation and assembly system for displaying and controlling of agenda, motions and elections of an assembly. @@ -15,6 +16,7 @@ See http://openslides.org for more information. Getting started =============== + Install and start OpenSlides as described in the INSTALL.txt. If you need help please contact the OpenSlides team on public mailing @@ -23,6 +25,10 @@ list or read the OpenSlides manual. See http://openslides.org. The start script of OpenSlides ============================== + +Start OpenSlides +---------------- + Simply running openslides.exe (on Windows) or @@ -47,6 +53,7 @@ is as follows: Command line options -------------------- + The following command line options are available: -h, --help @@ -85,6 +92,7 @@ Example 2: Like above, but also specify the port as 8080 Supported operating systems and browsers ======================================== + Operating Systems (OpenSlides runs anywhere where Pyhton is running): Windows XP or newer (32 and 64bit) MacOS X diff --git a/THANKS b/THANKS index 39e40f0d8..2627879f3 100644 --- a/THANKS +++ b/THANKS @@ -1,5 +1,6 @@ -THANKS file for OpenSlides - +============================ + THANKS file for OpenSlides +============================ OpenSlides uses parts of the following projects: diff --git a/requirements.txt b/requirements.txt index 1432e2298..dd1c9f43d 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,4 +1,4 @@ -# Requirements for OpenSlides Core +# Requirements for OpenSlides Django==1.5.1 django-mptt==0.5.5 pillow==2.0.0 @@ -8,11 +8,11 @@ tornado==3.0.1 bleach==1.2.1 beautifulsoup4==4.1.3 -# required for travis +# Requirements for development and tests Fabric==1.6.0 coverage==3.6 django-discover-runner==0.3 pep8==1.4.5 -# For python 2.6 support +# For Python 2.6 support argparse==1.2.1 diff --git a/setup.py b/setup.py index 8e41c0ff1..fb93c404a 100644 --- a/setup.py +++ b/setup.py @@ -3,7 +3,7 @@ """ Setup script for OpenSlides. - :copyright: 2011, 2012 by OpenSlides team, see AUTHORS. + :copyright: 2011–2013 by OpenSlides team, see AUTHORS. :license: GNU GPL, see LICENSE for more details. """ @@ -12,8 +12,9 @@ from setuptools import find_packages from openslides import get_version -with open('README.txt') as file: - long_description = file.read() +with open('README.txt') as readme: + long_description = readme.read() + setup( name='openslides', @@ -36,11 +37,8 @@ setup( 'Operating System :: OS Independent', 'Programming Language :: Python', ], - setup_requires=[ - 'versiontools >= 1.6', - ], install_requires=[ - 'django >= 1.5', + 'django == 1.5.1', 'django-mptt', 'reportlab', 'pillow',