popstar

Phone-Oriented Processing SofTware for ARchives

https://github.com/caltechlibrary/popstar

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 (16.2%) to scientific vocabulary

Keywords

archiving digitization document-processing iphone libraries scanning shortcuts-app workflow-automation
Last synced: 4 months ago · JSON representation ·

Repository

Phone-Oriented Processing SofTware for ARchives

Basic Info
Statistics
  • Stars: 2
  • Watchers: 4
  • Forks: 0
  • Open Issues: 6
  • Releases: 1
Topics
archiving digitization document-processing iphone libraries scanning shortcuts-app workflow-automation
Created almost 2 years ago · Last pushed over 1 year ago
Metadata Files
Readme Changelog Contributing License Code of conduct Citation Security Support Codemeta

README.md

PopstarPopstar icon. Artwork by Mary Quilao from the Noun Project.

Popstar (Phone-based processing software for archives) is an Apple Shortcuts-based workflow for digitizing and processing documents in library archives.

License Latest release DOI iOS AppleScript

Table of contents

Introduction

Photo of a room full of banker's boxes containing papers from a faculty member. For many years, the Caltech Library Archives has been accessioning materials from selected retired faculty members. The traditional approach to digitizing physical materials (e.g., correspondences, notebooks, manuscripts written on typewriters, etc.) has involved the use of scanning tables and manual file organization – which are slow and laborious processes. However, computing technologies have improved so much in recent years that we decided to experiment with workflows that make use of modern devices and software tools. Popstar (Phone-based processing software for archives) is one of the outcomes.

Popstar is based on Apple iPhone and macOS software and services. Popstar consists of several Shortcuts, a no-code automation development framework that works on iOS, iPadOS, iWatchOS, and macOS. We used Shortcuts to create workflows that perform scanning and filing of digital images.

This repository contains the Shortcuts that comprise Popstar, along with documentation about how they work and how to use them.

Installation and usage

Documentation for Popstar is available online at https://caltechlibrary.github.io/popstar/.

Getting Help

If you find an issue, please submit it in the GitHub issue tracker for this repository.

Contributing

Your help and participation in enhancing Popstar is welcome! Please visit the guidelines for contributing for some tips on getting started.

License

Software produced by the Caltech Library is Copyright © 2024 California Institute of Technology. This software is freely distributed under a modified BSD 3-clause license. Please see the LICENSE file for more information.

Acknowledgments

This work was funded by the California Institute of Technology Library.

The vector artwork used as a starting point for the logo for this repository was created by Mary Quilao for the Noun Project. It is licensed under the Creative Commons Attribution 3.0 Unported license. The vector graphics was modified by Mike Hucka to change the color.


Caltech logo

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.
authors:
  - family-names: Hucka
    given-names: Michael
    orcid: https://orcid.org/0000-0001-9105-5960
  - family-names: Keswick
    given-names: Tommy
    orcid: https://orcid.org/0000-0001-5644-440X
title: Popstar
abstract: PhOne-based Processing SofTware for ARchives
version: 0.0.3
date-released: 2024-07-05
url: https://caltechlibrary.github.io/popstar
repository-code: https://github.com/caltechlibrary/popstar
license-url: https://github.com/caltechlibrary/popstar/blob/main/LICENSE
type: software
keywords:
  - Apple Shortcuts
  - software

CodeMeta (codemeta.json)

{
  "@context": "https://doi.org/10.5063/schema/codemeta-2.0",
  "@type": "SoftwareSourceCode",
  "name": "Popstar",
  "identifier": "popstar",
  "description": "PhOne-based Processing SofTware for ARchives",
  "version": "0.0.3",
  "datePublished": "2024-07-05",
  "dateCreated": "2024-03-26",
  "author": [
    {
      "@type": "Person",
      "givenName": "Michael",
      "familyName": "Hucka",
      "affiliation": {
        "@type": "Organization",
        "name": "California Institute of Technology Library"
      },
      "email": "mhucka@caltech.edu",
      "@id": "https://orcid.org/0000-0001-9105-5960"
    },
    {
      "@type": "Person",
      "givenName": "Tommy",
      "familyName": "Keswick",
      "affiliation": {
        "@type": "Organization",
        "name": "California Institute of Technology Library"
      },
      "email": "tkeswick@caltech.edu",
      "@id": "https://orcid.org/0000-0001-5644-440X"
    }
  ],
  "maintainer": [
    {
      "@type": "Person",
      "givenName": "Michael",
      "familyName": "Hucka",
      "affiliation": {
        "@type": "Organization",
        "name": "California Institute of Technology Library"
      },
      "email": "mhucka@.caltech.edu",
      "@id": "https://orcid.org/0000-0001-9105-5960"
    }
  ],
  "funder": {
    "@id": "https://ror.org/05dxps055",
    "@type": "Organization",
    "name": "California Institute of Technology Library"
  },
  "copyrightHolder": [
    {
      "@id": "https://ror.org/05dxps055",
      "@type": "Organization",
      "name": "California Institute of Technology"
    }
  ],
  "copyrightYear": 2024,
  "license": "https://github.com/caltechlibrary/popstar/blob/main/LICENSE",
  "isAccessibleForFree": true,
  "url": "https://caltechlibrary.github.io/popstar",
  "codeRepository": "https://github.com/caltechlibrary/popstar",
  "readme": "https://github.com/caltechlibrary/popstar/blob/main/README.md",
  "releaseNotes": "https://github.com/caltechlibrary/popstar/blob/main/CHANGES.md",
  "issueTracker": "https://github.com/caltechlibrary/popstar/issues",
  "downloadUrl": "https://github.com/caltechlibrary/popstar/archive/main.zip",
  "softwareHelp": "https://caltechlibrary.github.io/popstar",
  "relatedLink": "https://data.caltech.edu/records/qkm6q-09336",
  "keywords": [
    "software",
    "library",
    "workflow",
    "archiving",
    "document scanning",
    "automation",
    "Apple Shortcuts",
    "iOS",
    "AppleScript"
  ],
  "developmentStatus": "active"
}

GitHub Events

Total
Last Year

Issues and Pull Requests

Last synced: 9 months ago

All Time
  • Total issues: 10
  • Total pull requests: 0
  • Average time to close issues: 9 days
  • Average time to close pull requests: N/A
  • Total issue authors: 3
  • Total pull request authors: 0
  • Average comments per issue: 0.1
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 5
  • Bot pull requests: 0
Past Year
  • Issues: 10
  • Pull requests: 0
  • Average time to close issues: 9 days
  • Average time to close pull requests: N/A
  • Issue authors: 3
  • Pull request authors: 0
  • Average comments per issue: 0.1
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 5
  • Bot pull requests: 0
Top Authors
Issue Authors
  • github-actions[bot] (5)
  • mhucka (4)
  • t4k (1)
Pull Request Authors
Top Labels
Issue Labels
bug (5)
Pull Request Labels

Dependencies

.github/workflows/bad-link-reporter.yml actions
  • caltechlibrary/baler v2 composite
.github/workflows/codemeta2cff.yml actions
  • EndBug/add-and-commit v9 composite
  • actions/checkout v3 composite
  • caltechlibrary/codemeta2cff main composite
.github/workflows/iga.yml actions
  • caltechlibrary/iga main composite
.github/workflows/markdown-linter.yml actions
  • DavidAnson/markdownlint-cli2-action v15 composite
  • actions/checkout v4 composite
.github/workflows/yaml-linter.yml actions
  • actions/checkout v4 composite
  • ibiqlik/action-yamllint v3.1.1 composite