Data

Tools

Indexes

Applications

Experiments

Open Source Science

pairtree

A simple encoder/decoder for converting object identifiers into a Pair Tree Path (path)

https://github.com/caltechlibrary/pairtree

Science Score: 52.0%

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

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Academic email domains
  • ✓
    Institutional organization owner
    Organization caltechlibrary has institutional domain (www.library.caltech.edu)
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (5.5%) to scientific vocabulary

Keywords

file-system-layout library-science pairtree
Last synced: 6 months ago · JSON representation ·

Repository

A simple encoder/decoder for converting object identifiers into a Pair Tree Path (path)

Basic Info
Statistics
  • Stars: 5
  • Watchers: 8
  • Forks: 0
  • Open Issues: 0
  • Releases: 7
Topics
file-system-layout library-science pairtree
Created over 7 years ago · Last pushed 7 months ago
Metadata Files
Readme License Citation Codemeta

README.md

Pairtree

This is a library for translate a UTF-8 string to/from a pairtree notation. This is typically used in storing things on disc (e.g. repository filesystems). This code is based on the specification found at https://confluence.ucop.edu/download/attachments/14254128/PairtreeSpec.pdf?version=2&modificationDate=1295552323000&api=v2 which is cited on the OCFL wiki.

Features

  • Set() will let you set the path separator
    • Separator is a readonly value of the file separator used by Encode() and Decode()
  • Encode() will encode the provided string as a pairtree path
  • Decode() will decode a pairtree path returning the unencoded string

Example

``` import ( "fmt" "os"

    "github.com/caltechlibrary/pairtree"
)

func main() {
    key := "12mIEERD11"
    fmt.Printf("Key: %q\n", key)
    pairPath := pairtree.Encode(key)
    fmt.Printf("Endoded key %q -> %q\n", key, pairPath)
    key = Decode(pairPath)
    fmt.Printf("Decoded path %q -> %q\n", pairPath, key)
}

```

Owner

  • Name: Caltech Library
  • Login: caltechlibrary
  • Kind: organization
  • Email: helpdesk@library.caltech.edu
  • Location: Pasadena, CA 91125

We manage the physical and digital holdings of the California Institute of Technology, provide services and training, and develop open-source software.

Citation (CITATION.cff) 

cff-version: 1.2.0
message: "If you use this software, please cite it as below."
type: software
title: "pairtree"
abstract: "A Golang pairtree implementation."
authors:
  - family-names: Doiel
    given-names: R. S.
    orcid: "https://orcid.org/0000-0003-0900-6903"

maintainers:
  - family-names: Doiel
    given-names: Robert
    orcid: "https://orcid.org/0000-0003-0900-6903"

repository-code: "https://github.com/caltechlibrary/pairtree"
version: 1.0.4
license-url: "https://github.com/caltechlibrary/pairtree/blob/main/LICENSE"
keywords: [ "software", "science" ]
date-released: 2024-08-29

CodeMeta (codemeta.json) 

{
  "@context": "https://doi.org/10.5063/schema/codemeta-2.0",
  "@type": "SoftwareSourceCode",
  "description": "A Golang pairtree implementation.",
  "releaseNotes": "Updated Go version to 1.22, updated docs, added man pages",
  "name": "pairtree",
  "codeRepository": "https://github.com/caltechlibrary/pairtree",
  "issueTracker": "https://github.com/caltechlibrary/pairtree/issues",
  "license": "https://github.com/caltechlibrary/pairtree/blob/main/LICENSE",
  "version": "1.0.4",
  "dateCreated": "2018-06-26",
  "datePublished": "2024-08-29",
  "dateModified": "2024-08-29",
  "dateReleased": "2024-08-29",
  "author": [
    {
      "@type": "Person",
      "givenName": "R. S.",
      "familyName": "Doiel",
      "affiliation": {
        "@type": "Organization",
        "name": "Caltech Library"
      },
      "email": "rsdoiel@caltech.edu",
      "@id": "https://orcid.org/0000-0003-0900-6903"
    }
  ],
  "developmentStatus": "active",
  "downloadUrl": "https://github.com/caltechlibrary/pairtree/archive/main.zip",
  "keywords": [
    "software",
    "science"
  ],
  "maintainer": [
    {
      "@type": "Person",
      "givenName": "Robert",
      "familyName": "Doiel",
      "affiliation": {
        "@type": "Organization",
        "name": "Caltech Library"
      },
      "email": "rsdoiel@caltech.edu",
      "@id": "https://orcid.org/0000-0003-0900-6903"
    }
  ],
  "funder": [
    {
      "@id": "https://doi.org/10.13039/100006961",
      "@type": "Organization",
      "name": "Caltech Library"
    }
  ],
  "programmingLanguages": [
    "Go >= 1.22"
  ]
}

GitHub Events

Total
  • Push event: 2
Last Year
  • Push event: 2

Issues and Pull Requests

Last synced: 11 months ago

All Time
  • Total issues: 1
  • Total pull requests: 0
  • Average time to close issues: 2 days
  • Average time to close pull requests: N/A
  • Total issue authors: 1
  • Total pull request authors: 0
  • Average comments per issue: 3.0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 1
  • Pull requests: 0
  • Average time to close issues: 2 days
  • Average time to close pull requests: N/A
  • Issue authors: 1
  • Pull request authors: 0
  • Average comments per issue: 3.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
  • angelahuqing (1)
Pull Request Authors
Top Labels
Issue Labels
enhancement (1)
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads: unknown
  • Total dependent packages: 7
  • Total dependent repositories: 2
  • Total versions: 6
proxy.golang.org: github.com/caltechlibrary/pairtree

pairtree.go implements encoding/decoding of object identifiers and pairtree paths (paths) per https://confluence.ucop.edu/download/attachments/14254128/PairtreeSpec.pdf?version=2&modificationDate=1295552323000&api=v2 Author R. S. Doiel, <rsdoiel@library.caltech.edu> Copyright (c) 2022, Caltech All rights not granted herein are expressly reserved by Caltech. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

  • Versions: 6
  • Dependent Packages: 7
  • Dependent Repositories: 2
Rankings
Dependent packages count: 2.2%
Dependent repos count: 3.5%
Average: 9.5%
Stargazers count: 13.5%
Forks count: 18.9%
Last synced: 6 months ago

Dependencies

go.mod go