Merge pull request #57 from Materials-Data-Science-and-Informatics/docs/v0.2.0

Docs/v0.2.0

Author: mustafasoylu

.github/workflows/ci.yml

@@ -73,7 +73,7 @@ jobs:
     strategy:
       fail-fast: true
       matrix:
-        os: ["ubuntu-latest"]
+        os: ["ubuntu-latest", "macos-latest"]
         python-version: ["3.8", "3.9", "3.10"]
     runs-on: ${{ matrix.os }}
 

.github/workflows/release.yml

@@ -12,12 +12,12 @@ on:
       to_test_pypi:
         description: "Publish to Test PyPI."
         type: boolean
-        default: true
+        default: false
 
       to_pypi:
         description: "Publish to PyPI."
         type: boolean
-        default: false
+        default: true
 
 jobs:
   github:

.somesy.toml

@@ -1,6 +1,6 @@
 [project]
 name = "somesy"
-version = "0.1.1"
+version = "0.2.0"
 description = "A CLI tool for synchronizing software project metadata."
 keywords = ["metadata", "FAIR"]
 license = "MIT"

CHANGELOG.md

@@ -4,6 +4,12 @@ Here we provide notes that summarize the most important changes in each released
 
 Please consult the changelog to inform yourself about breaking changes and security issues.
 
+## [v0.2.0](https://github.com/Materials-Data-Science-and-Informatics/somesy/tree/v0.2.0) <small>(2023-11-29)</small> { id="0.2.0" }
+
+* Test refactoring
+* Pydantic 2 implementation
+* Added `publication_author` field to Person model
+
 ## [v0.1.0](https://github.com/Materials-Data-Science-and-Informatics/somesy/tree/v0.1.0) <small>(2023-08-10)</small> { id="0.1.0" }
 
 * First release

CITATION.cff

@@ -3,7 +3,7 @@ type: software
 message: If you use this software, please cite it using this metadata.
 
 title: somesy
-version: 0.1.1
+version: 0.2.0
 abstract: A CLI tool for synchronizing software project metadata.
 repository-code: https://github.com/Materials-Data-Science-and-Informatics/somesy
 license: MIT

README.md

@@ -46,6 +46,10 @@ Properly maintaining this kind of information in various files scattered around
 
 ## Getting Started
 
+### Platform Support
+
+Please note that the current version of 'somesy' does not support Windows. We are actively working to include Windows support in our next release. Stay tuned for updates!
+
 ### Installing somesy
 
 Somesy requires Python `>=3.8`. To get a first impression, you can install the
@@ -136,7 +140,7 @@ file in the root folder of your repository:
 repos:
   # ... (your other hooks) ...
   - repo: https://github.com/Materials-Data-Science-and-Informatics/somesy
-    rev: "v0.1.0"
+    rev: "v0.2.0"
     hooks:
       - id: somesy
 ```

codemeta.json

@@ -63,20 +63,6 @@
     "runtimePlatform": "Python 3",
     "softwareHelp": "https://materials-data-science-and-informatics.github.io/somesy",
     "softwareRequirements": [
-        {
-            "@type": "SoftwareApplication",
-            "identifier": "'version':",
-            "name": "'version':",
-            "runtimePlatform": "Python 3",
-            "version": "'^0.7.0'}"
-        },
-        {
-            "@type": "SoftwareApplication",
-            "identifier": "'version':",
-            "name": "'version':",
-            "runtimePlatform": "Python 3",
-            "version": "'^2.4.2'}"
-        },
         {
             "@type": "SoftwareApplication",
             "identifier": "cffconvert",
@@ -117,7 +103,7 @@
             "identifier": "pydantic",
             "name": "pydantic",
             "runtimePlatform": "Python 3",
-            "version": "{'extras': ['email'"
+            "version": "^2.4.2"
         },
         {
             "@type": "SoftwareApplication",
@@ -152,7 +138,7 @@
             "identifier": "typer",
             "name": "typer",
             "runtimePlatform": "Python 3",
-            "version": "{'extras': ['all'"
+            "version": "^0.7.0"
         },
         {
             "@type": "SoftwareApplication",
@@ -170,5 +156,5 @@
         "runtimePlatform": "Python 3"
     },
     "url": "https://materials-data-science-and-informatics.github.io/somesy",
-    "version": "0.1.1"
+    "version": "0.2.0"
 }

mkdocs.yml

@@ -112,8 +112,8 @@ markdown_extensions:
       check_paths: true
   # Icons and Emoji: https://squidfunk.github.io/mkdocs-material/reference/icons-emojis/
   - pymdownx.emoji:
-      emoji_index: !!python/name:materialx.emoji.twemoji
-      emoji_generator: !!python/name:materialx.emoji.to_svg
+      emoji_index: !!python/name:material.extensions.emoji.twemoji
+      emoji_generator: !!python/name:material.extensions.emoji.to_svg
 
 plugins:
   # default search box (must be listed if plugins are added)

poetry.lock

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "somesy"
-version = "0.1.1"
+version = "0.2.0"
 description = "A CLI tool for synchronizing software project metadata."
 authors = ["Mustafa Soylu <m.soylu@fz-juelich.de>", "Anton Pirogov <a.pirogov@fz-juelich.de>"]
 maintainers = ["Mustafa Soylu <m.soylu@fz-juelich.de>"]
@@ -63,17 +63,17 @@ optional = true
 
 [tool.poetry.group.docs.dependencies]
 mkdocs = "^1.4.2"
-mkdocstrings = {extras = ["python"], version = "^0.21.2"}
-mkdocs-material = "^9.1.6"
-mkdocs-gen-files = "^0.4.0"
+mkdocstrings = {extras = ["python"], version = "^0.24.0"}
+mkdocs-material = "^9.4"
+mkdocs-gen-files = "^0.5.0"
 mkdocs-literate-nav = "^0.6.0"
 mkdocs-section-index = "^0.3.5"
 mkdocs-macros-plugin = "^0.7.0"
 markdown-include = "^0.8.1"
-pymdown-extensions = "^9.11"
+pymdown-extensions = "^10.2"
 markdown-exec = {extras = ["ansi"], version = "^1.6.0"}
-mkdocs-coverage = "^0.2.7"
-mike = "^1.1.2"
+mkdocs-coverage = "^1.0.0"
+mike = "^2.0.0"
 anybadge = "^1.14.0"
 interrogate = "^1.5.0"
 black = "^23.3.0"