Data

Tools

Indexes

Applications

Experiments

Open Source Science

https://github.com/csbiology/yamlicious

https://github.com/csbiology/yamlicious

Science Score: 26.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Committers with academic emails
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (6.5%) to scientific vocabulary
Last synced: 10 months ago · JSON representation

Repository

Basic Info
  • Host: GitHub
  • Owner: CSBiology
  • Language: F#
  • Default Branch: main
  • Size: 185 KB
Statistics
  • Stars: 5
  • Watchers: 2
  • Forks: 0
  • Open Issues: 4
  • Releases: 0
Created about 2 years ago · Last pushed almost 2 years ago
Metadata Files
Readme

README.md

YAMLicious

NuGet Version NuGet Downloads

YAMLicious is a small YAML reader/writer inspired by Thoth.Json syntax!

Code examples

F# Model

```fsharp type Package = { Name: string Version: string option }

type ArcValidation = { ArcSpecificationVersion: string Packages: Package list }
```

YAML

yaml arc_specification: 2.0.0-draft validation_packages: - name: package1 version: 1.0.0 - name: package2 version: 2.0.0 - name: package3

Decode (from YAML)

```fsharp // from yaml let Example1 = "arcspecification: 2.0.0-draft validationpackages: - name: package1 version: 1.0.0 - name: package2 version: 2.0.0 - name: package3"

let packageEncoder : (YAMLicious.YAMLElement -> Package) = Decode.object (fun get -> { Name = get.Required.Field "name" Decode.string Version = get.Optional.Field "version" Decode.string } )

let arcValidationDecoder : (YAMLicious.YAMLElement -> ArcValidation) = Decode.object (fun get -> { ArcSpecificationVersion = get.Required.Field "arcspecification" Decode.string Packages = get.Required.Field "validationpackages" (Decode.list packageEncoder) } )

let actual : ArcValidation = Examples.ValidationPackageTypes.string |> Decode.read |> arcValidationDecoder

```

Encode (to YAML)

```fsharp // to yaml let Example2 = { ArcSpecificationVersion = "2.0.0-draft" Packages = [ { Name = "package1"; Version = Some "1.0.0" } { Name = "package2"; Version = Some "2.0.0" } { Name = "package3"; Version = None } ] }

let packageEncoder (pack: Package) = [ "name", Encode.string pack.Name Encode.tryInclude "version" Encode.string pack.Version ] |> Encode.choose |> Encode.object

let arcValidationEncoder (arc: ArcValidation) = Encode.object [ "arcspecification", Encode.string arc.ArcSpecificationVersion "validationpackages", Encode.list packageEncoder arc.Packages ]

let actual : string = Encode.write 2 (arcValidationEncoder Example2) ```

Local Development

Requirements

Because this library targets multiple programming languages we need to support all of them:

  • nodejs and npm
    • verify with node --version (Tested with v20.10.0)
    • verify with npm --version (Tested with v9.2.0)
  • .NET SDK
    • verify with dotnet --version (Tested with 8.0.205)
  • Python
    • verify with py --version (Tested with 3.11.9, known to work only for >=3.11)

Setup

This needs to be done on a fresh download once. Paths for python venv executable might be different depending on the OS.

  1. dotnet tool restore, Restore .NET tools (fable)
  2. npm i, install js dependencies
  3. py -m venv ./.venv, setup python virtual environment
  4. .\.venv\Scripts\Activate.ps1, activate python virtual environment
  5. install python dependencies
    1. python -m pip install -U pip setuptools
    2. python -m pip install poetry
    3. python -m poetry install --no-root

Testing

First activate python virtual environment (.\.venv\Scripts\Activate.ps1).

.\build.cmd test

or specify target

.\build.cmd test [f#, c#, js [native], py [native]]

Publish

Requires API keys for Nuget and PyPi.

The following command will run all tests, bundle and then start publishing!

.\build.cmd publish pipeline

or only publish specific targets, without test and bundle

.\build.cmd publish [npm, pypi, nuget]

GitHub Events

Total
  • Issues event: 1
  • Watch event: 1
Last Year
  • Issues event: 1
  • Watch event: 1

Committers

Last synced: over 1 year ago

All Time
  • Total Commits: 62
  • Total Committers: 3
  • Avg Commits per committer: 20.667
  • Development Distribution Score (DDS): 0.403
Past Year
  • Commits: 62
  • Committers: 3
  • Avg Commits per committer: 20.667
  • Development Distribution Score (DDS): 0.403
Top Committers
Name Email Commits
Caroline Ott c****4@g****m 37
Kevin F F****r@g****e 24
Kevin Schneider s****v@o****e 1
Committer Domains (Top 20 + Academic)
outlook.de: 1 gmx.de: 1

Issues and Pull Requests

Last synced: 11 months ago

All Time
  • Total issues: 12
  • Total pull requests: 1
  • Average time to close issues: 1 day
  • Average time to close pull requests: 5 minutes
  • Total issue authors: 3
  • Total pull request authors: 1
  • Average comments per issue: 0.5
  • Average comments per pull request: 0.0
  • Merged pull requests: 1
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 3
  • Pull requests: 0
  • Average time to close issues: about 21 hours
  • Average time to close pull requests: N/A
  • Issue authors: 2
  • Pull request authors: 0
  • Average comments per issue: 0.0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • Freymaurer (9)
  • kMutagene (2)
  • caroott (1)
Pull Request Authors
  • kMutagene (1)
Top Labels
Issue Labels
Type: Feature Request (5) Status: Needs Triage (1)
Pull Request Labels
Status: Needs Triage (1)

Packages

  • Total packages: 1
  • Total downloads:
    • nuget 7,009 total
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 4
  • Total maintainers: 2
nuget.org: yamlicious

A encoder/decoder based YAML parser in Thoth.Json style!

  • Versions: 4
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 7,009 Total
Rankings
Dependent repos count: 7.7%
Average: 14.1%
Dependent packages count: 20.5%
Maintainers (2)
FreymaurerK Joott
Last synced: 11 months ago