Metadata-Version: 1.1
Name: plock
Version: 0.1.3
Summary: Plock is a Plone Installer for the Pip-loving Crowd
Home-page: https://github.com/aclark4life/plock
Author: Alex Clark
Author-email: aclark@aclark.net
License: Whatever license Plone is
Description: plock
        =====
        
        Plock is a Plone Installer for the Pip-loving Crowd
        
        .. image:: https://travis-ci.org/aclark4life/plock.png?branch=master
        
        Installation
        ------------
        
        .. Note:: Installing Plone with Plock requires an internet connection. If you want to install off-line, try the `Unified Installer <http://plone.org/download>`_.
        
        .. Note:: Plock supports the latest release (and only the latest release) of Plone, currently Plone 4.3.
        
        Installing and running Plone with Plock looks like this::
        
            $ virtualenv-2.7 .
            $ source bin/activate
        
        ::
        
            $ pip install plock
            $ plock
            Plock is installing things. This may take a while.......(3)....(4)....(4)....(4)....(5)....(5)....(9)....(14)....(21)....(24)....(29)....(33)....(38)....(43)....(48)....(54)....(58)....(62)....(66)....(71)....(74)....(78)....(78)....(83)....(87)....(89)....(92)....(97)....(98)....(98)....(98)....(98)....(98)....(100)....(102)....(103)....(108)....(110)....(113)....(115)....(120)....(123)....(128)....(133)....(138)....(142)....(148)....(153)....(158)....(161)....(163)....(168)....(171)....(175)....(179)....(181)....(184)....(189)....(193)....(195)....(198)....(203)....(205)....(210)....(214)....(221)....(224)....(228)....(234). done.
        
        ::
        
            $ plone fg
        
        Configuration
        -------------
        
        Plone uses `Buildout <https://pypi.python.org/pypi/zc.buildout>`_ to manage its installation and configuration. Plock creates a ``buildout.cfg`` file for you that initially looks like this::
        
            [buildout]
            extends = release.cfg
        
        ``release.cfg`` extends several other configuration files located in the current working directory (created by the installer).
        
        Add-ons 
        ~~~~~~~
        
        .. Warning:: Plock lists packages on PyPI with a description, keyword, or summary containing "plone". Results may include packages that are not installable in the current release of Plone. This issue may be addressed in a future release of plock.
        
        To list available add-ons::
        
            $ plock --list-addons
        
        To install add-ons, add the desired Python package name(s) to the command line e.g.::
        
            $ plock --add-on Products.PloneFormGen
        
        Restart Plone and install the add-on(s) in Plone via Site Setup -> Add-ons. After you install add-ons with Plock your ``buildout.cfg`` file will look like this::
        
            [buildout]
            extends = release.cfg
        
            [plone]
            eggs = 
                ${base:packages}
                ${version:packages}
                Products.PloneFormGen
        
        Advanced
        ~~~~~~~~
        
        Buildout
        ++++++++
        
        If you are already familiar with ``Buildout``, you may be using a ``~/.buildout/default.cfg`` file to define various settings such as the Buildout ``eggs-directory``. In this case, you probably want to use the eggs installed in your already-defined eggs-directory (rather than letting Plock create and populate a new eggs-directory). To configure such behavior, set PLOCK_EXPERT to True e.g.::
        
            $ export PLOCK_EXPERT=True
        
        Now Plock will respect your ``~/.buildout/default.cfg`` settings.
        
        Zope2
        +++++
        
        If you'd like to install Zope2 only, you can do that with::
        
            $ plock --zope2-only
        
        FAQ
        ---
        
        Why bother building Plock on top of Buildout? 
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
        
        Plock is a work around for ``pip install Plone`` which works but requires a lengthy requirements.txt, and lacks additional features provided by Buildout that are needed to use ``pip install Plone`` effectively.
        
        Why bother supporting pip? 
        ~~~~~~~~~~~~~~~~~~~~~~~~~~
        
        To advance the state of Plone such that Buildout can be used, but not required.
        
        Why make Buildout optional? 
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~
        
        To market Plone to Python programmers who are generally more familiar with pip than Buildout.
        
        Why the name Plock?
        ~~~~~~~~~~~~~~~~~~~
        
        Plock is a `single by the band Plone <http://www.youtube.com/watch?v=IlLzsF61n-8>`_.
        
        Known Issues
        ------------
        
        Experimental Zope2 support
        ~~~~~~~~~~~~~~~~~~~~~~~~~~
        
        - If a non-PLOCK_EXPERT were to run ``plock -z`` successfully once, subsequent runs of plock (with no arguments) will continue to build Zope2. During this time, the egg total increases from 70 to 200+ and the built-in self-destruct mechanism (PLOCK_TIMEOUT) will trigger.
        
        - Add-ons are not supported for Zope2
        
        Changelog
        =========
        
        0.1.3 (2013-07-31)
        ------------------
        
        - New features:
            - Added experimental ``--zope2-only`` option to install Zope2 only.
        - Bug fixes:
            - Exit Plock when egg count remains the same for longer than or equal to PLOCK_TIMEOUT
        
        0.1.2 (2013-07-29)
        ------------------
        
        - Document PLOCK_EXPERT environment variable to respect ``.buildout/default.cfg``
        - Bug fixes:
            - Fixed ref to ``args.add_on`` via ``--preserve``
        
        0.1.1 (2013-07-28)
        ------------------
        
        - Fix "brown bag"
        
        0.1.0 (2013-07-28)
        ------------------
        
        - Make "secure"
            - All Buildout configuration files (for Plone, Zope2, the ZTK, etc.) are included in plock; this eliminates the possibility of a MITM-attack via remote extends (now you just need to trust PyPI and dist.plone.org.)
        
        - Changed features:
            - Renamed script: ``install-plone`` to ``plock``.
            - Renamed arg: ``--install-addons`` to ``--add-on`` (to improve argparse-provided usage statement).
        
        0.0.9 (2013-07-25)
        ------------------
        
        - Bug fixes:
            - Don't print "Wrote buildout.cfg" if buildout.cfg exists.
        
        0.0.8 (2013-07-25)
        ------------------
        
        - New features:
            - Added --write-config to write buildout.cfg and exit.
        
        0.0.7 (2013-07-24)
        ------------------
        
        - Bug fixes:
            - Restore -U
        
        0.0.6 (2013-07-24)
        ------------------
        
        - Bug fixes:
            - Make sure addons list is sorted.
        
        0.0.5 (2013-07-24)
        ------------------
        
        - New features:
            - Added ``--raw``, for use with ``--list-addons`` e.g. bin/install-plone --list--addons --raw
            - Added ``--preserve`` for use with ``--install-addons`` e.g. bin/install-plone --install-addons Products.PloneFormGen --preserve
        - Bug fixes:
            - bin/install-plone --install-addons PACKAGE(S) can now be run the first time to install both Plone and add-ons.
            - bin/install-plone --install-addons PACKAGE(S) saves a copy of buildout.cfg and reverts changes if a Buildout run fails.
        
        0.0.4 (2013-07-23)
        ------------------
        
        - Provide updated add-on installation instructions
        - Install add-ons with bin/install-plone --install-addons PACKAGE(S)
        
        0.0.3 (2013-07-22)
        ------------------
        
        - List add-ons with bin/install-plone --list-addons
        
        0.0.2 (2013-07-19)
        ------------------
        
        - Provide add-on installation instructions
        - Write local ``buildout.cfg`` instead of relying on -c remote_cfg.cfg
        
        0.0.1 (2013-07-15)
        ------------------
        
        - Initial release
        
Keywords: buildout pip plone virtualenv zope
Platform: UNKNOWN
Classifier: Framework :: Plone :: 4.3
Classifier: Programming Language :: Python :: 2.7
