plone.api 2.2.3__tar.gz → 2.2.4__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (61) hide show
  1. {plone_api-2.2.3 → plone_api-2.2.4}/CHANGES.rst +9 -0
  2. {plone_api-2.2.3 → plone_api-2.2.4}/PKG-INFO +11 -5
  3. {plone_api-2.2.3 → plone_api-2.2.4}/README.md +0 -3
  4. {plone_api-2.2.3 → plone_api-2.2.4}/docs/contribute.md +10 -20
  5. {plone_api-2.2.3 → plone_api-2.2.4}/setup.py +2 -2
  6. {plone_api-2.2.3 → plone_api-2.2.4}/src/plone.api.egg-info/PKG-INFO +11 -5
  7. {plone_api-2.2.3 → plone_api-2.2.4}/CONTRIBUTING.rst +0 -0
  8. {plone_api-2.2.3 → plone_api-2.2.4}/LICENSE +0 -0
  9. {plone_api-2.2.3 → plone_api-2.2.4}/MANIFEST.in +0 -0
  10. {plone_api-2.2.3 → plone_api-2.2.4}/docs/about.md +0 -0
  11. {plone_api-2.2.3 → plone_api-2.2.4}/docs/content.md +0 -0
  12. {plone_api-2.2.3 → plone_api-2.2.4}/docs/env.md +0 -0
  13. {plone_api-2.2.3 → plone_api-2.2.4}/docs/group.md +0 -0
  14. {plone_api-2.2.3 → plone_api-2.2.4}/docs/index.md +0 -0
  15. {plone_api-2.2.3 → plone_api-2.2.4}/docs/portal.md +0 -0
  16. {plone_api-2.2.3 → plone_api-2.2.4}/docs/relation.md +0 -0
  17. {plone_api-2.2.3 → plone_api-2.2.4}/docs/user.md +0 -0
  18. {plone_api-2.2.3 → plone_api-2.2.4}/pyproject.toml +0 -0
  19. {plone_api-2.2.3 → plone_api-2.2.4}/setup.cfg +0 -0
  20. {plone_api-2.2.3 → plone_api-2.2.4}/src/plone/__init__.py +0 -0
  21. {plone_api-2.2.3 → plone_api-2.2.4}/src/plone/api/__init__.py +0 -0
  22. {plone_api-2.2.3 → plone_api-2.2.4}/src/plone/api/configure.zcml +0 -0
  23. {plone_api-2.2.3 → plone_api-2.2.4}/src/plone/api/content.py +0 -0
  24. {plone_api-2.2.3 → plone_api-2.2.4}/src/plone/api/env.py +0 -0
  25. {plone_api-2.2.3 → plone_api-2.2.4}/src/plone/api/exc.py +0 -0
  26. {plone_api-2.2.3 → plone_api-2.2.4}/src/plone/api/group.py +0 -0
  27. {plone_api-2.2.3 → plone_api-2.2.4}/src/plone/api/portal.py +0 -0
  28. {plone_api-2.2.3 → plone_api-2.2.4}/src/plone/api/profiles/testfixture/metadata.xml +0 -0
  29. {plone_api-2.2.3 → plone_api-2.2.4}/src/plone/api/profiles/testfixture/types/Dexterity_Folder.xml +0 -0
  30. {plone_api-2.2.3 → plone_api-2.2.4}/src/plone/api/profiles/testfixture/types/Dexterity_Item.xml +0 -0
  31. {plone_api-2.2.3 → plone_api-2.2.4}/src/plone/api/profiles/testfixture/types.xml +0 -0
  32. {plone_api-2.2.3 → plone_api-2.2.4}/src/plone/api/relation.py +0 -0
  33. {plone_api-2.2.3 → plone_api-2.2.4}/src/plone/api/testing.zcml +0 -0
  34. {plone_api-2.2.3 → plone_api-2.2.4}/src/plone/api/tests/Dexterity_Folder.xml +0 -0
  35. {plone_api-2.2.3 → plone_api-2.2.4}/src/plone/api/tests/Dexterity_Item.xml +0 -0
  36. {plone_api-2.2.3 → plone_api-2.2.4}/src/plone/api/tests/__init__.py +0 -0
  37. {plone_api-2.2.3 → plone_api-2.2.4}/src/plone/api/tests/base.py +0 -0
  38. {plone_api-2.2.3 → plone_api-2.2.4}/src/plone/api/tests/doctests/about.md +0 -0
  39. {plone_api-2.2.3 → plone_api-2.2.4}/src/plone/api/tests/doctests/content.md +0 -0
  40. {plone_api-2.2.3 → plone_api-2.2.4}/src/plone/api/tests/doctests/env.md +0 -0
  41. {plone_api-2.2.3 → plone_api-2.2.4}/src/plone/api/tests/doctests/group.md +0 -0
  42. {plone_api-2.2.3 → plone_api-2.2.4}/src/plone/api/tests/doctests/portal.md +0 -0
  43. {plone_api-2.2.3 → plone_api-2.2.4}/src/plone/api/tests/doctests/relation.md +0 -0
  44. {plone_api-2.2.3 → plone_api-2.2.4}/src/plone/api/tests/doctests/user.md +0 -0
  45. {plone_api-2.2.3 → plone_api-2.2.4}/src/plone/api/tests/test_content.py +0 -0
  46. {plone_api-2.2.3 → plone_api-2.2.4}/src/plone/api/tests/test_doctests.py +0 -0
  47. {plone_api-2.2.3 → plone_api-2.2.4}/src/plone/api/tests/test_env.py +0 -0
  48. {plone_api-2.2.3 → plone_api-2.2.4}/src/plone/api/tests/test_group.py +0 -0
  49. {plone_api-2.2.3 → plone_api-2.2.4}/src/plone/api/tests/test_portal.py +0 -0
  50. {plone_api-2.2.3 → plone_api-2.2.4}/src/plone/api/tests/test_relation.py +0 -0
  51. {plone_api-2.2.3 → plone_api-2.2.4}/src/plone/api/tests/test_user.py +0 -0
  52. {plone_api-2.2.3 → plone_api-2.2.4}/src/plone/api/tests/test_validation.py +0 -0
  53. {plone_api-2.2.3 → plone_api-2.2.4}/src/plone/api/user.py +0 -0
  54. {plone_api-2.2.3 → plone_api-2.2.4}/src/plone/api/validation.py +0 -0
  55. {plone_api-2.2.3 → plone_api-2.2.4}/src/plone.api.egg-info/SOURCES.txt +0 -0
  56. {plone_api-2.2.3 → plone_api-2.2.4}/src/plone.api.egg-info/dependency_links.txt +0 -0
  57. {plone_api-2.2.3 → plone_api-2.2.4}/src/plone.api.egg-info/namespace_packages.txt +0 -0
  58. {plone_api-2.2.3 → plone_api-2.2.4}/src/plone.api.egg-info/not-zip-safe +0 -0
  59. {plone_api-2.2.3 → plone_api-2.2.4}/src/plone.api.egg-info/requires.txt +0 -0
  60. {plone_api-2.2.3 → plone_api-2.2.4}/src/plone.api.egg-info/top_level.txt +0 -0
  61. {plone_api-2.2.3 → plone_api-2.2.4}/tox.ini +0 -0
