Merge branch 'main' into dependabot/pip/dot-github/workflows/pip-23.2

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,28 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ""
+labels: "needs triage"
+assignees: "openfinch"
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Stacktrace**
+If applicable, add a stacktrace to help explain your problem.
+
+**Environment (please complete the following information):**
+
+- OS: [e.g. iOS]
+- Python version: [e.g. 3.11, 3.7]
+- Python-JMAP Version: [e.g. 0.0.2]
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,19 @@
+---
+  name: Feature request
+  about: Suggest an improvement for this project
+  title: ''
+  labels: 'needs triage'
+  assignees: '@openfinch'
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/labels.yml

@@ -61,6 +61,9 @@
 - name: testing
   description: Testing
   color: b1fc6f
+- name: needs triage
+  description: This issue requires triage
+  color: bfd4f2
 - name: wontfix
   description: This will not be worked on
   color: ffffff

.github/pull_request_template.md

@@ -0,0 +1,13 @@
+🚨 Please review the [guidelines for contributing](https://github.com/boopmail/python-jmap/blob/main/CONTRIBUTING.md) to this repository.
+
+### Checklist
+
+- [ ] Ensure you are requesting to **pull a feature/bugfix branch** (right side). Please do not request from your trunk!
+- [ ] Ensure you are making a pull request against the **`main` branch** (left side).
+- [ ] Refer to the [guidelines for contributing](https://github.com/boopmail/python-jmap/blob/main/CONTRIBUTING.md) to confirm that you are meeting our code-style requirements.
+- [ ] Ensure your code additions will pass our linting and test suite; you can verify this locally by running `nox`.
+- [ ] Verify that your code aligns with the [JMAP specification](https://jmap.io/spec.html).
+
+### Description
+
+> Please describe your pull request, making reference to the [JMAP specification](https://jmap.io/spec.html) where relevant.

.github/release-drafter.yml

@@ -27,3 +27,16 @@ template: |
   ## Changes
 
   $CHANGES
+version-resolver:
+  major:
+    labels:
+      - "major"
+  minor:
+    labels:
+      - "minor"
+  patch:
+    labels:
+      - "patch"
+  default: patch
+name-template: "v$RESOLVED_VERSION"
+tag-template: "v$RESOLVED_VERSION"

.github/workflows/release-stable.yml

@@ -0,0 +1,49 @@
+name: Release
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  release:
+    name: Release to PyPI
+    if: startsWith(github.ref, 'refs/tags/')
+    runs-on: ubuntu-latest
+    environment:
+      name: PyPI
+      url: https://pypi.org/p/python-jmap
+    permissions:
+      id-token: write
+      contents: write
+    steps:
+      - name: Check out the repository
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 2
+
+      - name: Set up Python
+        uses: actions/setup-python@v4.6.1
+        with:
+          python-version: "3.10"
+
+      - name: Upgrade pip
+        run: |
+          pip install --constraint=.github/workflows/constraints.txt pip
+          pip --version
+
+      - name: Install Poetry
+        run: |
+          pip install --constraint=.github/workflows/constraints.txt poetry
+          poetry --version
+
+      - name: Bump version for release release
+        run: |
+          version=${GITHUB_REF#refs/*/}
+          poetry version $version
+
+      - name: Build package
+        run: |
+          poetry build --ansi
+
+      - name: Publish package on PyPI
+        uses: pypa/gh-action-pypi-publish@v1.8.7

.github/workflows/release.yml → .github/workflows/release-unstable.yml

@@ -7,52 +7,6 @@ on:
       - master
 
 jobs:
-  release:
-    name: Release to PyPI
-    if: startsWith(github.ref, 'refs/tags/')
-    runs-on: ubuntu-latest
-    environment:
-      name: PyPI
-      url: https://pypi.org/p/python-jmap
-    permissions:
-      id-token: write
-      contents: write
-    steps:
-      - name: Check out the repository
-        uses: actions/checkout@v3
-        with:
-          fetch-depth: 2
-
-      - name: Set up Python
-        uses: actions/setup-python@v4.6.1
-        with:
-          python-version: "3.10"
-
-      - name: Upgrade pip
-        run: |
-          pip install --constraint=.github/workflows/constraints.txt pip
-          pip --version
-
-      - name: Install Poetry
-        run: |
-          pip install --constraint=.github/workflows/constraints.txt poetry
-          poetry --version
-
-      - name: Build package
-        run: |
-          poetry build --ansi
-
-      - name: Publish package on PyPI
-        uses: pypa/gh-action-pypi-publish@v1.8.7
-
-      - name: Publish the release notes
-        uses: release-drafter/release-drafter@v5.24.0
-        with:
-          publish: true
-          tag: ${{ github.ref }}
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-
   test-release:
     name: Release to TestPyPI
     if: "!startsWith(github.ref, 'refs/tags/')"

README.md

@@ -1,4 +1,11 @@
-# Python JMAP Bindings
+<p align="center">
+  <a href="https://github.com/boopmail/python-jmap" rel="noopener">
+ <img width=200px height=200px src="https://github.com/boopmail/python-jmap/blob/main/docs/python-jmap-logo.png" alt="Python-JMAP logo"></a>
+</p>
+
+<h3 align="center">Python-JMAP</h3>
+
+<div align="center">
 
 [![PyPI](https://img.shields.io/pypi/v/python-jmap.svg)][pypi status]
 [![Status](https://img.shields.io/pypi/status/python-jmap.svg)][pypi status]
@@ -19,53 +26,51 @@
 [pre-commit]: https://github.com/pre-commit/pre-commit
 [black]: https://github.com/psf/black
 
-## Features
-
-- TODO
+</div>
 
-## Requirements
+---
 
-- TODO
+<p align="center"> Pydantic-enabled client bindings for the JSON Meta Application Protocol (JMAP).
+    <br>
+</p>
 
-## Installation
+## 📝 Table of Contents
 
-You can install _Python JMAP Bindings_ via [pip] from [PyPI]:
+- [About](#about)
+- [Usage](#usage)
+- [Built Using](#built_using)
+- [TODO](../TODO.md)
+- [Contributing](../CONTRIBUTING.md)
+- [Authors](#authors)
+- [Acknowledgments](#acknowledgement)
 
-```console
-$ pip install python-jmap
-```
-
-## Usage
+## 🧐 About <a name = "about"></a>
 
-Please see the [Command-line Reference] for details.
+Python-JMAP is provides a client interface for the JSON Meta Application Protocol (JMAP), built
+around the data validation and type conversion features of Pydantic. It implements the Core and Mail
+specifications, with Calendar and Contacts on the roadmap.
 
-## Contributing
+## 🎈 Usage <a name="usage"></a>
 
-Contributions are very welcome.
-To learn more, see the [Contributor Guide].
+Install with
 
-## License
+```shell
+pip install python-jmap
+```
 
-Distributed under the terms of the [MIT license][license],
-_Python JMAP Bindings_ is free and open source software.
+- [Documentation](https://python-jmap.readthedocs.io/en/latest/)
 
-## Issues
+## ⛏️ Built Using <a name = "built_using"></a>
 
-If you encounter any problems,
-please [file an issue] along with a detailed description.
+- [Pydantic](https://docs.pydantic.dev/latest/) - Pydantic
 
-## Credits
+## ✍️ Authors <a name = "authors"></a>
 
-This project was generated from [@cjolowicz]'s [Hypermodern Python Cookiecutter] template.
+- [@openfinch](https://github.com/openfinch) - Idea & Initial work
 
-[@cjolowicz]: https://github.com/cjolowicz
-[pypi]: https://pypi.org/
-[hypermodern python cookiecutter]: https://github.com/cjolowicz/cookiecutter-hypermodern-python
-[file an issue]: https://github.com/boopmail/python-jmap/issues
-[pip]: https://pip.pypa.io/
+See also the list of [contributors](https://github.com/boopmail/python-jmap/contributors) who participated in this project.
 
-<!-- github-only -->
+## 🎉 Acknowledgements <a name = "acknowledgement"></a>
 
-[license]: https://github.com/boopmail/python-jmap/blob/main/LICENSE
-[contributor guide]: https://github.com/boopmail/python-jmap/blob/main/CONTRIBUTING.md
-[command-line reference]: https://python-jmap.readthedocs.io/en/latest/usage.html
+- Repository template - [cjolowicz/cookiecutter-hypermodern-python](https://github.com/cjolowicz/cookiecutter-hypermodern-python)
+- README, PR and Issue templates - [kylelobo/The-Documentation-Compendium](https://github.com/kylelobo/The-Documentation-Compendium)