Skip to content

Commit b071836

Browse files
committed
update docs
1 parent 2a80aeb commit b071836

7 files changed

Lines changed: 26 additions & 20 deletions

File tree

.somesy.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[project]
22
name = "somesy"
3-
version = "0.6.0"
3+
version = "0.7.0"
44
description = "A CLI tool for synchronizing software project metadata."
55
keywords = ["metadata", "FAIR"]
66
license = "MIT"

CHANGELOG.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,14 @@ Here we provide notes that summarize the most important changes in each released
44

55
Please consult the changelog to inform yourself about breaking changes and security issues.
66

7-
## [v0.7.0](https://github.com/Materials-Data-Science-and-Informatics/somesy/tree/v0.7.0) <small>(2025-xx-xx)</small> { id="0.7.0" }
7+
## [v0.7.0](https://github.com/Materials-Data-Science-and-Informatics/somesy/tree/v0.7.0) <small>(2025-02-27)</small> { id="0.7.0" }
88

99
- make validation of output files, such as pyproject.toml, optional
1010
- make somesy project metadata input `version` optional
1111
- multiple output file support
1212
- enable having packages support
1313
- fix: package.json url set error on None value
14+
- support poetry version 2
1415

1516
## [v0.6.0](https://github.com/Materials-Data-Science-and-Informatics/somesy/tree/v0.6.0) <small>(2025-02-14)</small> { id="0.6.0" }
1617

CITATION.cff

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ type: software
33
message: If you use this software, please cite it using this metadata.
44

55
title: somesy
6-
version: 0.6.0
6+
version: 0.7.0
77
abstract: A CLI tool for synchronizing software project metadata.
88
url: https://materials-data-science-and-informatics.github.io/somesy
99
repository-code: https://github.com/Materials-Data-Science-and-Informatics/somesy

README.md

Lines changed: 17 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,10 @@ Starting with version **0.3.0**, `somesy` supports Linux, MacOS and Windows.
5656

5757
Make sure that you use the latest version in order to avoid any problems.
5858

59+
! info
60+
61+
Poetry changed location of its project metadata with its version 2. Starting with version **0.7.0**, `somesy` supports both major versions of `poetry`, version 1 and 2.
62+
5963
### Installing somesy
6064

6165
Somesy requires Python `>=3.8`. To get a first impression, you can install the
@@ -172,7 +176,7 @@ file in the root folder of your repository:
172176
repos:
173177
# ... (your other hooks) ...
174178
- repo: https://github.com/Materials-Data-Science-and-Informatics/somesy
175-
rev: 'v0.6.0'
179+
rev: 'v0.7.0'
176180
hooks:
177181
- id: somesy
178182
```
@@ -193,18 +197,18 @@ so when using `somesy` with pre-commit, keep in mind that
193197

194198
Here is an overview of all the currently supported files and formats.
195199

196-
| Input Formats | Status | | Target Formats | Status |
197-
| -------------- | ------ | --- | ----------------------------- | ------ |
198-
| (.)somesy.toml | ✓ | | pyproject.toml _(poetry)_ | ✓ |
199-
| pyproject.toml | ✓ | | pyproject.toml _(setuptools)_ | ✓(1.) |
200-
| package.json | ✓ | | package.json _(JavaScript)_ | ✓(2.) |
201-
| Project.toml | ✓ | | Project.toml _(Julia)_ | ✓ |
202-
| fpm.toml | ✓ | | fpm.toml _(Fortran)_ | ✓(3.) |
203-
| | ✓ | | pom.toml _(Java)_ | ✓(4.) |
204-
| Cargo.toml | ✓ | | Cargo.toml _(Rust)_ | ✓ |
205-
| | | | mkdocs.yml | ✓(5.) |
206-
| | | | CITATION.cff | ✓ |
207-
| | | | codemeta.json | ✓(6.) |
200+
| Input Formats | Status | | Target Formats | Status |
201+
| -------------- | ------ | --- | ----------------------------------- | ------ |
202+
| (.)somesy.toml | ✓ | | pyproject.toml _(poetry v1 and v2)_ | ✓ |
203+
| pyproject.toml | ✓ | | pyproject.toml _(setuptools)_ | ✓(1.) |
204+
| package.json | ✓ | | package.json _(JavaScript)_ | ✓(2.) |
205+
| Project.toml | ✓ | | Project.toml _(Julia)_ | ✓ |
206+
| fpm.toml | ✓ | | fpm.toml _(Fortran)_ | ✓(3.) |
207+
| | ✓ | | pom.toml _(Java)_ | ✓(4.) |
208+
| Cargo.toml | ✓ | | Cargo.toml _(Rust)_ | ✓ |
209+
| | | | mkdocs.yml | ✓(5.) |
210+
| | | | CITATION.cff | ✓ |
211+
| | | | codemeta.json | ✓(6.) |
208212

209213
**Notes:**
210214

codemeta.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727
],
2828
"name": "somesy",
2929
"description": "A CLI tool for synchronizing software project metadata.",
30-
"version": "0.6.0",
30+
"version": "0.7.0",
3131
"keywords": [
3232
"metadata",
3333
"FAIR"

docs/manual.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -225,7 +225,7 @@ one of the supported input formats:
225225
=== "pyproject.toml"
226226

227227
```toml
228-
[tool.poetry]
228+
[tool.poetry] # [project] in case of poetry version 2
229229
name = "my-amazing-project"
230230
version = "0.1.0"
231231
...

pyproject.toml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
[tool.poetry]
1+
[project]
22
name = "somesy"
3-
version = "0.6.0"
3+
version = "0.7.0"
44
description = "A CLI tool for synchronizing software project metadata."
55
authors = ["Mustafa Soylu <m.soylu@fz-juelich.de>", "Anton Pirogov <a.pirogov@fz-juelich.de>"]
66
maintainers = ["Mustafa Soylu <m.soylu@fz-juelich.de>"]
@@ -20,6 +20,7 @@ classifiers = [
2020
"License :: OSI Approved :: MIT License",
2121
]
2222

23+
[tool.poetry]
2324
# the Python packages that will be included in a built distribution:
2425
packages = [{include = "somesy", from = "src"}]
2526

0 commit comments

Comments
 (0)