Skip to content
Merged

v1 #20

Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
version: 2
updates:
- package-ecosystem: github-actions
directory: /
schedule:
interval: weekly
groups:
github-actions:
patterns:
- "*"

- package-ecosystem: pip
directory: /
schedule:
interval: weekly
groups:
python-dependencies:
patterns:
- "*"
10 changes: 10 additions & 0 deletions .github/workflows/metadata.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
name: Validate software metadata

on: [push, pull_request]

jobs:
metadata:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: LUMC-DCC/rs-metadata@v1
14 changes: 14 additions & 0 deletions CITATION.cff
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
cff-version: 1.2.0
title: diff-fuse
message: "If you use this software, please cite it using the metadata in this file."
type: software
abstract: >-
Tool for comparing multiple JSON documents side by side and producing a merged result interactively.
authors:
- family-names: Steeghs-Turchina
given-names: Mariia
affiliation: Leiden University Medical Center
orcid: https://orcid.org/0000-0002-0852-4752
version: 1.0.0
repository-code: https://github.com/bio-tools/diff-fuse
license: Apache-2.0
326 changes: 323 additions & 3 deletions backend/poetry.lock

Large diffs are not rendered by default.

3 changes: 2 additions & 1 deletion backend/pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[project]
name = "diff-fuse"
version = "0.1.0"
version = "1.0.0"
description = ""
authors = [
{name = "Mariia Steeghs-Turchina"}
Expand All @@ -15,6 +15,7 @@ dependencies = [
"pydantic-settings (>=2.12.0,<3.0.0)",
"orjson (>=3.11.7,<4.0.0)",
"redis (>=7.2.0,<8.0.0)",
"rs-metadata (>=1.0.0,<2.0.0)",
]

[tool.poetry.group.dev.dependencies]
Expand Down
4 changes: 3 additions & 1 deletion backend/src/diff_fuse/main.py
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@

import uuid
from contextlib import asynccontextmanager
from importlib.metadata import version

from fastapi import FastAPI, Request
from fastapi.exceptions import RequestValidationError
Expand Down Expand Up @@ -66,7 +67,8 @@ async def lifespan(app: FastAPI):
yield


app = FastAPI(title=settings.app_name, version="0.1.0", lifespan=lifespan)
# Read from the installed package, so pyproject.toml is the only place to bump it.
app = FastAPI(title=settings.app_name, version=version("diff-fuse"), lifespan=lifespan)


def _get_request_id(request: Request) -> str:
Expand Down
54 changes: 54 additions & 0 deletions codemeta.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
{

Check warning on line 1 in codemeta.json

View workflow job for this annotation

GitHub Actions / metadata

rs-metadata: recommendation.missing

codemeta.json omits 15 recommended fields: applicationSubCategory, continuousIntegration, datePublished, developmentStatus, funding, issueTracker, keywords, maintainer, operatingSystem, referencePublication, releaseNotes, runtimePlatform, softwareHelp, softwareRequirements, supportingData. Suggested fix: These are not required by the LUMC profile, but several are required by registries such as the Research Software Directory and bio.tools. See docs/using/profile.md for what each one is for.

Check warning on line 1 in codemeta.json

View workflow job for this annotation

GitHub Actions / metadata

rs-metadata: recommendation.missing

codemeta.json omits 15 recommended fields: applicationSubCategory, continuousIntegration, datePublished, developmentStatus, funding, issueTracker, keywords, maintainer, operatingSystem, referencePublication, releaseNotes, runtimePlatform, softwareHelp, softwareRequirements, supportingData. Suggested fix: These are not required by the LUMC profile, but several are required by registries such as the Research Software Directory and bio.tools. See docs/using/profile.md for what each one is for.
"@context": [
"https://w3id.org/codemeta/3.1",
{
"schema": "https://schema.org/"
}
],
"@type": "SoftwareSourceCode",
"name": "diff-fuse",
"description": "Tool for comparing multiple JSON documents side by side and producing a merged result interactively.",
"version": "1.0.0",
"identifier": "https://github.com/bio-tools/diff-fuse",

Check notice on line 12 in codemeta.json

View workflow job for this annotation

GitHub Actions / metadata

rs-metadata: recommendation.incomplete

codemeta.json records no DOI among its identifiers. A DOI is what makes a specific release citable and is required by most archives. Suggested fix: Mint one by enabling the Zenodo–GitHub integration and publishing a release. A Git tag URL is acceptable for internal tools that will never be formally published.

Check notice on line 12 in codemeta.json

View workflow job for this annotation

GitHub Actions / metadata

rs-metadata: recommendation.incomplete

codemeta.json records no DOI among its identifiers. A DOI is what makes a specific release citable and is required by most archives. Suggested fix: Mint one by enabling the Zenodo–GitHub integration and publishing a release. A Git tag URL is acceptable for internal tools that will never be formally published.
"author": [
{
"@id": "https://orcid.org/0000-0002-0852-4752",
"@type": "Person",
"givenName": "Mariia",
"familyName": "Steeghs-Turchina",
"affiliation": {
"@type": "Organization",
"@id": "https://ror.org/05xvt9f17",
"name": "Leiden University Medical Center"
}
}
],
"license": "https://spdx.org/licenses/Apache-2.0",
"codeRepository": "https://github.com/bio-tools/diff-fuse",
"programmingLanguage": [
{
"@type": "ComputerLanguage",
"name": "Python",
"version": ">=3.12,<4.0"
},
{
"@type": "ComputerLanguage",
"name": "TypeScript",
"version": "~5.9.3"
},
{
"@type": "ComputerLanguage",
"name": "CSS"
}
],
"applicationCategory": [
"Web API",
"Web application"
],
"schema:featureList": [
"http://edamontology.org/operation_2945",
"http://edamontology.org/operation_1812",
"http://edamontology.org/operation_3436",
"http://edamontology.org/operation_0336"
]
}
2 changes: 1 addition & 1 deletion frontend/openapi.json

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions frontend/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion frontend/package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "frontend",
"private": true,
"version": "0.0.0",
"version": "1.0.0",
"type": "module",
"scripts": {
"dev": "vite",
Expand Down
2 changes: 1 addition & 1 deletion frontend/src/api/generated/core/OpenAPI.ts
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ export type OpenAPIConfig = {

export const OpenAPI: OpenAPIConfig = {
BASE: '',
VERSION: '0.1.0',
VERSION: '1.0.0',
WITH_CREDENTIALS: false,
CREDENTIALS: 'include',
TOKEN: undefined,
Expand Down
Loading