@@ -8,6 +8,15 @@ Changelog
8
8
 
9
9
  .. towncrier release notes start
10
10
 
11
+ 2.2.4 (2024-12-16)
12
+ ------------------
13
+
14
+ Documentation:
15
+
16
+
17
+ - Remove references to unused Coveralls. @stevepiercy (#543)
18
+
19
+
11
20
  2.2.3 (2024-10-23)
12
21
  ------------------
13
22
 
@@ -1,13 +1,13 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: plone.api
3
- Version: 2.2.3
3
+ Version: 2.2.4
4
4
  Summary: A Plone API.
5
5
  Home-page: https://github.com/plone/plone.api
6
6
  Author: Plone Foundation
7
7
  Author-email: plone-developers@lists.sourceforge.net
8
8
  License: GPL version 2
9
9
  Project-URL: Documentation, https://6.docs.plone.org/plone.api/index.html
10
- Project-URL: Changelog, https://github.com/plone/plone.api/blob/master/CHANGES.rst
10
+ Project-URL: Changelog, https://github.com/plone/plone.api/blob/main/CHANGES.rst
11
11
  Project-URL: Issue Tracker, https://github.com/plone/plone.api/issues
12
12
  Keywords: plone api
13
13
  Platform: Any
@@ -99,9 +99,6 @@ Issues
99
99
  Continuous Integration
100
100
  tested on [GitHub Actions](https://github.com/plone/plone.api/actions).
101
101
 
102
- Code Coverage
103
- is measured at [Coveralls.io](https://coveralls.io/github/plone/plone.api).
104
-
105
102
 
106
103
  Changelog
107
104
  =========
@@ -113,6 +110,15 @@ Changelog
113
110
 
114
111
  .. towncrier release notes start
115
112
 
113
+ 2.2.4 (2024-12-16)
114
+ ------------------
115
+
116
+ Documentation:
117
+
118
+
119
+ - Remove references to unused Coveralls. @stevepiercy (#543)
120
+
121
+
116
122
  2.2.3 (2024-10-23)
117
123
  ------------------
118
124
 
@@ -40,6 +40,3 @@ Issues
40
40
  Continuous Integration
41
41
  tested on [GitHub Actions](https://github.com/plone/plone.api/actions).
42
42
 
43
- Code Coverage
44
- is measured at [Coveralls.io](https://coveralls.io/github/plone/plone.api).
45
-
@@ -12,17 +12,14 @@ myst:
12
12
  This section describes how to contribute to the `plone.api` project.
13
13
  It extends {doc}`plone:contributing/index`.
14
14
 
15
-
16
15
  ## Prerequisites
17
16
 
18
17
  Prepare your system by installing prerequisites.
19
18
 
20
-
21
19
  ### System libraries
22
20
 
23
21
  You need to install system libraries, as described in {ref}`plone:plone-prerequisites-label`, with the exception of GNU make.
24
22
 
25
-
26
23
  ### tox
27
24
 
28
25
  [tox](https://tox.wiki/en/stable/index.html) automates and standardizes testing in Python.
@@ -49,7 +46,6 @@ Once installed, set up the git hook scripts to run on every commit.
49
46
  pre-commit install
50
47
  ```
51
48
 
52
-
53
49
  ## Create development environment
54
50
 
55
51
  After satisfying the prerequisites, you are ready to create your development environment.
@@ -81,7 +77,6 @@ tox -e livehtml # build, serve, and reload changes to documentation
81
77
  tox -l # list all tox environments
82
78
  ```
83
79
 
84
-
85
80
  (git-workflow)=
86
81
 
87
82
  ## git
@@ -89,24 +84,22 @@ tox -l # list all tox environments
89
84
  Use the following git branches when contributing to `plone.api`.
90
85
 
91
86
  feature branches
92
- : All development for a new feature or bug fix must be done on a new branch.
87
+ : All development for a new feature or bug fix must be done on a new branch.
93
88
 
94
- `master`
95
- : Pull requests should be made from a feature branch against the `master` branch.
96
- When features and bug fixes are complete and approved, they are merged into the `master` branch.
89
+ `main`
90
+ : Pull requests should be made from a feature branch against the `main` branch.
91
+ When features and bug fixes are complete and approved, they are merged into the `main` branch.
97
92
 
98
93
  ```{seealso}
99
94
  {ref}`plone:contributing-core-work-with-git-label`
100
95
  ```
101
96
 
102
-
103
97
  ## Continuous integration
104
98
 
105
99
  `plone.api` uses GitHub workflows for continuous integration.
106
- On every push to the `master` branch, GitHub runs its workflows for all tests and code quality checks.
100
+ On every push to the `main` branch, GitHub runs its workflows for all tests and code quality checks.
107
101
  GitHub workflows are configured in the directory `.github/workflows` at the root of this package.
108
102
 
109
-
110
103
  ## Documentation
111
104
 
112
105
  For every feature change or addition to `plone.api`, you must add documentation of it.
@@ -130,7 +123,6 @@ tox -e livehtml
130
123
 
131
124
  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/).
132
125
 
133
-
134
126
  ## Add a function to an existing module
135
127
 
136
128
  This section describes how to add a new function `foo` to `plone.api`.
@@ -171,8 +163,8 @@ def foo(path=None, UID=None):
171
163
  %
172
164
  % from plone.api.exc import InvalidParameterError
173
165
  % self.assertRaises(
174
- % InvalidParameterError,
175
- % lambda: foo("/plone/blog", "abcd001")
166
+ % InvalidParameterError,
167
+ % lambda: foo("/plone/blog", "abcd001")
176
168
  % )
177
169
 
178
170
  Add documentation in {file}`docs/api/content.md`.
@@ -235,10 +227,8 @@ The function references the narrative documentation via the label `content-foo-e
235
227
  The narrative documentation references the API function documentation via `` {meth}`api.content.foo` ``.
236
228
  The documentation is rendered with a link from the API reference to the narrative documentation, which in turn links back to the API reference.
237
229
 
238
-
239
230
  ## Resources
240
231
 
241
- - {doc}`plone:index`
242
- - [Source code](https://github.com/plone/plone.api)
243
- - [Issue tracker](https://github.com/plone/plone.api/issues)
244
- - [Code Coverage](https://coveralls.io/github/plone/plone.api)
232
+ - {doc}`plone:index`
233
+ - [Source code](https://github.com/plone/plone.api)
234
+ - [Issue tracker](https://github.com/plone/plone.api/issues)
@@ -3,7 +3,7 @@ from setuptools import find_packages
3
3
  from setuptools import setup
4
4
 
5
5
 
6
- version = "2.2.3"
6
+ version = "2.2.4"
7
7
 
8
8
  long_description = (
9
9
  f"{Path('README.md').read_text()}\n"
@@ -82,7 +82,7 @@ setup(
82
82
  platforms="Any",
83
83
  project_urls={
84
84
  "Documentation": "https://6.docs.plone.org/plone.api/index.html",
85
- "Changelog": "https://github.com/plone/plone.api/blob/master/CHANGES.rst",
85
+ "Changelog": "https://github.com/plone/plone.api/blob/main/CHANGES.rst",
86
86
  "Issue Tracker": "https://github.com/plone/plone.api/issues",
87
87
  },
88
88
  )
@@ -1,13 +1,13 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: plone.api
3
- Version: 2.2.3
3
+ Version: 2.2.4
4
4
  Summary: A Plone API.
5
5
  Home-page: https://github.com/plone/plone.api
6
6
  Author: Plone Foundation
7
7
  Author-email: plone-developers@lists.sourceforge.net
8
8
  License: GPL version 2
9
9
  Project-URL: Documentation, https://6.docs.plone.org/plone.api/index.html
10
- Project-URL: Changelog, https://github.com/plone/plone.api/blob/master/CHANGES.rst
10
+ Project-URL: Changelog, https://github.com/plone/plone.api/blob/main/CHANGES.rst
11
11
  Project-URL: Issue Tracker, https://github.com/plone/plone.api/issues
12
12
  Keywords: plone api
13
13
  Platform: Any
@@ -99,9 +99,6 @@ Issues
99
99
  Continuous Integration
100
100
  tested on [GitHub Actions](https://github.com/plone/plone.api/actions).
101
101
 
102
- Code Coverage
103
- is measured at [Coveralls.io](https://coveralls.io/github/plone/plone.api).
104
-
105
102
 
106
103
  Changelog
107
104
  =========
@@ -113,6 +110,15 @@ Changelog
113
110
 
114
111
  .. towncrier release notes start
115
112
 
113
+ 2.2.4 (2024-12-16)
114
+ ------------------
115
+
116
+ Documentation:
117
+
118
+
119
+ - Remove references to unused Coveralls. @stevepiercy (#543)
120
+
121
+
116
122
  2.2.3 (2024-10-23)
117
123
  ------------------
118
124
 
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes