plone.api 1.4.3

A Plone API.

plone.api
=========

.. image:: https://pypip.in/v/plone.api/badge.png
:target: https://pypi.python.org/pypi/plone.api
:alt: Latest PyPI version

.. image:: https://pypip.in/d/plone.api/badge.png
:target: https://pypi.python.org/pypi/plone.api
:alt: Number of PyPI downloads

A simple API, built for humans wishing to develop with Plone.

The intention is

* to cover 20% of the tasks any Plone developer does 80% of the time,
* to provide clear API methods for Plone functionality which may be confusing or difficult to access,
* keeping everything in one place,
* staying introspectable and discoverable, important aspects of being Pythonic.


Documentation
=============

`plone.api documentation <http://docs.plone.org/external/plone.api/docs/contribute/index.html>`_ is part of the official plone documentation.

``plone.api`` 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.


Source Code and Contribution
============================

.. image:: https://secure.travis-ci.org/plone/plone.api.png
:target: http://travis-ci.org/#!/plone/plone.api

.. image:: https://coveralls.io/repos/plone/plone.api/badge.png?branch=master
:alt: Coverage
:target: https://coveralls.io/r/plone/plone.api?branch=master

Contributors
please read the document `Process for Plone core's development <http://docs.plone.org/develop/plone-coredev/index.html>`_.
Also consult the section about contribution in the `plone.api contributors documentation <http://docs.plone.org/external/plone.api/docs/contribute/index.html>`_.

Source-Code
at the `Plone code repository hosted at Github <https://github.com/plone/plone.api>`_.

Issues
Please use the `Issue-Tracker <http://github.com/plone/plone.api/issues>`_

Continuous Integration
runs on `Travis CI <http://travis-ci.org/plone/plone.api>`_.

Code Coverage
is measured at `Coveralls.io <http://coveralls.io/r/plone/plone.api>`_.

Changelog
=========

1.4.3 (2015-09-08)
------------------

- Try to get use_email_as_login from registry first.
[pbauer]


1.4.2 (2015-09-07)
------------------

- Use the version defined in Products.CMFPlone in env.plone_version, just like Plone's control panel.
Also fixes Jenkins testrunner where we don't have the Plone egg.
[jaroel]


1.4.1 (2015-09-07)
------------------

- Removed dependency on Products.CMFPlone to avoid circular dependencies. Products.CMFPlone will be there.
[jaroel]


1.4 (2015-09-04)
----------------

- plone.api.content.delete: add option check_linkintegrity. If True raise
exception if deleting would result in broken links.
[pbauer]

- plone.api.content.find: object_provides arguments accepts tuples.
Fixes #266.
[ale-rt]

- Fixed plone.api.content.create in Plone 5. Refs 160.
[jaroel]
- plone.api.content.transition: Now accepts kwargs that can be supplied to the workflow transition.
[neilferreira]

1.3.3 (2015-07-14)
------------------

- plone.api.content.get_state now allows for an optional default value.
This is used when no workflow is defined for the object. Refs #246
[jaroel]

- plone.api.portal.get_registry_record now suggests look-alike records when no records is found. Refs #249.
[jaroel]

- Fixed tests for Plone 5. Refs #241.
[jaroel]

- Support Products.PrintingMailHost. Refs #228.
[jaroel]

- api.plone.org docs point to docs.plone.org/external/plone.api/docs/. Refs #202
[jaroel]

- plone.api.content.get_view no longer swallows exceptions.
[jaroel]

- Add plone.api.content.find. Refs #210
[jaroel]

- Make send_email compatible with Plone >= 5.0b2.
[pbauer]

- Use the source's parent as a target when no target is specified.
[jaroel]

- Make Products.Archetypes dependency optional. Fixes #197
[jaroel]

- Added local TOCS to main docs pages. Fixes #90.
[jaroel]

- Allow deleting multiple objects. Fixes #198
[jaroel]

- Fixed `make docs`.
[jaroel]

- Support Zope users in user.adopt_user. Fixes #171 and #157.
[jaroel]

- explicit dependencies in setup.py, explicit zcml loading in tests.
[jensens]

- import getToolByName from origin location
[jensens]

- overhaul of documentation: semantic linebreaks, few links fixed, minor
rewording.
[jensens]

- fix ``revoke_roles`` method: now if is't called with obj parameter,
it doesn't set inherited roles locally.
[cekk]

1.3.2 (2014-11-17)
------------------

- fixes #190 - broken ``MANIFEST.in``.
[jensens]


1.3.1 (2014-11-17)
------------------

- Resolves issues with ``README.rst`` symlink that prevented 1.3.0 from
being installed. And please never ever in future use symlinks in eggs, ok?
[jensens]


1.3.0 (2014-11-17)
------------------

- Fixes #184 NameChooser on rename used the wrong way and fails on
safe_id=True.
[benniboy]

- Clarified documentation for content.copy, refs #185.
[benniboy]

- Fixes if a content is copied in the same folder or in a target folder, where
same source id exists, the existing source(same folder) or third object
(same id as source) gets renamed instead of the target.
[benniboy]

- Use getUserById to find the user when given a User object in adopt_user.
[tschanzt]

- Made ``api.portal.get_localized_time`` also work with datetime.date.
[nightmarebadger]

- Raise better/expected errors in ``api.user.grant_roles`` and
``api.user.revoke_roles``.
[adamcheasley]

- Add ``api.user.has_permission`` ref #172.
[adamcheasley]


1.2.1 (2014-06-24)
------------------

- Resolve issues with CHANGES.rst symlink that prevented 1.2.0 from
being installed in some circumstances.
[mattss]


1.2.0 (2014-06-24)
------------------

