Source

django-marcador / README.rst

Full commit

django-marcador

django-marcador is a German Django tutorial. It shows how to build a bookmark app using Django.

The tutorial is hosted at http://django-marcador.keimlink.de.

A Vagrantfile and definitions for a Debian box are included and can be used to create a virtual machine to build the app.

The requirements.txt file contains all Python packages needed to extend, test and build the tutorial.

Install the requirements with the following command (you may want to use a virtualenv for that):

$ pip install -r requirements.txt

How to build the tutorial

To run the basic tests and build the HTML files use the Makefile in the docs directory:

$ cd docs
$ make clean doctest linkcheck html

You can also build a PDF (still in the docs directory):

$ make clean doctest linkcheck latexpdf

How to deploy the tutorial

If you want to deploy the HTML files on a server you can use Fabric. If Fabric is not installed on your machine run first:

$ pip install fabric

Then deploy the HTML files on your server:

$ fab deploy:/path/where/static/files/go

The deploy task will do the following steps before the actual deployment:

  1. Run the test suite of the django-marcador app
  2. Clean up the Sphinx build directory
  3. Run Sphinx doctests
  4. Run Sphinx linkcheck
  5. Build the HTML files

If you want to make deployment with Fabric easy repeatable you can use a fabricrc file like this:

user = alice
host_string = slides.example.com
remotepath = /path/where/static/files/go

And then use it like so:

$ fab -c fabricrc deploy

Contributions and Bugs

Feel free to improve django-marcador or create translations. Pull requests are welcome!

Please report problems to our issue tracker.

Documentation License

This work is licensed under the Creative Commons Attribution-ShareAlike 3.0 Unported License. To view a copy of this license, visit http://creativecommons.org/licenses/by-sa/3.0/ or send a letter to Creative Commons, 444 Castro Street, Suite 900, Mountain View, California, 94041, USA.

Source Code License

Copyright (c) 2012, Markus Zapke-Gründemann All rights reserved.

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.
  • 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 names of the authors nor the names of other 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 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.