Merge pull request #69 from Materials-Data-Science-and-Informatics/feature/julia_support

julia support

Author: mustafasoylu

.gitignore

@@ -1,6 +1,5 @@
 # don't add custom python shell scratchpad file
-scratch*.py
-scratch
+scratch*
 
 # generated badges
 docs/*_badge.svg

.somesy.toml

@@ -6,6 +6,7 @@ keywords = ["metadata", "FAIR"]
 license = "MIT"
 repository = "https://github.com/Materials-Data-Science-and-Informatics/somesy"
 homepage = "https://materials-data-science-and-informatics.github.io/somesy"
+documentation = "https://materials-data-science-and-informatics.github.io/somesy"
 
 [[project.people]]
 family-names = "Soylu"
@@ -74,6 +75,7 @@ pyproject_file = "pyproject.toml"
 no_sync_codemeta = false
 codemeta_file = "codemeta.json"
 no_sync_package_json = true
+no_sync_julia = true
 show_info = false
 verbose = false
 debug = true

CHANGELOG.md

@@ -4,6 +4,11 @@ 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.4.0](https://github.com/Materials-Data-Science-and-Informatics/somesy/tree/v0.4.0) <small>(2024-02-??)</small> { id="0.4.0" }
+
+* added separate `documentation` URL to Project metadata model
+* added support for Julia `Project.toml` file
+
 ## [v0.3.1](https://github.com/Materials-Data-Science-and-Informatics/somesy/tree/v0.3.1) <small>(2024-01-23)</small> { id="0.3.1" }
 
 * fix setuptools license writing bug

CITATION.cff

@@ -5,6 +5,7 @@ message: If you use this software, please cite it using this metadata.
 title: somesy
 version: 0.3.1
 abstract: A CLI tool for synchronizing software project metadata.
+url: https://materials-data-science-and-informatics.github.io/somesy
 repository-code: https://github.com/Materials-Data-Science-and-Informatics/somesy
 license: MIT
 keywords:
@@ -32,4 +33,3 @@ contact:
   family-names: Soylu
   given-names: Mustafa
   orcid: https://orcid.org/0000-0003-2637-0432
-url: https://materials-data-science-and-informatics.github.io/somesy

README.md

@@ -109,7 +109,7 @@ verbose = true     # show detailed information about what somesy is doing
 <!-- --8<-- [end:somesytoml] -->
 
 Alternatively, you can also add the somesy configuration to an existing
-`pyproject.toml` or `package.json` file. The somesy [manual](https://materials-data-science-and-informatics.github.io/somesy/main/manual/#somesy-input-file) contains examples showing how to do that.
+`pyproject.toml`, `package.json` or `Project.toml` file. The somesy [manual](https://materials-data-science-and-informatics.github.io/somesy/main/manual/#somesy-input-file) contains examples showing how to do that.
 
 ### Using somesy
 
@@ -125,7 +125,7 @@ authoritative** source for project metadata, which is used to update all
 supported (and enabled) *target files*. You can find an overview of supported
 formats further below.
 
-By default, `somesy` will create (if they did not exist) or update `CITATION.cff` and `codemeta.json` files in your repository. If you happen to use `pyproject.toml` (in Python projects) or `package.json` (in JavaScript projects), somesy would also update the respective information there.
+By default, `somesy` will create (if they did not exist) or update `CITATION.cff` and `codemeta.json` files in your repository. If you happen to use `pyproject.toml` (in Python projects), `package.json` (in JavaScript projects), or `Project.toml` (in Julia projects), somesy would also update the respective information there.
 
 You can see call available options with `somesy --help`,
 all of these can also be conveniently set in your `somesy.toml` file.
@@ -169,6 +169,7 @@ Here is an overview of all the currently supported files and formats.
 | (.)somesy.toml | ✓      | | pyproject.toml _(poetry)_     | ✓      |
 | pyproject.toml | ✓      | | pyproject.toml _(setuptools)_ | ✓(1.)  |
 | package.json   | ✓      | | package.json                  | ✓(2.)  |
+| Project.toml   | ✓      | | Project.toml                  | ✓      |
 |                |        | | CITATION.cff                  | ✓      |
 |                |        | | codemeta.json                 | ✓(3.)  |
 

codemeta.json

@@ -44,6 +44,7 @@
   ],
   "softwareHelp": "https://materials-data-science-and-informatics.github.io/somesy",
   "codeRepository": "https://github.com/Materials-Data-Science-and-Informatics/somesy",
+  "buildInstructions": "https://materials-data-science-and-informatics.github.io/somesy",
   "contributor": [
     {
       "@type": "Person",

docs/manual.md

@@ -113,34 +113,37 @@ print(model2md(SomesyConfig).getvalue())
 
 From its own schema `somesy` must convert the information into the target formats.
 The following tables sketch how fields are mapped to corresponding other fields in
-some of the currently supported formats.
+some of the currently supported formats. Bold field names are mandatory, the others are optional.
 
 === "Person Metadata"
 
-    | Field Name       | Poetry Config | SetupTools Config | CITATION.cff    | package.json | Requirement |
-    | ---------------- | ------------- | ----------------- | --------------- | ------------ | ----------- |
-    | given-names      | name+email    | name              | given-names     | name         | required    |
-    | family-names     | name+email    | name              | family-names    | name         | required    |
-    | email            | name+email    | email             | email           | email        | required    |
-    | orcid            | -             | -                 | orcid           | url          | optional    |
-    | *(many others)*  | -             | -                 | *(same)*        | -            | optional    |
+    | Somesy Field     | Poetry Config | SetupTools Config | Julia Config | package.json | CITATION.cff    | CodeMeta        |
+    | ---------------- | ------------- | ----------------- | ------------ | ------------ | --------------- | --------------- |
+    |                  |               |                   |              |              |                 |                 |
+    | **given-names**  | name+email    | name              | name+email   | name         | given-names     | givenName       |
+    | **family-names** | name+email    | name              | name+email   | name         | family-names    | familyName      |
+    | **email**        | name+email    | email             | name+email   | email        | email           | email           |
+    | orcid            | -             | -                 | -            | url          | orcid           | id              |
+    | *(many others)*  | -             | -                 | -            | -            | *(same)*        | *(same)*        |
 
 === "Project Metadata"
 
-    | Field Name        | Poetry Config | SetupTools Config | CITATION.cff    | package.json | Requirement |
-    | ----------------- | ------------- | ----------------- | --------------- | ------------ | ----------- |
-    | name              | name          | name              | title           | name         | required    |
-    | description       | description   | description       | abstract        | description  | required    |
-    | license           | license       | license           | license         | license      | required    |
-    | version           | version       | version           | version         | version      | optional    |
-    |                   |               |                   |                 |              |             |
-    | *author=true*     | authors       | authors           | authors         | author       | required    |
-    | *maintainer=true* | maintainers   | maintainers       | contact         | maintainers  | optional    |
-    | *people*          | -             | -                 | -               | contributors | optional    |
-    |                   |               |                   |                 |              |             |
-    | keywords          | keywords      | keywords          | keywords        | keywords     | optional    |
-    | repository        | repository    | urls.repository   | repository_code | repository   | optional    |
-    | homepage          | homepage      | urls.homepage     | url             | homepage     | optional    |
+    | Somesy Field      | Poetry Config | SetupTools Config  | Julia Config | package.json | CITATION.cff    | CodeMeta          |
+    | ----------------- | ------------- | ------------------ | ------------ | ------------ | --------------- | ----------------- |
+    |                   |               |                                   |              |                 |                   |
+    | **name**          | name          | name               | name         | name         | title           | name              |
+    | **description**   | description   | description        | -            | description  | abstract        | description       |
+    | **license**       | license       | license            | -            | license      | license         | license           |
+    | **version**       | version       | version            | version      | version      | version         | version           |
+    |                   |               |                    |              |              |                 |                   |
+    | ***author=true*** | authors       | authors            | authors      | author       | authors         | author            |
+    | *maintainer=true* | maintainers   | maintainers        | -            | maintainers  | contact         | maintainer        |
+    | *people*          | -             | -                  | -            | contributors | -               | contributor       |
+    |                   |               |                    |              |              |                 |                   |
+    | keywords          | keywords      | keywords           | -            | keywords     | keywords        | keywords          |
+    | homepage          | homepage      | urls.homepage      | -            | homepage     | url             | url               |
+    | repository        | repository    | urls.repository    | -            | repository   | repository_code | codeRepository    |
+    | documentation     | documentation | urls.documentation | -            | -            | -               | buildInstructions |
 
 Note that the mapping is often not 1-to-1. For example, CITATION.cff allows rich
 specification of author contact information and complex names. In contrast,
@@ -167,6 +170,7 @@ Without an input file specifically provided, somesy will check if it can find a
 * `.somesy.toml`
 * `somesy.toml`
 * `pyproject.toml` (in `tool.somesy` section)
+* `Project.toml` (in `tool.somesy` section)
 * `package.json` (in `somesy` section)
 
 which is located in the current working directory. If you want to provide
@@ -218,6 +222,44 @@ one of the supported input formats:
     verbose = true     # show detailed information about what somesy is doing
     ```
 
+=== "Project.toml"
+    ```toml
+    name = "my-amazing-project"
+    version = "0.1.0"
+    uuid = "c7e460c6-3f3e-11ec-8d3d-0242ac130003"
+
+    [deps]
+    ...
+
+    [tool.somesy.project]
+    name = "my-amazing-project"
+    version = "0.1.0"
+    description = "Brief description of my amazing software."
+
+    keywords = ["some", "descriptive", "keywords"]
+    license = "MIT"
+    repository = "https://github.com/username/my-amazing-project"
+
+    # This is you, the proud author of your project
+    [[tool.somesy.project.people]]
+    given-names = "Jane"
+    family-names = "Doe"
+    email = "j.doe@example.com"
+    orcid = "https://orcid.org/0000-0000-0000-0001"
+    author = true      # is a full author of the project (i.e. appears in citations)
+    maintainer = true  # currently maintains the project (i.e. is a contact person)
+
+    # this person is a acknowledged contributor, but not author or maintainer:
+    [[tool.somesy.project.people]]
+    given-names = "Another"
+    family-names = "Contributor"
+    email = "a.contributor@example.com"
+    orcid = "https://orcid.org/0000-0000-0000-0002"
+
+    [tool.somesy.config]
+    verbose = true     # show detailed information about what somesy is doing
+    ```
+
 === "package.json"
 
     ```json

src/somesy/cff/writer.py

@@ -7,7 +7,7 @@
 from ruamel.yaml import YAML
 
 from somesy.core.models import Person, ProjectMetadata
-from somesy.core.writer import ProjectMetadataWriter
+from somesy.core.writer import FieldKeyMapping, IgnoreKey, ProjectMetadataWriter
 
 
 class CFF(ProjectMetadataWriter):
@@ -25,11 +25,12 @@ def __init__(
         self._yaml = YAML()
         self._yaml.preserve_quotes = True
 
-        mappings = {
+        mappings: FieldKeyMapping = {
             "name": ["title"],
             "description": ["abstract"],
             "homepage": ["url"],
             "repository": ["repository-code"],
+            "documentation": IgnoreKey(),
             "maintainers": ["contact"],
         }
         super().__init__(

src/somesy/cli/init.py

@@ -56,6 +56,13 @@ def config():
     if codemeta_file is not None or codemeta_file != "":
         options["codemeta_file"] = codemeta_file
 
+    options["no_sync_julia"] = not typer.confirm(
+        "Do you want to sync to a Project.toml(Julia) file?", default=True
+    )
+    julia_file = typer.prompt("Project.toml(Julia) file path", default="Project.toml")
+    if julia_file is not None or julia_file != "":
+        options["julia_file"] = julia_file
+
     options["show_info"] = typer.confirm(
         "Do you want to show info about the sync process?"
     )

src/somesy/cli/sync.py

@@ -101,6 +101,24 @@ def sync(
         resolve_path=True,
         help="Custom codemeta.json file path",
     ),
+    no_sync_julia: bool = typer.Option(
+        None,
+        "--no-sync-julia",
+        "-M",
+        help="Do not sync Project.toml(Julia) file",
+    ),
+    julia_file: Path = typer.Option(
+        None,
+        "--julia-file",
+        "-m",
+        exists=True,
+        file_okay=True,
+        dir_okay=False,
+        writable=True,
+        readable=True,
+        resolve_path=True,
+        help="Custom Project.toml(Julia) file path",
+    ),
 ):
     """Sync project metadata input with metadata files."""
     somesy_input = resolved_somesy_input(
@@ -113,6 +131,8 @@ def sync(
         package_json_file=package_json_file,
         no_sync_codemeta=no_sync_codemeta,
         codemeta_file=codemeta_file,
+        no_sync_julia=no_sync_julia,
+        julia_file=julia_file,
     )
     run_sync(somesy_input)