- Enhance ``api.content.transition`` with the ability to transition from the
current state to a given state without knowing the transition 'path'
refs. #162
[adamcheasley]

- Add ``api.env.plone_version()`` and ``api.env.zope_version()``, refs #126.
[hvelarde]

- Stop UnicodeDecodeErrors being swallowed in ``api.content.create``.
[mattss]

- Catch AttributeError in ``api.content.get`` (raised if only part of the
traversal path exists).
[mattss]


1.1.0 (2013-10-12)
------------------

- List supported Plone versions in setup.py.
[zupo]

- Plone 4.0 and 4.1 are now tested under Python 2.6 on CI.
[hvelarde]

- Use Plone 4.3 on development by default (was 4.2).
[hvelarde]


1.1.0-rc.1 (2013-10-10)
-----------------------

- Fix README.rst so it renders correctly on PyPI.
[zupo]

- Use api.plone.org/foo redirects.
[zupo]

- Add MANIFEST.in file.
[hvelarde]


1.0.0-rc.3 (2013-10-09)
-----------------------

- Packaging issues.
[zupo]


1.0.0-rc.2 (2013-10-09)
-----------------------

- Proof-read the docs, improved grammar and wording.
[cewing]

- Add plone.recipe.codeanalysis to our buildout.
[flohcim]

- Make all assertRaise() calls use the `with` keyword.
[winstonf88]

- Amend user.get method to accept a userid parameter, refs #112.
[cewing, xiru, winstonf88]

.. note::
This change fixes a bug in the earlier implementation that could cause
errors in some situations. This situation will only arise if the userid and
username for a user are not the same. If membrane is being used for content-
based user objects, or if email-as-login is enabled *and* a user has changed
their email address this will be the case. In the previous implementation
the username parameter was implicitly being treated as userid. The new
implementation does not do so. If consumer code is relying on this bug and
passing userid, and if that code uses the username parameter as a keyword
parameter, then lookup will fail. In all other cases, there should be no
difference.

- Add api.env.debug_mode() and api.env.test_mode(), refs #125.
[sdelcourt]

- Move most of text from docs/index.rst to README.rst so its also visible on
PyPI and GitHub.
[zupo]

- Deprecate plone.api on ReadTheDocs and redirect to api.plone.org, refs #130.
[wormj, zupo]

- Add a new `make coverage` command and add support for posting coverage to
Coveralls.io.
[zupo]

- Make api.content.create() also print out the underlying error, refs #118.
[winston88]

- Fix api.content copy/move/rename functions to return the object after they
change content, refs #115.
[rodfersou]

- Make Travis IRC notification message to be one-line instead of three-lines.
[zupo]

- More examples of good and bad code blocks in documentation, more information
on how to write good docstrings.
[zupo]

- Prefer single quotes over double quotes in code style.
[zupo]

- New bootstrap.py to stay in the land of zc.buildout 1.x.
[zupo]

- Package now includes a copy of the GPLv2 license as stated in the GNU
General Public License documentation.
[hvelarde]

- Fixed copying folderish objects.
[pingviini]

- Fixed moving folderish objects.
[pingviini]


1.0.0-rc.1 (2013-01-27)
-----------------------

- Increase test coverage.
[cillianderoiste, JessN, reinhardt, zupo]

- Implementation of ``api.env.adopt_roles()`` context manager for
temporarily switching roles inside a block.
[RichyB]

- Created ``api.env`` module for interacting with global environment.
[RichyB]

- Decorators for defining constraints on api methods. Depend on `decorator`
package.
[JessN]

- Resolved #61: Improve api.portal.get().
[cillianderoiste]

- Use plone.api methods in plone.api codebase.
[zupo]

- Switch to `flake8` instead of `pep8`+`pyflakes`.
[zupo]

- Get the portal path with absolute_url_path.
[cillianderoiste]

- Travis build speed-ups.
[zupo]

- Support for Python 2.6.
[RichyB, zupo]

- Support for Plone 4.0.
[adamcheasley]

- Support for Plone 4.3.
[cillianderoiste, zupo]

- Spelling fixes.
[adamtheturtle]

- Make get_view and get_tool tests not have hardcoded list of *all* expected
values.
[RichyB, cillianderoiste]

- Code Style Guide.
[iElectric, cillianderoiste, marciomazza, RichyB, thet, zupo]

- Depend on ``manuel`` in setup.py.
[zupo]

- Documentation how to get/set member properties.
[zupo]

- Improvements to ``get_registry_record``.
[zupo]


0.1b1 (2012-10-23)
------------------

- Contributors guide and style guide.
[zupo]

- Enforce PEP257 for docstrings.
[zupo]

- Fix ``get_navigation_root()`` to return object instead of path.
[pbauer]

- Implementation of ``get_permissions()``, ``get_roles()``,
``grant_roles()`` and ``revoke roles()`` for users and groups.
[rudaporto, xiru]

- Implementation of ``get_registry_record`` and ``set_registry_record``.
[pbauer]

- Use `Makefile` to build the project, run tests, generate documentation, etc.
[witsch]

- Moving all ReadTheDocs dependencies into ``rtd_requirements.txt``.
[zupo]


0.1a2 (2012-09-03)
------------------

- Updated release, adding new features, test coverage, cleanup & refactor.
[hvelarde, avelino, ericof, jpgimenez, xiru, macagua, zupo]


0.1a1 (2012-07-13)
------------------

- Initial release.
[davisagli, fulv, iElectric, jcerjak, jonstahl, kcleong, mauritsvanrees,
wamdam, witsch, zupo]
License
=======

Copyright (C) 2012-2013 Plone Foundation

This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License version 2
as published by the Free Software Foundation.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.