WARNING: If you are reading this on GitHub, DON'T! Read it on ReadTheDocs:

http://ploneapi.readthedocs.org/en/latest/index.html so you have working

references and proper formatting.

A Plone API

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.

The intention of this package is to be transitional. It points out the parts of Plone which are particularly nasty -- we hope they will get fixed so that we can deprecate the plone.api methods that cover them up, but the documentation can still be useful.

Some parts of the documentation already are this way: they don't use plone.api methods directly, but simply provide guidance on achiving a task using Plone's internals. Example: usage of the catalog in content_find_example.

The intention is to cover 20% of the tasks we do 80% of the time. Keeping everything in one place helps keep the API introspectable and discoverable, which are important aspects of being Pythonic.

Note

This package is still under development, but should be fairly stable and is already being used in production. It's currently a release candidate, meaning that we don't intend to change method signatures, but it may still happen.

Narrative documentation

• About
  • Inspiration
  • Design decisions
  • FAQ
  • Roadmap
• Portal
  • Get portal object
  • Get navigation root
  • Get portal url
  • Get tool
  • Get localized time
  • Send E-Mail
  • Show notification message
  • Get plone.app.registry record
  • Set plone.app.registry record
  • Further reading
• Users
  • Create user
  • Get user
  • User properties
  • Get currently logged-in user
  • Check if current user is anonymous
  • Get all users
  • Get group's users
  • Delete user
  • Get user roles
  • Get user permissions
  • Grant roles to user
  • Revoke roles from user
  • Further reading
• Groups
  • Create group
  • Get group
  • Editing a group
  • Get all groups
  • Get user's groups
  • Get group members
  • Delete group
  • Adding user to group
  • Removing user from group
  • Get group roles
  • Grant roles to group
  • Revoke roles from group
  • Further reading
• Environment
  • Switch roles inside a block
  • Switch user inside a block
  • Further reading

Complete API and advanced usage

• List of all API methods with descriptions
• plone.api.portal
• plone.api.content
• plone.api.user
• plone.api.group
• plone.api.env
• plone.api.exc

Contributing

• How to contribute to this package?
  • Conventions
  • Local development environment
  • Releasing a new version
  • Changes

Indices and tables

• Index
• Module Index
• Search Page