Release preparation for 0.6.0

- Bump copyright years
- Bump version number
- Update changelog
- Update documentation

LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2014, 2015 Jan Dittberner
+Copyright (c) 2014-2020 Jan Dittberner
 
 Permission is hereby granted, free of charge, to any person
 obtaining a copy of this software and associated documentation

README.rst

@@ -10,4 +10,4 @@ customer management at `Jan Dittberner IT-Consulting & -Solutions
 
 Read the :doc:`Installation instructions <install>` to get started locally.
 
-The project page for gvaldap is at http://dev.gnuviech-server.de/gvaldap.
+The project page for gvaldap is at http://git.dittberner.info/gnuviech/gvaldap.

docs/changelog.rst

@@ -1,6 +1,12 @@
 Changelog
 =========
 
+* :release:`0.6.0 <2020-03-03>`
+* :support:`-` add Python 3 support
+* :support:`-` upgrade to Django 2.2.10
+* :support:`-` use Pipenv for dependency management
+* :feature:`-` properly handle unavailable LDAP server
+
 * :release:`0.5.2 <2015-01-29>`
 * :bug:`-` fix minor log message issue
 

docs/code.rst

@@ -16,13 +16,6 @@ The project module :py:mod:`gvaldap`
 .. automodule:: gvaldap
 
 
-:py:mod:`celery <gvaldap.celery>`
----------------------------------
-
-.. automodule:: gvaldap.celery
-   :members:
-
-
 :py:mod:`urls <gvaldap.urls>`
 -----------------------------
 
@@ -41,27 +34,6 @@ The project module :py:mod:`gvaldap`
 
 .. automodule:: gvaldap.settings
 
-:py:mod:`base <gvaldap.settings.base>`
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-.. automodule:: gvaldap.settings.base
-   :members:
-
-:py:mod:`local <gvaldap.settings.local>`
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-.. automodule:: gvaldap.settings.local
-
-:py:mod:`production <gvaldap.settings.production>`
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-.. automodule:: gvaldap.settings.production
-
-:py:mod:`test <gvaldap.settings.test>`
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-.. automodule:: gvaldap.settings.test
-
 
 :py:mod:`ldapentities` app
 ==========================
@@ -89,6 +61,13 @@ The project module :py:mod:`gvaldap`
 .. automodule:: ldaptasks
 
 
+:py:mod:`celery <ldaptasks.celery>`
+-----------------------------------
+
+.. automodule:: ldaptasks.celery
+   :members:
+
+
 :py:mod:`tasks <ldaptasks.tasks>`
 ---------------------------------
 

docs/conf.py

@@ -21,6 +21,7 @@ import django
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 sys.path.insert(0, os.path.abspath(os.path.join('..', 'gvaldap')))
 
+os.environ['DJANGO_SETTINGS_MODULE'] = 'gvaldap.settings'
 os.environ['GVALDAP_ALLOWED_HOSTS'] = 'localhost'
 os.environ['GVALDAP_SERVER_EMAIL'] = 'root@localhost'
 
@@ -53,7 +54,7 @@ master_doc = 'index'
 
 # General information about the project.
 project = u'gvaldap'
-copyright = u'2014, 2015, 2016 Jan Dittberner'
+copyright = u'2014-2020 Jan Dittberner'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the

docs/deploy.rst

@@ -7,4 +7,4 @@ of the following steps:
 * installation of native dependencies
 * setup of a virtualenv
 * installation of gvaldap production dependencies inside the virtualenv
-* setup of celery worker under control of supervisord
+* setup of celery worker under control of systemd

docs/install.rst

@@ -7,65 +7,17 @@ Install
 Working Environment
 ===================
 
-You have several options in setting up your working environment.  We recommend
+To get a running work environment use `pipenv`_.
-using virtualenv to separate the dependencies of your project from your
-system's python environment.  If on Linux or Mac OS X, you can also use
-virtualenvwrapper to help manage multiple virtualenvs across different
-projects.
 
-.. index:: virtualenv
+.. _pipenv: https://pipenv.kennethreitz.org/en/latest/
 
-Virtualenv Only
+To get started install `pip` and `pipenv` and use `pipenv install --dev`:
----------------
-
-First, make sure you are using `virtualenv`_. Once that's installed, create
-your virtualenv:
 
 .. code-block:: sh
 
-    $ virtualenv --distribute gvaldap
+   $ apt install python3-pip
-
+   $ python3 -m pip install --user -U pipenv
-.. _virtualenv: https://virtualenv.pypa.io/en/latest/
+   $ pipenv install --dev
-
-You will also need to ensure that the virtualenv has the project directory
-added to the path. Adding the project directory will allow `django-admin.py` to
-be able to change settings using the `--settings` flag.
-
-.. index:: virtualenvwrapper
-
-Virtualenv with virtualenvwrapper
-------------------------------------
-
-In Linux and Mac OSX, you can install `virtualenvwrapper
-<http://virtualenvwrapper.readthedocs.org/en/latest/>`_, which will take care
-of managing your virtual environments and adding the project path to the
-`site-directory` for you:
-
-.. code-block:: sh
-
-    $ mkdir gvaldap
-    $ mkvirtualenv -a gvaldap gvaldap-dev
-    $ cd gvaldap && add2virtualenv `pwd`
-
-
-.. index:: pip, requirements, dependencies
-
-Installation of Dependencies
-=============================
-
-Depending on where you are installing dependencies:
-
-In development:
-
-.. code-block:: sh
-
-    $ pip install -r requirements/local.txt
-
-For production:
-
-.. code-block:: sh
-
-    $ pip install -r requirements.txt
 
 .. index:: celery, worker, ldap queue
 
@@ -79,6 +31,6 @@ into the gvaldap directory and run the celery worker with:
 .. code-block:: sh
 
     $ cd gvaldap
-    $ celery -A gvaldap worker -Q ldap -l info
+    $ pipenv run celery -A ldaptasks worker -Q web -l info
 
 .. _Celery: http://www.celeryproject.org/

gvaldap/gvaldap/__init__.py

@@ -1,7 +1,7 @@
 """
 This is the gvaldap project module.
 """
-__version__ = "0.6.0.dev1"
+__version__ = "0.6.0"
 
 from ldaptasks.celery import app as celery_app