chore: Release 1.0.2

Update README.rst and CHANGELOG.md and add pdm.lock and cliff.toml to library.

CHANGELOG.md

@@ -1,5 +1,20 @@
 # Changelog
 
+## [1.0.2] - 2024-10-04
+
+### 📚 Documentation
+
+- Updated test badge and quality badge in README.rst
+
+### ⚙️ Miscellaneous Tasks
+
+- Add pdm.lock and cliff.toml
+- Update release.yml and python-package.yml
+- Send coverage report to codeclimate and codecov
+- Only send code coverage reports for changes made to the master branch
+- Add sonar-project.properties and update link to test badge
+- Update SonarCloud analysis in python-package.yml
+- Update .readthedocs.yml
 
 ## [1.0.1] - 2024-10-03
 

cliff.toml

@@ -0,0 +1,82 @@
+# git-cliff ~ default configuration file
+# https://git-cliff.org/docs/configuration
+#
+# Lines starting with "#" are comments.
+# Configuration options are organized into tables and keys.
+# See documentation for more information on available options.
+
+[changelog]
+# template for the changelog header
+header = """
+# Changelog\n
+"""
+# template for the changelog body
+# https://keats.github.io/tera/docs/#introduction
+body = """
+{% if version %}\
+    ## [{{ version | trim_start_matches(pat="v") }}] - {{ timestamp | date(format="%Y-%m-%d") }}
+{% else %}\
+    ## [unreleased]
+{% endif %}\
+{% for group, commits in commits | group_by(attribute="group") %}
+    ### {{ group | striptags | trim | upper_first }}
+    {% for commit in commits %}
+        - {% if commit.scope %}*({{ commit.scope }})* {% endif %}\
+            {% if commit.breaking %}[**breaking**] {% endif %}\
+            {{ commit.message | upper_first }}\
+    {% endfor %}
+{% endfor %}\n
+"""
+# template for the changelog footer
+footer = """
+<!-- generated by git-cliff -->
+"""
+# remove the leading and trailing s
+trim = true
+# postprocessors
+postprocessors = [
+  # { pattern = '<REPO>', replace = "https://github.com/orhun/git-cliff" }, # replace repository URL
+]
+# render body even when there are no releases to process
+# render_always = true
+# output file path
+# output = "test.md"
+
+[git]
+# parse the commits based on https://www.conventionalcommits.org
+conventional_commits = true
+# filter out the commits that are not conventional
+filter_unconventional = true
+# process each line of a commit as an individual commit
+split_commits = false
+# regex for preprocessing the commit messages
+commit_preprocessors = [
+  # Replace issue numbers
+  #{ pattern = '\((\w+\s)?#([0-9]+)\)', replace = "([#${2}](<REPO>/issues/${2}))"},
+  # Check spelling of the commit with https://github.com/crate-ci/typos
+  # If the spelling is incorrect, it will be automatically fixed.
+  #{ pattern = '.*', replace_command = 'typos --write-changes -' },
+]
+# regex for parsing and grouping commits
+commit_parsers = [
+  { message = "^feat", group = "<!-- 0 -->🚀 Features" },
+  { message = "^fix", group = "<!-- 1 -->🐛 Bug Fixes" },
+  { message = "^doc", group = "<!-- 3 -->📚 Documentation" },
+  { message = "^perf", group = "<!-- 4 -->⚡ Performance" },
+  { message = "^refactor", group = "<!-- 2 -->🚜 Refactor" },
+  { message = "^style", group = "<!-- 5 -->🎨 Styling" },
+  { message = "^test", group = "<!-- 6 -->🧪 Testing" },
+  { message = "^chore\\(release\\): prepare for", skip = true },
+  { message = "^chore\\(deps.*\\)", skip = true },
+  { message = "^chore\\(pr\\)", skip = true },
+  { message = "^chore\\(pull\\)", skip = true },
+  { message = "^chore|^ci", group = "<!-- 7 -->⚙️ Miscellaneous Tasks" },
+  { body = ".*security", group = "<!-- 8 -->🛡️ Security" },
+  { message = "^revert", group = "<!-- 9 -->◀️ Revert" },
+]
+# filter out the commits that are not matched by commit parsers
+filter_commits = false
+# sort the tags topologically
+topo_order = false
+# sort the commits inside sections by oldest/newest order
+sort_commits = "oldest"

src/nvector/__init__.py

@@ -5,7 +5,7 @@
 from .objects import *  # noqa
 from ._common import use_docstring
 
-__version__ = "1.0.1"
+__version__ = "1.0.2"
 
 _PACKAGE_NAME = __name__
 

src/nvector/_examples_object_oriented.py

@@ -4,7 +4,6 @@
 
 
 if __name__ == "__main__":
-    from nvector._common import write_readme, test_docstrings
+    from nvector._common import test_docstrings
 
     test_docstrings(__file__)
-    write_readme(__doc__)

src/nvector/_images.py

@@ -7,6 +7,9 @@
     .. |tests_img| image:: https://github.com/pbrod/nvector/actions/workflows/python-package.yml/badge.svg
         :target: https://github.com/pbrod/nvector/actions/
 
+    .. |quality_img| image:: https://sonarcloud.io/api/project_badges/measure?project=pbrod_nvector&metric=alert_status
+        :target: https://sonarcloud.io/project/overview?id=pbrod_nvector
+
     .. |docs_img| image:: https://readthedocs.org/projects/pip/badge/?version=stable
        :target: http://Nvector.readthedocs.org/en/stable/
 

src/nvector/_info.py

@@ -24,6 +24,7 @@
 
 
 if __name__ == "__main__":
-    from nvector._common import test_docstrings
+    from nvector._common import write_readme, test_docstrings
 
+    write_readme(__doc__)
     test_docstrings(__file__)

src/nvector/_intro.py

@@ -1,8 +1,9 @@
+# ruff: noqa: E501
 r"""
 
 .. only:: html
 
-    |pkg_img| |tests_img| |docs_img| |health_img| |coverage_img| |versions_img| |downloads_img|
+    |pkg_img| |tests_img| |quality_img| |docs_img| |health_img| |coverage_img| |versions_img| |downloads_img|
 
 
 The nvector library is a suite of tools written in Python to solve geographical position