From 4832b424af06b959503612bdc4b72dc95c9155b1 Mon Sep 17 00:00:00 2001 From: Ewen Le Bihan Date: Sat, 13 Apr 2024 18:58:16 +0200 Subject: [PATCH] =?UTF-8?q?=F0=9F=94=96=20Release=20v1.0.0?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- CHANGELOG.md | 5 +++++ README.md | 11 +++++++++-- meta.go | 2 +- packages/python/ortfodb/configuration.py | 8 ++++++-- packages/python/pyproject.toml | 2 +- packages/rust/Cargo.toml | 2 +- packages/rust/src/configuration.rs | 3 +++ packages/typescript/package.json | 6 ++++-- packages/typescript/src/configuration.ts | 2 ++ schemas/configuration.schema.json | 8 ++++++-- schemas/database.schema.json | 2 +- schemas/tags.schema.json | 2 +- schemas/technologies.schema.json | 2 +- 13 files changed, 41 insertions(+), 14 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 4c2ccba..1634068 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## [Unreleased] +## [1.0.0] - 2024-04-13 + ### Added - `completion` command to install completions for your shell! @@ -45,9 +47,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - Initial release [Unreleased]: https://github.com/ortfo/db/compare/v0.3.2...HEAD +[1.0.0]: https://github.com/ortfo/db/-/releases/tag/v1.0.0 [0.3.2]: https://github.com/ortfo/db/compare/v0.3.1...v0.3.2 [0.3.1]: https://github.com/ortfo/db/compare/v0.3.0...v0.3.1 [0.3.0]: https://github.com/ortfo/db/compare/v0.2.0...v0.3.0 [0.2.0]: https://github.com/ortfo/db/releases/tag/v0.2.0 [//]: # (C3-2-DKAC:GGH:Rortfo/db:Tv{t}) + +[unreleased]: https://github.com/ortfo/db/-/compare/v1.0.0...main diff --git a/README.md b/README.md index 8c80fe8..e04ec01 100644 --- a/README.md +++ b/README.md @@ -90,8 +90,12 @@ projects/ └── description.md ``` + + Of course, your actual project files are still where they are and are left untouched (like the main.py file in the above example) + + ### `description.md` files Description files are separated in "blocks": blocks are separated by an empty line. @@ -163,15 +167,18 @@ Of course, you can use links inside of a paragraphs, but you can also declare is ## Configuration -Simply run `ortfodb build` without giving a configuration filename, and ortfodb will create a default configuration file for you in the current directory. +Put this in `ortfodb.yaml` in the root of your database: + - ## Extra markdown features - Abbreviations: `*[YAML]: Yet Another Markup Language` + - Footnotes: `footnote reference[^1]` and then `[^1]: footnote content` + - Smarty pants: typographic replacements (not replaced inside code): + - `--` to – - `---` to — - `->` to → diff --git a/meta.go b/meta.go index 8b2860f..34ef44c 100644 --- a/meta.go +++ b/meta.go @@ -1,3 +1,3 @@ package ortfodb -const Version = "0.3.2" +const Version = "1.0.0" diff --git a/packages/python/ortfodb/configuration.py b/packages/python/ortfodb/configuration.py index 0676257..0c2f0af 100644 --- a/packages/python/ortfodb/configuration.py +++ b/packages/python/ortfodb/configuration.py @@ -167,16 +167,18 @@ class Configuration: make_gifs: MakeGifs make_thumbnails: MakeThumbnails media: Media + projects_at: str scattered_mode_folder: str tags: Tags technologies: Technologies - def __init__(self, build_metadata_file: str, extract_colors: ExtractColors, make_gifs: MakeGifs, make_thumbnails: MakeThumbnails, media: Media, scattered_mode_folder: str, tags: Tags, technologies: Technologies) -> None: + def __init__(self, build_metadata_file: str, extract_colors: ExtractColors, make_gifs: MakeGifs, make_thumbnails: MakeThumbnails, media: Media, projects_at: str, scattered_mode_folder: str, tags: Tags, technologies: Technologies) -> None: self.build_metadata_file = build_metadata_file self.extract_colors = extract_colors self.make_gifs = make_gifs self.make_thumbnails = make_thumbnails self.media = media + self.projects_at = projects_at self.scattered_mode_folder = scattered_mode_folder self.tags = tags self.technologies = technologies @@ -189,10 +191,11 @@ def from_dict(obj: Any) -> 'Configuration': make_gifs = MakeGifs.from_dict(obj.get("make gifs")) make_thumbnails = MakeThumbnails.from_dict(obj.get("make thumbnails")) media = Media.from_dict(obj.get("media")) + projects_at = from_str(obj.get("projects at")) scattered_mode_folder = from_str(obj.get("scattered mode folder")) tags = Tags.from_dict(obj.get("tags")) technologies = Technologies.from_dict(obj.get("technologies")) - return Configuration(build_metadata_file, extract_colors, make_gifs, make_thumbnails, media, scattered_mode_folder, tags, technologies) + return Configuration(build_metadata_file, extract_colors, make_gifs, make_thumbnails, media, projects_at, scattered_mode_folder, tags, technologies) def to_dict(self) -> dict: result: dict = {} @@ -201,6 +204,7 @@ def to_dict(self) -> dict: result["make gifs"] = to_class(MakeGifs, self.make_gifs) result["make thumbnails"] = to_class(MakeThumbnails, self.make_thumbnails) result["media"] = to_class(Media, self.media) + result["projects at"] = from_str(self.projects_at) result["scattered mode folder"] = from_str(self.scattered_mode_folder) result["tags"] = to_class(Tags, self.tags) result["technologies"] = to_class(Technologies, self.technologies) diff --git a/packages/python/pyproject.toml b/packages/python/pyproject.toml index 93e33c3..e614e46 100644 --- a/packages/python/pyproject.toml +++ b/packages/python/pyproject.toml @@ -1,6 +1,6 @@ [tool.poetry] name = "ortfodb" -version = "0.3.2" +version = "1.0.0" description = "ortfodb client library" authors = ["Ewen Le Bihan "] license = "MIT" diff --git a/packages/rust/Cargo.toml b/packages/rust/Cargo.toml index 374eeca..6b4d918 100644 --- a/packages/rust/Cargo.toml +++ b/packages/rust/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "ortfodb" -version = "0.3.2" +version = "1.0.0" edition = "2021" description = "An ortfodb (https://github.com/ortfo/db) client library for Rust." license = "MIT" diff --git a/packages/rust/src/configuration.rs b/packages/rust/src/configuration.rs index 54ac1fe..eaaaa1c 100644 --- a/packages/rust/src/configuration.rs +++ b/packages/rust/src/configuration.rs @@ -29,6 +29,9 @@ pub struct Configuration { pub media: Media, + #[serde(rename = "projects at")] + pub projects_at: String, + #[serde(rename = "scattered mode folder")] pub scattered_mode_folder: String, diff --git a/packages/typescript/package.json b/packages/typescript/package.json index 10b7a69..c17db1c 100644 --- a/packages/typescript/package.json +++ b/packages/typescript/package.json @@ -1,6 +1,6 @@ { "name": "@ortfo/db", - "version": "0.3.2-3", + "version": "1.0.0", "description": "ortfodb client library", "scripts": { "build": "tsc -p tsconfig.json --declaration --outDir dist" @@ -13,7 +13,9 @@ "types": "./dist/index.d.ts" } }, - "files": ["dist/"], + "files": [ + "dist/" + ], "repository": { "type": "git", "url": "git+https://github.com/ortfo/db.git" diff --git a/packages/typescript/src/configuration.ts b/packages/typescript/src/configuration.ts index 1d7fa93..4f0d585 100644 --- a/packages/typescript/src/configuration.ts +++ b/packages/typescript/src/configuration.ts @@ -13,6 +13,7 @@ export interface Configuration { "make gifs": MakeGifs; "make thumbnails": MakeThumbnails; media: Media; + "projects at": string; "scattered mode folder": string; tags: Tags; technologies: Technologies; @@ -219,6 +220,7 @@ const typeMap: any = { { json: "make gifs", js: "make gifs", typ: r("MakeGifs") }, { json: "make thumbnails", js: "make thumbnails", typ: r("MakeThumbnails") }, { json: "media", js: "media", typ: r("Media") }, + { json: "projects at", js: "projects at", typ: "" }, { json: "scattered mode folder", js: "scattered mode folder", typ: "" }, { json: "tags", js: "tags", typ: r("Tags") }, { json: "technologies", js: "technologies", typ: r("Technologies") }, diff --git a/schemas/configuration.schema.json b/schemas/configuration.schema.json index b3f459f..f8346b9 100644 --- a/schemas/configuration.schema.json +++ b/schemas/configuration.schema.json @@ -1,6 +1,6 @@ { "$schema": "https://json-schema.org/draft/2020-12/schema", - "$id": "https://raw.githubusercontent.com/ortfo/db/v0.3.2/schemas/configuration.schema.json", + "$id": "https://raw.githubusercontent.com/ortfo/db/v1.0.0/schemas/configuration.schema.json", "$ref": "#/$defs/Configuration", "$defs": { "Configuration": { @@ -55,6 +55,9 @@ "required": [ "repository" ] + }, + "projects at": { + "type": "string" } }, "additionalProperties": false, @@ -67,7 +70,8 @@ "media", "scattered mode folder", "tags", - "technologies" + "technologies", + "projects at" ] }, "ExtractColorsConfiguration": { diff --git a/schemas/database.schema.json b/schemas/database.schema.json index ecdeef1..dd00e17 100644 --- a/schemas/database.schema.json +++ b/schemas/database.schema.json @@ -1,6 +1,6 @@ { "$schema": "https://json-schema.org/draft/2020-12/schema", - "$id": "https://raw.githubusercontent.com/ortfo/db/v0.3.2/schemas/database.schema.json", + "$id": "https://raw.githubusercontent.com/ortfo/db/v1.0.0/schemas/database.schema.json", "$ref": "#/$defs/Database", "$defs": { "AnalyzedWork": { diff --git a/schemas/tags.schema.json b/schemas/tags.schema.json index 5ce08e8..55fc164 100644 --- a/schemas/tags.schema.json +++ b/schemas/tags.schema.json @@ -1,6 +1,6 @@ { "$schema": "https://json-schema.org/draft/2020-12/schema", - "$id": "https://raw.githubusercontent.com/ortfo/db/v0.3.2/schemas/tags.schema.json", + "$id": "https://raw.githubusercontent.com/ortfo/db/v1.0.0/schemas/tags.schema.json", "$ref": "#/$defs/tags", "$defs": { "Tag": { diff --git a/schemas/technologies.schema.json b/schemas/technologies.schema.json index 9eb29e6..a854742 100644 --- a/schemas/technologies.schema.json +++ b/schemas/technologies.schema.json @@ -1,6 +1,6 @@ { "$schema": "https://json-schema.org/draft/2020-12/schema", - "$id": "https://raw.githubusercontent.com/ortfo/db/v0.3.2/schemas/technologies.schema.json", + "$id": "https://raw.githubusercontent.com/ortfo/db/v1.0.0/schemas/technologies.schema.json", "$ref": "#/$defs/technologies", "$defs": { "Technology": {