Metadata-Version: 1.0
Name: Mezzanine
Version: 1.0.2
Summary: An open source content management platform built using the Django framework.
Home-page: http://mezzanine.jupo.org/
Author: Stephen McDonald
Author-email: stephen.mc@gmail.com
License: BSD
Description: .. image:: https://secure.travis-ci.org/stephenmcd/mezzanine.png?branch=master
        
        ========
        Overview
        ========
        
        Mezzanine is a content management platform built using the `Django`_
        framework. It is `BSD licensed`_ and designed to provide both a
        consistent interface for managing content, and a simple, extensible
        architecture that makes diving in and hacking on the code as easy as
        possible.
        
        Mezzanine resembles tools like `Wordpress`_, with an intuitive
        interface for managing pages, blog posts, form data, store products,
        or any other type of content you can imagine. Mezzanine takes a different
        approach from other Django applications in this space like `Pinax`_ or
        `Mingus`_ that glue together a lot of reusable apps, instead opting to
        provide most of its functionality included with the project by default.
        
        Visit the `Mezzanine project page`_ to see some of the great sites people
        have built using Mezzanine.
        
        Features
        ========
        
        On top of all the usual features provided by Django such as MVC architecture,
        ORM, templating, caching and the automatic admin interface, Mezzanine
        provides the following features:
        
          * Hierarchical page navigation
          * Save as draft and preview on site
          * Scheduled publishing
          * Drag-n-drop page ordering
          * WYSIWYG editing
          * `In-line page editing`_
          * Drag-n-drop HTML5 forms builder with CSV export
          * `Custom templates`_ per page or blog post
          * `Twitter Bootstrap`_ integration
          * API for `custom content types`_
          * SEO friendly URLs and meta data
          * `Search engine and API`_
          * Configurable `dashboard`_ widgets
          * Multi-device detection and template handling
          * Shopping cart module (`Cartridge`_)
          * Blogging engine
          * Tagging
          * One step migration from other blogging engines
          * `Disqus`_ integration or built-in threaded comments
          * `Gravatar`_ integration
          * `Google Analytics`_ integration
          * `Twitter`_ feed integration
          * `bit.ly`_ integration
          * Sharing via Facebook or Twitter
          * Built-in `test suite`_
        
        The Mezzanine admin dashboard:
        
        .. image:: http://github.com/stephenmcd/mezzanine/raw/master/docs/img/dashboard.png
        
        Dependencies
        ============
        
        Mezzanine has no explicit dependencies apart from a standard Django
        environment using:
        
          * `Python`_ 2.5 ... 2.7
          * `Django`_ 1.3 ... 1.4
        
        Mezzanine is designed however to be used most effectively in conjunction
        with the following libraries:
        
          * `Python Imaging Library`_ (PIL)
          * `grappelli-safe`_ (Mezzanine's fork of Grappelli)
          * `filebrowser-safe`_ (Mezzanine's fork of FileBrowser)
          * `South`_
          * `pyflakes`_ and `pep8`_ (required for running the test suite)
        
        Browser Support
        ===============
        
        Mezzanine's admin interface works with all modern browsers.
        Internet Explorer 7 and earlier are generally unsupported.
        
        Installation
        ============
        
        The easiest method is to install directly from pypi using `pip`_ or
        `setuptools`_ by running the respective command below, which will also
        attempt to install the dependencies mentioned above::
        
            $ pip install -U mezzanine
        
        or::
        
            $ easy_install -U mezzanine
        
        Otherwise you can download Mezzanine and install it directly from source::
        
            $ python setup.py install
        
        Once installed, the command ``mezzanine-project`` should be available which
        can be used for creating a new Mezzanine project in a similar fashion to
        ``django-admin.py``::
        
            $ mezzanine-project project_name
        
        You can then run your project with the usual Django steps::
        
            $ cd project_name
            $ python manage.py createdb --noinput
            $ python manage.py runserver
        
        .. note::
        
            The ``createdb`` is a shortcut for using Django's ``syncdb`` command and
            setting the initial migration state for `South`_. You can alternatively
            use ``syncdb`` and ``migrate`` if preferred.
        
        You should then be able to browse to http://127.0.0.1:8000/admin/ and log
        in using the default account (``username: admin, password: default``). If
        you'd like to specify a different username and password during set up, simply
        exclude the ``--noinput`` option included above when running ``createdb``.
        
        Integrating an Existing Django Project
        ======================================
        
        Mezzanine is structured as a regular Django project, and as such allows you
        to add other third party Django apps to your Mezzanine project as required.
        Inversely, you can add Mezzanine to an existing project by copying the
        relevant parts from Mezzanine's `project_template`_  package:
        
          * Settings defined in the ``settings`` module.
          * URL patterns defined in the ``urls`` module.
        
        Take the time to look over Mezzanine's ``project_template.settings`` module,
        as it contains many optional settings commented out. Of particular note when
        integrating with an existing project are the following:
        
          * ``INSTALLED_APPS``
          * ``TEMPLATE_CONTEXT_PROCESSORS``
          * ``MIDDLEWARE_CLASSES``
          * ``PACKAGE_NAME_*`` (for `django-grappelli`_ and `django-filebrowser`_ integration)
          * The call to ``mezzanine.utils.conf.set_dynamic_settings`` at the very end of the ``settings`` module.
        
        Contributing
        ============
        
        Mezzanine is an open source project that is managed using both Git and
        Mercurial version control systems. These repositories are hosted on both
        `GitHub`_ and `Bitbucket`_ respectively, so contributing is as easy as
        forking the project on either of these sites and committing back your
        enhancements.
        
        Please note the following points around contributing:
        
          * Contributed code must be written in the existing style. This is as simple as following the `Django coding style`_ and most importantly `PEP 8`_.
          * Contributions must be available on a separately named branch that is based on the latest version of the main branch.
          * Run the tests before committing your changes. If your changes causes the tests to break, they won't be accepted.
          * If you're adding new functionality, you must include basic tests and documentation.
        
        Third-party Modules
        ===================
        
        The following modules have been developed outside of Mezzanine. If you
        have developed a module to integrate with Mezzanine and would like it
        listed here, send an email to the `mezzanine-users`_ mailing list.
        
          * `mezzanine-html5boilerplate`_ - Integrates the `html5boilerplate project`_ into Mezzanine.
          * `mezzanine-mdown`_ - Adds `Markdown`_ support to Mezzanine's rich text editor.
          * `mezzanine-openshift`_ Setup for running Mezzanine on `Redhat's OpenShift`_ cloud platform.
          * `mezzanine-stackato`_ Setup for running Mezzanine on `ActiveState's Stackato`_ cloud platform.
        
        Donating
        ========
        
        If you would like to make a donation to continue development of the
        project, you can do so via the `Mezzanine Project`_ website.
        
        Support
        =======
        
        For general questions or comments, please join the
        `mezzanine-users`_ mailing list. To report a bug or other type of issue,
        please use the `GitHub issue tracker`_.
        
        Sites Using Mezzanine
        =====================
        
          * `Citrus Agency <http://citrus.com.au>`_
          * `Mezzanine Project <http://mezzanine.jupo.org>`_
          * `Nick Hagianis <http://hagianis.com>`_
          * `Thomas Johnson <http://tomfmason.net>`_
          * `Central Mosque Wembley <http://wembley-mosque.co.uk>`_
          * `Ovarian Cancer Research Foundation <http://ocrf.com.au>`_
          * `The Source Procurement <http://thesource.com.au>`_
          * `Imageinary <http://imageinary.com>`_
          * `Brad Montgomery <http://blog.bradmontgomery.net>`_
          * `Jashua Cloutier <http://www.senexcanis.com>`_
          * `Alpha & Omega Contractors <http://alphaomegacontractors.com>`_
          * `Equity Advance <http://equityadvance.com.au>`_
          * `Head3 Interactive <http://head3.com>`_
          * `PyLadies <http://www.pyladies.com>`_
          * `Ripe Maternity <http://www.ripematernity.com>`_
          * `Cotton On <http://shop.cottonon.com>`_
          * `List G Barristers <http://www.listgbarristers.com.au>`_
          * `Tri-Cities Flower Farm <http://www.tricitiesflowerfarm.com>`_
          * `daon.ru <http://daon.ru>`_
          * `autoindeks.ru <http://autoindeks.ru>`_
          * `immiau.ru <http://immiau.ru>`_
          * `ARA Consultants <http://www.araconsultants.com.au>`_
          * `Boîte à Z'images <http://boiteazimages.com>`_
          * `The Melbourne Cup <http://www.melbournecup.com>`_
          * `Diablo News <http://www.diablo-news.com>`_
          * `Goldman Travel <http://www.goldmantravel.com.au>`_
          * `IJC Digital <http://ijcdigital.com>`_
          * `Coopers <http://store.coopers.com.au>`_
          * `Joe Julian <http://joejulian.name>`_
          * `Sheer Ethic <http://sheerethic.com>`_
          * `Salt Lake Magazine <http://saltlakemagazine.com>`_
          * `Boca Raton Magazine <http://bocamag.com>`_
          * `Photog.me <http://www.photog.me>`_
          * `Elephant Juice Soup <http://www.elephantjuicesoup.com>`_
          * `National Positions <http://www.nationalpositions.co.uk>`_
          * `Like Humans Do <http://www.likehumansdo.com>`_
        
        Quotes
        ======
        
          * "I'm enjoying working with Mezzanine, it's good work"
            - `Van Lindberg`_, engineer, IP lawyer for the `Python Software Foundation`_
          * "Mezzanine looks like it may be Django's killer app"
            - `Antonio Rodriguez`_, ex CTO of `Hewlett Packard`_, founder of `Tabblo`_
          * "Mezzanine looks pretty interesting, tempting to get me off Wordpress"
            - `Jesse Noller`_, Python core contributor, `Python Software Foundation`_ board member
          * "Mezzanine is amazing"
            - `Audrey Roy`_, founder of `PyLadies`_ and `Django Packages`_
          * "Mezzanine convinced me to switch from the Ruby world over to Python"
            - `Michael Delaney`_, developer
          * "Impressed with Mezzanine so far"
            - `Brad Montgomery`_, founder of `Work For Pie`_
          * "From the moment I installed Mezzanine, I have been delighted, both with the initial experience and the community involved in its development"
            - `John Campbell`_, founder of `Head3 Interactive`_
          * "You need to check out the open source project Mezzanine. In one word: Elegant"
            - `Nick Hagianis`_, developer
          * "Who came up with the name Mezzanine? I love it, like a platform between the client's ideas and their published website. Very classy!"
            - `Stephen White`_, developer
        
        .. GENERAL LINKS
        
        .. _`Django`: http://djangoproject.com/
        .. _`BSD licensed`: http://www.linfo.org/bsdlicense.html
        .. _`Wordpress`: http://wordpress.org/
        .. _`Pinax`: http://pinaxproject.com/
        .. _`Mingus`: http://github.com/montylounge/django-mingus
        .. _`Mezzanine project page`: http://mezzanine.jupo.org
        .. _`Python`: http://python.org/
        .. _`pip`: http://www.pip-installer.org/
        .. _`setuptools`: http://pypi.python.org/pypi/setuptools
        .. _`Python Imaging Library`: http://www.pythonware.com/products/pil/
        .. _`grappelli-safe`: http://github.com/stephenmcd/grappelli-safe
        .. _`filebrowser-safe`: http://github.com/stephenmcd/filebrowser-safe/
        .. _`django-grappelli`: http://code.google.com/p/django-grappelli/
        .. _`django-filebrowser`: http://code.google.com/p/django-filebrowser/
        .. _`South`: http://south.aeracode.org/
        .. _`pyflakes`: http://pypi.python.org/pypi/pyflakes
        .. _`pep8`: http://pypi.python.org/pypi/pep8
        .. _`In-line page editing`: http://mezzanine.jupo.org/docs/inline-editing.html
        .. _`custom content types`: http://mezzanine.jupo.org/docs/content-architecture.html#creating-custom-content-types
        .. _`Search engine and API`: http://mezzanine.jupo.org/docs/search-engine.html
        .. _`dashboard`: http://mezzanine.jupo.org/docs/admin-customization.html#dashboard
        .. _`Cartridge`: http://cartridge.jupo.org/
        .. _`Themes`: http://mezzanine.jupo.org/docs/themes.html
        .. _`Custom templates`: http://mezzanine.jupo.org/docs/content-architecture.html#page-templates
        .. _`test suite`: http://mezzanine.jupo.org/docs/packages.html#module-mezzanine.tests
        .. _`Twitter Bootstrap`: http://twitter.github.com/bootstrap/
        .. _`Disqus`: http://disqus.com/
        .. _`Gravatar`: http://gravatar.com/
        .. _`Google Analytics`: http://www.google.com/analytics/
        .. _`Twitter`: http://twitter.com/
        .. _`bit.ly`: http://bit.ly/
        .. _`project_template`: https://github.com/stephenmcd/mezzanine/tree/master/mezzanine/project_template
        .. _`GitHub`: http://github.com/stephenmcd/mezzanine/
        .. _`Bitbucket`: http://bitbucket.org/stephenmcd/mezzanine/
        .. _`mezzanine-users`: http://groups.google.com/group/mezzanine-users/topics
        .. _`GitHub issue tracker`: http://github.com/stephenmcd/mezzanine/issues
        .. _`Django coding style`: http://docs.djangoproject.com/en/dev/internals/contributing/#coding-style
        .. _`PEP 8`: http://www.python.org/dev/peps/pep-0008/
        .. _`Python Software Foundation`: http://www.python.org/psf/
        .. _`Django Packages`: http://djangopackages.com/
        .. _`Hewlett Packard`: http://www.hp.com/
        .. _`Tabblo`: http://www.tabblo.com/
        .. _`Work For Pie`: http://workforpie.com/
        
        
        .. THIRD PARTY LIBS
        
        .. _`mezzanine-html5boilerplate`: https://github.com/tvon/mezzanine-html5boilerplate
        .. _`html5boilerplate project`: http://html5boilerplate.com/
        .. _`mezzanine-mdown`: https://bitbucket.org/onelson/mezzanine-mdown
        .. _`Markdown`: http://en.wikipedia.org/wiki/Markdown
        .. _`mezzanine-openshift`: https://github.com/k4ml/mezzanine-openshift
        .. _`Redhat's OpenShift`: https://openshift.redhat.com/
        .. _`mezzanine-stackato`: https://github.com/ActiveState/mezzanine-stackato
        .. _`ActiveState's Stackato`: http://www.activestate.com/stackato
        
        .. PEOPLE WITH QUOTES
        
        .. _`Van Lindberg`: http://www.lindbergd.info/
        .. _`Antonio Rodriguez`: http://an.ton.io/
        .. _`Jesse Noller`: http://jessenoller.com/
        .. _`Audrey Roy`: http://cartwheelweb.com/
        .. _`Michael Delaney`: http://github.com/fusepilot/
        .. _`John Campbell`: http://head3.com/
        .. _`Stephen White`: http://bitbucket.org/swhite/
        
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
Classifier: Topic :: Internet :: WWW/HTTP :: WSGI
Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
Classifier: Topic :: Software Development :: Libraries :: Python Modules
