Merge branch 'main' into turn-off-automatic-venv-activation-in-vs-cod…

…e-settings
dnv-opensource · May 2, 2024 · 71b7802 · 71b7802
2 parents 0f699a9 + c5f86ca
commit 71b7802
Show file tree

Hide file tree

Showing 19 changed files with 4,828 additions and 3,809 deletions.
diff --git a/.github/workflows/_code_quality.yml b/.github/workflows/_code_quality.yml
@@ -15,7 +15,7 @@ jobs:
       - name: Install dependencies
         run: pip install -r requirements.txt
       - name: Install ruff
-        run: pip install ruff==0.3.0
+        run: pip install ruff==0.4.2
       - name: Run ruff format
         run: ruff format --diff .
 
@@ -31,7 +31,7 @@ jobs:
       - name: Install dependencies
         run: pip install -r requirements.txt
       - name: Install ruff
-        run: pip install ruff==0.3.0
+        run: pip install ruff==0.4.2
       - name: Run ruff check
         run: ruff check --diff .
 
@@ -49,6 +49,6 @@ jobs:
           pip install -r requirements.txt
           pip install pytest
       - name: Install pyright
-        run: pip install pyright==1.1.352
+        run: pip install pyright==1.1.360
       - name: Run pyright
         run: pyright .
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,90 +5,124 @@ The changelog format is based on [Keep a Changelog](https://keepachangelog.com/e
 
 ## [Unreleased]
 
+### Dependencies
+-   updated to ruff==0.4.2  (from ruff==0.3.0)
+-   updated to pyright==1.1.360  (from pyright==1.1.352)
+-   updated to sourcery==1.16  (from sourcery==1.15)
+-   updated to pytest>=8.2  (from pytest>=7.4)
+-   updated to pytest-cov>=5.0  (from pytest-cov>=4.1)
+-   updated to Sphinx>=7.3  (from Sphinx>=7.2)
+-   updated to sphinx-argparse-cli>=1.15  (from sphinx-argparse-cli>=1.11)
+-   updated to myst-parser>=3.0  (from myst-parser>=2.0)
+-   updated to furo>=2024.4  (from furo>=2023.9.10)
+
 ### Changed
-* VS Code settings: Turned off automatic venv activation
-* replaced black formatter with ruff formatter
+-   VS Code settings: Turned off automatic venv activation
+-   replaced black formatter with ruff formatter
+-   src/maritime_schema/types/caga.py: Allow own_ship and target_ships to take a Ship object as input
 
-### Dependencies
-* updated to ruff==0.3.0  (from ruff==0.2.1)
-* updated to pyright==1.1.352  (from pyright==1.1.350)
-* removed black
+## [0.0.6] - 2024-04-04
+
+### Changed
+-   Updated README.md with a getting started section.
+-   examples: Added examples using `types.caga` classes in the examples folder.
+-   src/maritime_schema/types/caga.py: A number of classes were changed from optional to required.
+-   src/maritime_schema/types/caga.py: Fixed a bug in the automatic waypoint generation.
+-   src/maritime_schema/types/caga.py: Removed redundant title in the `Field()` from some classes
+-   src/maritime_schema/types/caga.py: Renamed `CagaTimeFrame` to `CagaTimeStep` for more clarity.
+
+## [0.0.5] - 2024-03-22
+
+### Changed
 
-* -/-
+-   Replaced black formatter with ruff formatter
+-   src/maritime_schema/types/caga.py: class ShipStatic(): set the length, width, and shipType fields as Optional.
+-   src/maritime_schema/types/caga.py: class TrafficSituation(): set the title field as Optional.
+-   src/maritime_schema/types/caga.py: class Ship(): updated the waypoint field, so that if the class has initial data without waypoints, they will automatically be created.
 
+### Dependencies
+
+-   Added pyproj==3.6.1 (used for geodesic calculations)
+-   Updated to ruff==0.3.0 (from ruff==0.2.1)
+-   Updated to pyright==1.1.352 (from pyright==1.1.350)
+-   Removed black
 
 ## [0.0.4] - 2024-02-28
 
 ### Changed
-* src/maritime_schema/types/caga.py: class Initial(): Marked several fields as optional.
 
+-   src/maritime_schema/types/caga.py: class Initial(): Marked several fields as optional.
 
 ## [0.0.3] - 2024-02-27
 
 ### Added
-* Created a CLI script `publish-schema`, which re-generates the schema files.
-* README.md:
-  * Added some introductory guidance.
-  * Under `Development Setup`, added a step to install current package in "editable" mode, using the pip install -e option.
-This removes the need to manually add /src to the PythonPath environment variable in order for debugging and tests to work.
-* Created an icon for the documentation
-* Added authors to README.md, pyproject.toml and to the Sphinx documentation
+
+-   Created a CLI script `publish-schema`, which re-generates the schema files.
+-   README.md:
+    -   Added some introductory guidance.
+    -   Under `Development Setup`, added a step to install current package in "editable" mode, using the pip install -e option.
+        This removes the need to manually add /src to the PythonPath environment variable in order for debugging and tests to work.
+-   Created an icon for the documentation
+-   Added authors to README.md, pyproject.toml and to the Sphinx documentation
 
 ### Removed
-* VS Code settings: Removed the setting which added the /src folder to PythonPath. This is no longer necessary. Installing the project itself as a package in "editable" mode, using the pip install -e option, solves the issue and removes the need to manually add /src to the PythonPath environment variable.
+
+-   VS Code settings: Removed the setting which added the /src folder to PythonPath. This is no longer necessary. Installing the project itself as a package in "editable" mode, using the pip install -e option, solves the issue and removes the need to manually add /src to the PythonPath environment variable.
 
 ### Changed
-* Moved all project configuration from setup.cfg to pyproject.toml
-* Moved all tox configuration from setup.cfg to tox.ini.
-* Moved pytest configuration from pyproject.toml to pytest.ini
-* Deleted setup.cfg
+
+-   Moved all project configuration from setup.cfg to pyproject.toml
+-   Moved all tox configuration from setup.cfg to tox.ini.
+-   Moved pytest configuration from pyproject.toml to pytest.ini
+-   Deleted setup.cfg
 
 ### Dependencies
-* updated to black[jupyter]==24.1  (from black[jupyter]==23.12)
-* updated to version: '==24.1'  (from version: '==23.12')
-* updated to ruff==0.2.1  (from ruff==0.1.8)
-* updated to pyright==1.1.350  (from pyright==1.1.338)
-* updated to sourcery==1.15  (from sourcery==1.14)
 
+-   Updated to black[jupyter]==24.1 (from black[jupyter]==23.12)
+-   Updated to version: '==24.1' (from version: '==23.12')
+-   Updated to ruff==0.2.1 (from ruff==0.1.8)
+-   Updated to pyright==1.1.350 (from pyright==1.1.338)
+-   Updated to sourcery==1.15 (from sourcery==1.14)
 
 ## [0.0.2] - 2024-01-11
 
-* Test release
-
+-   Test release
 
 ## [0.0.1] - 2024-01-11
 
-* Initial release
+-   Initial release
 
 ### Added
 
-* added this
+-   added this
 
 ### Changed
 
-* changed that
+-   changed that
 
 ### Dependencies
 
-* updated to some_package_on_pypi>=0.1.0
+-   updated to some_package_on_pypi>=0.1.0
 
 ### Fixed
 
-* fixed issue #12345
+-   fixed issue #12345
 
 ### Deprecated
 
-* following features will soon be removed and have been marked as deprecated:
-    * function x in module z
+-   following features will soon be removed and have been marked as deprecated:
+    -   function x in module z
 
 ### Removed
 
-* following features have been removed:
-    * function y in module z
-
+-   following features have been removed:
+    -   function y in module z
 
 <!-- Markdown link & img dfn's -->
-[unreleased]: https://github.com/dnv-opensource/maritime-schema/compare/v0.0.4...HEAD
+
+[unreleased]: https://github.com/dnv-opensource/maritime-schema/compare/v0.0.6...HEAD
+[0.0.6]: https://github.com/dnv-opensource/maritime-schema/releases/tag/v0.0.5...v0.0.6
+[0.0.5]: https://github.com/dnv-opensource/maritime-schema/releases/tag/v0.0.4...v0.0.5
 [0.0.4]: https://github.com/dnv-opensource/maritime-schema/releases/tag/v0.0.3...v0.0.4
 [0.0.3]: https://github.com/dnv-opensource/maritime-schema/releases/tag/v0.0.2...v0.0.3
 [0.0.2]: https://github.com/dnv-opensource/maritime-schema/releases/tag/v0.0.1...v0.0.2