switch from ddportfolio to debianmemberportfolio

- change all references from ddportfolio to debianmemberportfolio
- rename debianmemberportfolio.controllers.DDPortfolioController to
  debianmemberportfolio.controllers.Controller
- update documentation
- update copyright years, unify file header formatting
This commit is contained in:
Jan Dittberner 2014-02-08 23:54:51 +01:00
parent 780e10494e
commit b670f58c7a
45 changed files with 1217 additions and 1123 deletions

View file

@ -22,12 +22,12 @@ To start working on the source code you need to have `git`_ installed::
.. _git: http://www.git-scm.com/
The canonical git repository for the Debian Member Portfolio Service is
available at http://debianstuff.dittberner.info/git/ddportfolioservice.git. To
get a clone of the source code you change to a directory of your choice and
available at http://debianstuff.dittberner.info/git/debianmemberportfolio.git.
To get a clone of the source code you change to a directory of your choice and
invoke git clone::
cd ~/src
git clone http://debianstuff.dittberner.info/git/ddportfolioservice.git
git clone http://debianstuff.dittberner.info/git/debianmemberportfolio.git
You should use `virtualenv`_ to separate the development environment from your
system wide Python installation. You can install virtualenv using::
@ -43,7 +43,7 @@ requirements using `pip <https://pypi.python.org/pypi/pip>`_::
mkdir ~/.virtualenvs
virtualenv --distribute ~/.virtualenvs/dmportfolio
. ~/.virtualenvs/dmportfolio/bin/activate
cd ~/src/ddportfolioservice
cd ~/src/debianmemberportfolio
pip install -r wheezyreq.pip
.. note::
@ -63,12 +63,12 @@ development::
Debian Member Portfolio Service needs the JQuery JavaScript library to function
properly. The JQuery library is not included in the git clone and must be
copied into the subdirectory
:file:`ddportfolioservice/public/javascript/jquery`. On Debian systems you can
install the package libjs-jquery and place a symlink to the directory
:file:`/usr/share/javascript` into :file:`ddportfolioservice/public`: ::
:file:`debianmemberportfolio/public/javascript/jquery`. On Debian systems you
can install the package libjs-jquery and place a symlink to the directory
:file:`/usr/share/javascript` into :file:`debianmemberportfolio/public`: ::
sudo aptitude install libjs-jquery
ln -s /usr/share/javascript ddportfolioservice/public
ln -s /usr/share/javascript debianmemberportfolio/public
Prepare for first startup
~~~~~~~~~~~~~~~~~~~~~~~~~
@ -88,12 +88,12 @@ When you have both installed you can run::
. ~/.virtualenvs/dmportfolio/bin/activate
./synckeyrings.sh
python ddportfolioservice/model/keyringanalyzer.py
python debianmemberportfolio/model/keyringanalyzer.py
The first synchronizes the keyrings in :file:`$HOME/debian/keyring.debian.org`
with files on the `keyring.debian.org <http://keyring.debian.org>`_ host. And
the second generates a key/value database in
:file:`ddportfolioservice/model/keyringcache` that is used by the code.
:file:`debianmemberportfolio/model/keyringcache` that is used by the code.
Run a development server
~~~~~~~~~~~~~~~~~~~~~~~~
@ -120,17 +120,17 @@ Add new URL
~~~~~~~~~~~
Debian Member Portfolio Service uses a ini style configuration file
:file:`ddportfolioservice/model/ddportfolio.ini` to configure the generated URL
:file:`debianmemberportfolio/model/portfolio.ini` to configure the generated URL
patterns. The actual URL generation is done in
:py:class:`~ddportfolioservice.controllers.ddportfolio.DdportfolioController`
:py:class:`~debianmemberportfolio.controllers.portfolio.DdportfolioController`
in the
:py:meth:`~ddportfolioservice.controllers.ddportfolio.DdportfolioController.urllist`
:py:meth:`~debianmemberportfolio.controllers.portfolio.DdportfolioController.urllist`
method.
If you want to add a new URL type you have to add a line in
:file:`ddportfolio.ini` and an entry in
:py:class:`~ddportfolioservice.controllers.ddportfolio.DdportfolioController`'s
:py:attr:`~ddportfolioservice.controllers.ddportfolio.DdportfolioController._LABELS`
:file:`portfolio.ini` and an entry in
:py:class:`~debianmemberportfolio.controllers.portfolio.DdportfolioController`'s
:py:attr:`~debianmemberportfolio.controllers.portfolio.DdportfolioController._LABELS`
dictionary. The top level dictionary keys correspond to sections in the ini
file. The dictionary values are dictionaries themselves that contain a special
key ``label`` that defines the label of the section in the output and keys for
@ -138,7 +138,7 @@ each entry to be rendered in that section. The values in these sub-dictionaries
are strings marked for translation using the :py:func:`~pylons.i18n._` function from
:py:mod:`pylons.i18n`.
The patterns in :file:`ddportfolio.ini` can contain the following placeholders
The patterns in :file:`portfolio.ini` can contain the following placeholders
that are filled at runtime:
================== ========================================
@ -158,11 +158,10 @@ Placeholder Replacement
.. _alioth.debian.org: http://alioth.debian.org/
The replacement of placeholders is performed in the
:py:meth:`~ddportfolioservice.controllers.ddportfolio.DdportfolioController.urllist`
:py:meth:`~debianmemberportfolio.controllers.portfolio.DdportfolioController.urllist`
method. And uses data from the Debian keyring. Access to the pre-parsed keyring
data is performed using the
:py:func:`~ddportfolioservice.model.dddatabuilder.build_data` function of the
module :py:mod:`ddportfolioservice.model.dddatabuilder`, which uses several
helper functions from :py:mod:`ddportfolioservice.model.keyfinder` to access
the key information.
:py:func:`~debianmemberportfolio.model.dddatabuilder.build_data` function of
the module :py:mod:`debianmemberportfolio.model.dddatabuilder`, which uses
several helper functions from :py:mod:`debianmemberportfolio.model.keyfinder`
to access the key information.

