plone.api 2.2.2__tar.gz → 2.2.4__tar.gz

{plone_api-2.2.2 → plone_api-2.2.4}/CHANGES.rst

@@ -8,6 +8,24 @@ Changelog
 
 .. towncrier release notes start
 
+2.2.4 (2024-12-16)
+------------------
+
+Documentation:
+
+
+- Remove references to unused Coveralls. @stevepiercy (#543)
+
+
+2.2.3 (2024-10-23)
+------------------
+
+Documentation:
+
+
+- Fixed spelling of prerequisites. @stevepiercy (#541)
+
+
 2.2.2 (2024-07-30)
 ------------------
 

{plone_api-2.2.2 → plone_api-2.2.4}/PKG-INFO

@@ -1,13 +1,13 @@
 Metadata-Version: 2.1
 Name: plone.api
-Version: 2.2.2
+Version: 2.2.4
 Summary: A Plone API.
 Home-page: https://github.com/plone/plone.api
 Author: Plone Foundation
 Author-email: plone-developers@lists.sourceforge.net
 License: GPL version 2
 Project-URL: Documentation, https://6.docs.plone.org/plone.api/index.html
-Project-URL: Changelog, https://github.com/plone/plone.api/blob/master/CHANGES.rst
+Project-URL: Changelog, https://github.com/plone/plone.api/blob/main/CHANGES.rst
 Project-URL: Issue Tracker, https://github.com/plone/plone.api/issues
 Keywords: plone api
 Platform: Any
@@ -99,9 +99,6 @@ Issues
 Continuous Integration
     tested on [GitHub Actions](https://github.com/plone/plone.api/actions).
 
-Code Coverage
-    is measured at [Coveralls.io](https://coveralls.io/github/plone/plone.api).
-
 
 Changelog
 =========
@@ -113,6 +110,24 @@ Changelog
 
 .. towncrier release notes start
 
+2.2.4 (2024-12-16)
+------------------
+
+Documentation:
+
+
+- Remove references to unused Coveralls. @stevepiercy (#543)
+
+
+2.2.3 (2024-10-23)
+------------------
+
+Documentation:
+
+
+- Fixed spelling of prerequisites. @stevepiercy (#541)
+
+
 2.2.2 (2024-07-30)
 ------------------
 

{plone_api-2.2.2 → plone_api-2.2.4}/README.md

@@ -40,6 +40,3 @@ Issues
 Continuous Integration
     tested on [GitHub Actions](https://github.com/plone/plone.api/actions).
 
-Code Coverage
-    is measured at [Coveralls.io](https://coveralls.io/github/plone/plone.api).
-

{plone_api-2.2.2 → plone_api-2.2.4}/docs/contribute.md

@@ -12,16 +12,13 @@ myst:
 This section describes how to contribute to the `plone.api` project.
 It extends {doc}`plone:contributing/index`.
 
+## Prerequisites
 
-## Pre-requisites
-
-Prepare your system by installing pre-requisites.
-
+Prepare your system by installing prerequisites.
 
 ### System libraries
 
-You need to install system libraries, as described in {ref}`plone:plone-pre-requisites-label`, with the exception of GNU make.
-
+You need to install system libraries, as described in {ref}`plone:plone-prerequisites-label`, with the exception of GNU make.
 
 ### tox
 
@@ -49,10 +46,9 @@ Once installed, set up the git hook scripts to run on every commit.
 pre-commit install
 ```
 
-
 ## Create development environment
 
-After satisfying the pre-requisites, you are ready to create your development environment.
+After satisfying the prerequisites, you are ready to create your development environment.
 `plone.api` uses `tox` as a wrapper around `coredev.buildout` to simplify development, whereas Plone core uses `coredev.buildout` directly.
 
 Start by changing your working directory to your project folder, and download the latest `plone.api` source code.
@@ -81,7 +77,6 @@ tox -e livehtml       # build, serve, and reload changes to documentation
 tox -l                # list all tox environments
 ```
 
-
 (git-workflow)=
 
 ## git
@@ -89,24 +84,22 @@ tox -l                # list all tox environments
 Use the following git branches when contributing to `plone.api`.
 
 feature branches
-:   All development for a new feature or bug fix must be done on a new branch.
+: All development for a new feature or bug fix must be done on a new branch.
 
-`master`
-:   Pull requests should be made from a feature branch against the `master` branch.
-    When features and bug fixes are complete and approved, they are merged into the `master` branch.
+`main`
+: Pull requests should be made from a feature branch against the `main` branch.
+When features and bug fixes are complete and approved, they are merged into the `main` branch.
 
 ```{seealso}
 {ref}`plone:contributing-core-work-with-git-label`
 ```
 
-
 ## Continuous integration
 
 `plone.api` uses GitHub workflows for continuous integration.
-On every push to the `master` branch, GitHub runs its workflows for all tests and code quality checks.
+On every push to the `main` branch, GitHub runs its workflows for all tests and code quality checks.
 GitHub workflows are configured in the directory `.github/workflows` at the root of this package.
 
-
 ## Documentation
 
 For every feature change or addition to `plone.api`, you must add documentation of it.
@@ -130,7 +123,6 @@ tox -e livehtml
 
 The [`plone.api` documentation](https://6.docs.plone.org/plone.api) is automatically generated from the documentation source files when its submodule is updated in the [main Plone `documentation` repository](https://github.com/plone/documentation/).
 
-
 ## Add a function to an existing module
 
 This section describes how to add a new function `foo` to `plone.api`.
@@ -171,8 +163,8 @@ def foo(path=None, UID=None):
 %
 % from plone.api.exc import InvalidParameterError
 % self.assertRaises(
-%     InvalidParameterError,
-%     lambda: foo("/plone/blog", "abcd001")
+% InvalidParameterError,
+% lambda: foo("/plone/blog", "abcd001")
 % )
 
 Add documentation in {file}`docs/api/content.md`.
@@ -235,10 +227,8 @@ The function references the narrative documentation via the label `content-foo-e
 The narrative documentation references the API function documentation via `` {meth}`api.content.foo` ``.
 The documentation is rendered with a link from the API reference to the narrative documentation, which in turn links back to the API reference.
 
-
 ## Resources
 
--   {doc}`plone:index`
--   [Source code](https://github.com/plone/plone.api)
--   [Issue tracker](https://github.com/plone/plone.api/issues)
--   [Code Coverage](https://coveralls.io/github/plone/plone.api)
+- {doc}`plone:index`
+- [Source code](https://github.com/plone/plone.api)
+- [Issue tracker](https://github.com/plone/plone.api/issues)

{plone_api-2.2.2 → plone_api-2.2.4}/setup.py

@@ -3,7 +3,7 @@ from setuptools import find_packages
 from setuptools import setup
 
 
-version = "2.2.2"
+version = "2.2.4"
 
 long_description = (
     f"{Path('README.md').read_text()}\n"
@@ -82,7 +82,7 @@ setup(
     platforms="Any",
     project_urls={
         "Documentation": "https://6.docs.plone.org/plone.api/index.html",
-        "Changelog": "https://github.com/plone/plone.api/blob/master/CHANGES.rst",
+        "Changelog": "https://github.com/plone/plone.api/blob/main/CHANGES.rst",
         "Issue Tracker": "https://github.com/plone/plone.api/issues",
     },
 )

{plone_api-2.2.2 → plone_api-2.2.4}/src/plone.api.egg-info/PKG-INFO

@@ -1,13 +1,13 @@
 Metadata-Version: 2.1
 Name: plone.api
-Version: 2.2.2
+Version: 2.2.4
 Summary: A Plone API.
 Home-page: https://github.com/plone/plone.api
 Author: Plone Foundation
 Author-email: plone-developers@lists.sourceforge.net
 License: GPL version 2
 Project-URL: Documentation, https://6.docs.plone.org/plone.api/index.html
-Project-URL: Changelog, https://github.com/plone/plone.api/blob/master/CHANGES.rst
+Project-URL: Changelog, https://github.com/plone/plone.api/blob/main/CHANGES.rst
 Project-URL: Issue Tracker, https://github.com/plone/plone.api/issues
 Keywords: plone api
 Platform: Any
@@ -99,9 +99,6 @@ Issues
 Continuous Integration
     tested on [GitHub Actions](https://github.com/plone/plone.api/actions).
 
-Code Coverage
-    is measured at [Coveralls.io](https://coveralls.io/github/plone/plone.api).
-
 
 Changelog
 =========
@@ -113,6 +110,24 @@ Changelog
 
 .. towncrier release notes start
 
+2.2.4 (2024-12-16)
+------------------
+
+Documentation:
+
+
+- Remove references to unused Coveralls. @stevepiercy (#543)
+
+
+2.2.3 (2024-10-23)
+------------------
+
+Documentation:
+
+
+- Fixed spelling of prerequisites. @stevepiercy (#541)
+
+
 2.2.2 (2024-07-30)
 ------------------