Metadata-Version: 1.1
Name: plone.api
Version: 1.0.0-rc.2
Summary: A Plone API.
Home-page: UNKNOWN
Author: Plone Foundation
Author-email: plone-developers@lists.sourceforge.net
License: GPL version 2
Description: plone.api
        =========
        
        .. topic:: Overview
        
            The ``plone.api`` is an elegant and simple API, built for humans wishing
            to develop with Plone.
        
            It comes with *cookbook*-like documentation and step-by-step instructions
            for doing common development tasks in Plone. Recipes try to assume the user
            does not have extensive knowledge about Plone internals.
        
        .. raw:: html
        
            <img src="http://travis-ci.org/plone/plone.api.png?&branch=master">
            <img src="http://coveralls.io/repos/plone/plone.api/badge.png">
        
        * `Documentation @ api.plone.org <http://api.plone.org>`_
        * `Source code @ GitHub <http://github.com/plone/plone.api>`_
        * `Issues @ GitHub <http://github.com/plone/plone.api/issues>`_
        * `Continuous Integration @ Travis CI <http://travis-ci.org/plone/plone.api>`_
        * `Code Coverage @ Coveralls.io <http://coveralls.io/r/plone/plone.api>`_
        
        The intention of this package is to provide clear API methods for Plone
        functionality which may be confusing or difficult to access. As the underlying
        code improves some API methods may be deprecated and the documentation here
        will be updated to show how to use the improved code (even if it means not
        using ``plone.api``)
        
        Some parts of the documentation do not use *plone.api* methods directly, but
        simply provide guidance on achieving a task using Plone's internal API. For
        example, using the portal catalog (see 'Find content objects').
        
        The intention is to cover 20% of the tasks any Plone developer does 80% of the
        time. By keeping everything in one place, the API stays introspectable and
        discoverable, important aspects of being Pythonic.
        
        .. note::
        
            This package is stable and used in production, but from time to time
            changes will be made to the API. Additional api methods may be introduced
            in minor versions (1.1 -> 1.2). Backward-incompatible changes to the API
            will be restricted to major versions (1.x -> 2.x).
        
        
Platform: Any
Classifier: Environment :: Web Environment
Classifier: Framework :: Plone
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU General Public License v2 (GPLv2)
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
