Skip to content

Commit 8862a10

Browse files
apirogovapirogov
committed
update documentation
1 parent 66f8c15 commit 8862a10

5 files changed

Lines changed: 39 additions & 41 deletions

File tree

‎CHANGELOG.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,8 @@ Please consult the changelog to inform yourself about breaking changes and secur
88

99
* added separate `documentation` URL to Project metadata model
1010
* added support for Julia `Project.toml` file
11-
* added support for fortran `fpm.toml` file
11+
* added support for Fortran `fpm.toml` file
12+
* added support for Java `pom.xml` file
1213

1314
## [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" }
1415

‎README.md‎

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,16 @@ authoritative** source for project metadata, which is used to update all
125125
supported (and enabled) *target files*. You can find an overview of supported
126126
formats further below.
127127

128-
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), `Project.toml` (in Julia projects), or `fpm.toml` (in Fortran projects) somesy would also update the respective information there.
128+
By default, `somesy` will create (if they did not exist) or update `CITATION.cff` and `codemeta.json` files in your repository.
129+
If you happen to use
130+
131+
* `pyproject.toml` (in Python projects),
132+
* `package.json` (in JavaScript projects),
133+
* `Project.toml` (in Julia projects),
134+
* `fpm.toml` (in Fortran projects),
135+
* `pom.xml` (in Java projects),
136+
137+
then somesy would also update the respective information there.
129138

130139
You can see call available options with `somesy --help`,
131140
all of these can also be conveniently set in your `somesy.toml` file.

‎codemeta.json‎

Lines changed: 0 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -46,20 +46,6 @@
4646
"codeRepository": "https://github.com/Materials-Data-Science-and-Informatics/somesy",
4747
"buildInstructions": "https://materials-data-science-and-informatics.github.io/somesy",
4848
"contributor": [
49-
{
50-
"@type": "Person",
51-
"givenName": "Mustafa",
52-
"familyName": "Soylu",
53-
"email": "m.soylu@fz-juelich.de",
54-
"@id": "https://orcid.org/0000-0003-2637-0432"
55-
},
56-
{
57-
"@type": "Person",
58-
"givenName": "Anton",
59-
"familyName": "Pirogov",
60-
"email": "a.pirogov@fz-juelich.de",
61-
"@id": "https://orcid.org/0000-0002-5077-7497"
62-
},
6349
{
6450
"@type": "Person",
6551
"givenName": "Jens",

‎docs/manual.md‎

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -117,33 +117,33 @@ some of the currently supported formats. Bold field names are mandatory, the oth
117117

118118
=== "Person Metadata"
119119

120-
| Somesy Field | Poetry Config | SetupTools Config | Julia Config | Fortran Config | package.json | CITATION.cff | CodeMeta |
121-
| ---------------- | ------------- | ----------------- | ------------ | -------------- | ------------ | --------------- | --------------- |
122-
| | | | | | | | |
123-
| **given-names** | name+email | name | name+email | name+email | name | given-names | givenName |
124-
| **family-names** | name+email | name | name+email | name+email | name | family-names | familyName |
125-
| **email** | name+email | email | name+email | name+email | email | email | email |
126-
| orcid | - | - | - | - | url | orcid | id |
127-
| *(many others)* | - | - | - | - | - | *(same)* | *(same)* |
120+
| Somesy Field | Poetry Config | SetupTools Config | Java POM | Julia Config | Fortran Config | package.json | CITATION.cff | CodeMeta |
121+
| ---------------- | ------------- | ----------------- | ------------ | ------------ | -------------- | ------------ | --------------- | --------------- |
122+
| | | | | | | | | |
123+
| **given-names** | name+email | name | name | name+email | name+email | name | given-names | givenName |
124+
| **family-names** | name+email | name | name | name+email | name+email | name | family-names | familyName |
125+
| **email** | name+email | email | email | name+email | name+email | email | email | email |
126+
| orcid | - | - | url | - | - | url | orcid | id |
127+
| *(many others)* | - | - | - | - | - | - | *(same)* | *(same)* |
128128

129129
=== "Project Metadata"
130130

131-
| Somesy Field | Poetry Config | SetupTools Config | Julia Config | Fortran Config | package.json | CITATION.cff | CodeMeta |
132-
| ----------------- | ------------- | ------------------ | ------------ | -------------- | ------------ | --------------- | ----------------- |
133-
| | | | | | | |
134-
| **name** | name | name | name | name | name | title | name |
135-
| **description** | description | description | - | description | description | abstract | description |
136-
| **license** | license | license | - | license | license | license | license |
137-
| **version** | version | version | version | version | version | version | version |
138-
| | | | | | | | |
139-
| ***author=true*** | authors | authors | authors | author | author | authors | author |
140-
| *maintainer=true* | maintainers | maintainers | - | maintainer | maintainers | contact | maintainer |
141-
| *people* | - | - | - | - | contributors | - | contributor |
142-
| | | | | | | | |
143-
| keywords | keywords | keywords | - | keywords | keywords | keywords | keywords |
144-
| homepage | homepage | urls.homepage | - | homepage | homepage | url | url |
145-
| repository | repository | urls.repository | - | - | repository | repository_code | codeRepository |
146-
| documentation | documentation | urls.documentation | - | - | - | - | buildInstructions |
131+
| Somesy Field | Poetry Config | SetupTools Config | Java POM | Julia Config | Fortran Config | package.json | CITATION.cff | CodeMeta |
132+
| ----------------- | ------------- | ------------------ | ------------------------------- | ------------ | -------------- | ------------ | --------------- | ----------------- |
133+
| | | | | | | | | |
134+
| **name** | name | name | name | name | name | name | title | name |
135+
| **description** | description | description | description | - | description | description | abstract | description |
136+
| **license** | license | license | licenses.license | - | license | license | license | license |
137+
| **version** | version | version | version | version | version | version | version | version |
138+
| | | | | | | | | |
139+
| ***author=true*** | authors | authors | developers | authors | author | author | authors | author |
140+
| *maintainer=true* | maintainers | maintainers | - | - | maintainer | maintainers | contact | maintainer |
141+
| *people* | - | - | - | - | - | contributors | - | contributor |
142+
| | | | | | | | | |
143+
| keywords | keywords | keywords | - | - | keywords | keywords | keywords | keywords |
144+
| homepage | homepage | urls.homepage | urls | - | homepage | homepage | url | url |
145+
| repository | repository | urls.repository | scm.url | - | - | repository | repository_code | codeRepository |
146+
| documentation | documentation | urls.documentation | distributionManagement.site.url | - | - | - | - | buildInstructions |
147147

148148
Note that the mapping is often not 1-to-1. For example, CITATION.cff allows rich
149149
specification of author contact information and complex names. In contrast,

‎src/somesy/pom_xml/xmlproxy.py‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -201,7 +201,9 @@ def _from_jsonlike_primitive(
201201
return cls(elem, **kwargs)
202202

203203
@classmethod
204-
def from_jsonlike(cls, val, *, root_name: Optional[str] = None, **kwargs):
204+
def from_jsonlike(
205+
cls, val: JSONLike, *, root_name: Optional[str] = None, **kwargs: Any
206+
):
205207
"""Convert a JSON-like primitive, array or dict into an XML element.
206208
207209
Note that booleans are serialized as `true`/`false` and None as `null`.

0 commit comments

Comments
 (0)