Skip to content

Commit

Permalink
Bump version 3.7.0.rc1
Browse files Browse the repository at this point in the history
  • Loading branch information
phorward committed Oct 30, 2024
1 parent 743600b commit a0aa0a2
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 11 deletions.
4 changes: 3 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

This file documents any relevant changes done to ViUR-core since version 3.

## [3.7.0.beta4]
## [3.7.0.rc1]

- chore: Adding file deprecations (#1268)
- chore: Drop python 3.10 support (#1175)
Expand All @@ -14,6 +14,7 @@ This file documents any relevant changes done to ViUR-core since version 3.
- feat: `render.render()` generalized action skel rendering (#1270)
- feat: `Skeleton.patch()` for transactional read/write (#1267)
- feat: `UriBone` (#1254)
- feat: Add `File.get_download_url()` (#1305)
- feat: Add `PeriodicTask` can handle `timedelta` as interval (#1133)
- feat: Add `PhoneBone` (#1205)
- feat: Add `read` method for `RefSkel` (#1193)
Expand Down Expand Up @@ -45,6 +46,7 @@ This file documents any relevant changes done to ViUR-core since version 3.
- fix: `SpamBone` regression of descr-property (#1246)
- fix: `uploadKey` wrong in `getUploadUrl` (#1301)
- fix: Add datetime import in email.py (#1225)
- fix: Add default param for `createRelSkelFromKey` (#1304)
- fix: Calling `db.KeyHelper` with `None` raises a unhandled `NotImplementedError` (#1281)
- fix: Clean-up `KeyBone` and added unserialization (#1204)
- fix: Cleanly collect renders from Python module (#1230)
Expand Down
19 changes: 10 additions & 9 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,35 +41,35 @@ If there are documentation changes to review, there should be a 'doc-review' tag

## Coding Convention

* Fundamentally, we try to follow [PEP 8](https://peps.python.org/pep-0008).
* Fundamentally, we try to follow [PEP 8](https://peps.python.org/pep-0008).
Old code syntax, will be updated gradually so that there are only few breaking changes.
* `snake_case` for variables, filenames, bone names
* `PascalCase` for classes
* `UPPER_CASE_WITH_UNDERSCORE` for constants, enums
* We use the [Sphinx docstring format](https://sphinx-rtd-tutorial.readthedocs.io/en/latest/docstrings.html#the-sphinx-docstring-format).
Apart from that we follow [PEP 257](https://peps.python.org/pep-0257)
* bone names and skeletons should be written in Singular -- even if they are `multiple=True`
* bone names and skeletons should be written in Singular -- even if they are `multiple=True`
* _Skeleton_ classes should end with `Skel`, not `Skeleton`
* We use double quotes (`"`) for strings. Except, if we have to write a string inside an f-string
* We write bones always multiline; One line per argument
* Multiline dicts, lists and bones should end with a trailing comma `,` like
```py
data = {
"foo": 1,
"bar": 2, # <-- add here always a comma!
"bar": 2, # <-- add here always a comma!
}
```
* type hints should always be used everywhere. We do not write additional type definitions in the docstring.
* type hints should always be used everywhere. We do not write additional type definitions in the docstring.
```py
# We import the `typing` module only aliased as the shorthand `t`:
import typing as t

# Furthermore we prefer generics over the typing types
def the_preferred_way(data: dict[str, list[int]]) -> set[str]: ...
def please_not_like_this(data: t.Dict[str, t.List[int]]) -> t.Set[str]: ...

# If the types support it, we use the merge operator `|` (pipe) instead of t.Union
MULTIPLE_TYPES_ALLOWED = list[str | int | db.Key]
MULTIPLE_TYPES_ALLOWED = list[str | int | db.Key]
```


Expand Down Expand Up @@ -116,8 +116,9 @@ In case you have appropriate permissions, a release can be done this way:
`viur-core` has currently 3 actively maintained branches.

- 1. **3.5** is the current stable LTS version as released on PyPI (3.5.x)
- 2. **main** is the current stable version as released on PyPI (3.6.x)
- 3. **develop** is the next minor version and may be released as release candidates to PyPI (3.7.x)
- 2. **3.6** is the current stable version as released on PyPI (3.6.x)
- 3. **main** is the current version as released on PyPI (3.7.x)
- 4. **develop** is the next minor version and may be released as release candidates to PyPI (3.8.x)

Pull request should be made against one of these branches.

Expand Down
2 changes: 1 addition & 1 deletion src/viur/core/version.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
# This will mark it as a pre-release as well on PyPI.
# See CONTRIBUTING.md for further information.

__version__ = "3.7.0.beta4"
__version__ = "3.7.0.rc1"

assert __version__.count(".") >= 2 and "".join(__version__.split(".", 3)[:3]).isdigit(), \
"Semantic __version__ expected!"

0 comments on commit a0aa0a2

Please sign in to comment.