View file

@ -7,89 +7,89 @@ code of the Debian Member Portfolio Service.
Controllers
-----------
.. automodule:: ddportfolioservice.controllers
.. automodule:: debianmemberportfolio.controllers
:members:
ddportfolio controller
~~~~~~~~~~~~~~~~~~~~~~
portfolio controller
~~~~~~~~~~~~~~~~~~~~
.. automodule:: ddportfolioservice.controllers.ddportfolio
.. automodule:: debianmemberportfolio.controllers.portfolio
:members:
error controller
~~~~~~~~~~~~~~~~
.. automodule:: ddportfolioservice.controllers.error
.. automodule:: debianmemberportfolio.controllers.error
:members:
showformscripts controller
~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: ddportfolioservice.controllers.showformscripts
.. automodule:: debianmemberportfolio.controllers.showformscripts
:members:
template controller
~~~~~~~~~~~~~~~~~~~
.. automodule:: ddportfolioservice.controllers.template
.. automodule:: debianmemberportfolio.controllers.template
:members:
Library code
------------
.. automodule:: ddportfolioservice.lib
.. automodule:: debianmemberportfolio.lib
:members:
app_globals
~~~~~~~~~~~
.. automodule:: ddportfolioservice.lib.app_globals
.. automodule:: debianmemberportfolio.lib.app_globals
:members:
base
~~~~
.. automodule:: ddportfolioservice.lib.base
.. automodule:: debianmemberportfolio.lib.base
:members:
helpers
~~~~~~~
.. automodule:: ddportfolioservice.lib.helpers
.. automodule:: debianmemberportfolio.lib.helpers
:members:
Model
-----
.. automodule:: ddportfolioservice.model
.. automodule:: debianmemberportfolio.model
:members:
dddatabuilder
~~~~~~~~~~~~~
.. automodule:: ddportfolioservice.model.dddatabuilder
.. automodule:: debianmemberportfolio.model.dddatabuilder
:members:
form
~~~~
.. automodule:: ddportfolioservice.model.form
.. automodule:: debianmemberportfolio.model.form
:members:
keyfinder
~~~~~~~~~
.. automodule:: ddportfolioservice.model.keyfinder
.. automodule:: debianmemberportfolio.model.keyfinder
:members:
keyringanalyzer
~~~~~~~~~~~~~~~
.. automodule:: ddportfolioservice.model.keyringanalyzer
.. automodule:: debianmemberportfolio.model.keyringanalyzer
:members:
urlbuilder
~~~~~~~~~~
.. automodule:: ddportfolioservice.model.urlbuilder
.. automodule:: debianmemberportfolio.model.urlbuilder
:members: