cmtools

Project build tools leveraging CodeMeta JSON file.

https://github.com/caltechlibrary/cmtools

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

Keywords

build-tooling code-generation codemeta-json
Last synced: 4 months ago · JSON representation ·

Repository

Project build tools leveraging CodeMeta JSON file.

Basic Info
Statistics
  • Stars: 1
  • Watchers: 3
  • Forks: 0
  • Open Issues: 7
  • Releases: 36
Topics
build-tooling code-generation codemeta-json
Created 12 months ago · Last pushed 5 months ago
Metadata Files
Readme License Citation Codemeta

README.md

CMTools

CodeMeta Tools provides a simple command line tool called cmt that can be used to generate project files and software artifacts. It provides a tool called cme to edit and manage the CodeMeta file.

The project focuses on leveraging CodeMeta data, directory name and Git repo information for building and release software written in Python, Go, JavaScript or TypeScript. It was motivated by the practices in Caltech Library's Digital Development Group.

The tools are intended to be run from the project root directory. cmt expects the file path of your codemeta.json file as well as one or more target files to be generated. The target file's extension determines the generated content. The tool can generate the following project files based on the contents of the codemeta.json file. cme expects the file path of your codemeta.json file and optionally the attributes of the CodeMeta object you wish to manage.

cme is used to create and manage "codemeta.json". cmt is used to generate the following.

  • README.md
  • INSTALL.md
  • installer.sh
  • installer.ps1
  • CITATION.cff
  • version.ts, version.js, version.go or version.py
  • about.md
  • page.tmpl (Pandoc template) or page.hbs (handlebars template)
  • Makefile (for Go or Deno based projects)
  • website.mak
  • release.bash
  • publish.bash

Release Notes

  • version: 0.0.39
  • status: active
  • released: 2025-08-06

Corrected CodeMeta version number, shoud have been v0.0.38 but was set to v0.0.34 (a prior release).

Bug fixes.

  • Issue #33, Updates the code that generates search.md to include proper path handling and to process a '?q=<SEARCH_TERM>' URL string.

Authors

  • Doiel, R. S.

Contributors

  • Morrell, Tom

Maintainers

  • Doiel, R. S.

Software Requirements

  • Deno >= 2.4.3
  • CMTools >= 0.0.37

Software Suggestions

  • GNU Make >= 3.81
  • Pandoc >= 3.1
  • Git >= 2.39

Related resources

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: CMTools
abstract: "[CodeMeta](https://codemeta.github.io) Tools provides a simple command line tool called `cmt` that can be used to generate project files and software artifacts. It provides a tool called `cme` to edit and manage the CodeMeta file.

The project focuses on leveraging CodeMeta data, directory name and Git repo information for building and release software written in Python, Go, JavaScript or TypeScript. It was motivated by the practices in Caltech Library's Digital Development Group.

The tools are intended to be run from the project root directory. `cmt` expects the file path of your codemeta.json file as well as one or more target files to be generated. The target file's extension determines the generated content. The tool can generate the following project files based on the contents of the codemeta.json file. `cme` expects the file path of your codemeta.json file and optionally the attributes of the CodeMeta object you wish to manage.

`cme` is used to create and manage "codemeta.json". `cmt` is used to generate the following.

- README.md
- INSTALL.md
- installer.sh
- installer.ps1
- CITATION.cff
- version.ts, version.js, version.go or version.py
- about.md
- page.tmpl (Pandoc template) or page.hbs (handlebars template)
- Makefile (for Go or Deno based projects)
- website.mak
- release.bash
- publish.bash"
authors:
  - family-names: Doiel
    given-names: R. S.
    orcid: https://orcid.org/0000-0003-0900-6903
    email: rsdoiel@caltech.edu

contacts:
  - family-names: Doiel
    given-names: R. S.
    orcid: https://orcid.org/0000-0003-0900-6903
    email: rsdoiel@caltech.edu

repository-code: "git+https://github.com/caltechlibrary/CMTools"
version: 0.0.40
date-released: 2025-08-06

license-url: "https://caltechlibrary.github.io/CMTools/LICENSE"
keywords:
  - codemeta
  - cff
  - software
  - code generation
  - markdown generation

CodeMeta (codemeta.json)

{
  "@context": "https://doi.org/10.5063/schema/codemeta-2.0",
  "type": "SoftwareSourceCode",
  "codeRepository": "git+https://github.com/caltechlibrary/CMTools",
  "author": [
    {
      "id": "https://orcid.org/0000-0003-0900-6903",
      "type": "Person",
      "givenName": "R. S.",
      "familyName": "Doiel",
      "affiliation": {
        "id": "https://ror.org/05dxps055",
        "type": "Organization"
      },
      "email": "rsdoiel@caltech.edu"
    }
  ],
  "contributor": [
    {
      "id": "https://orcid.org/0000-0001-9266-5146",
      "type": "Person",
      "givenName": "Tom",
      "familyName": "Morrell",
      "affiliation": {
        "id": "https://ror.org/5dxps055",
        "type": "Organization"
      },
      "email": "tmorrell@caltech.edu"
    }
  ],
  "maintainer": [
    {
      "id": "https://orcid.org/0000-0003-0900-6903",
      "type": "Person",
      "givenName": "R. S.",
      "familyName": "Doiel",
      "affiliation": {
        "id": "https://ror.org/05dxps055",
        "type": "Organization"
      },
      "email": "rsdoiel@caltech.edu"
    }
  ],
  "dateCreated": "2025-01-07",
  "dateModified": "2025-08-06",
  "datePublished": "2025-08-06",
  "description": "[CodeMeta](https://codemeta.github.io) Tools provides a simple command line tool called `cmt` that can be used to generate project files and software artifacts. It provides a tool called `cme` to edit and manage the CodeMeta file.\n\nThe project focuses on leveraging CodeMeta data, directory name and Git repo information for building and release software written in Python, Go, JavaScript or TypeScript. It was motivated by the practices in Caltech Library's Digital Development Group.\n\nThe tools are intended to be run from the project root directory. `cmt` expects the file path of your codemeta.json file as well as one or more target files to be generated. The target file's extension determines the generated content. The tool can generate the following project files based on the contents of the codemeta.json file. `cme` expects the file path of your codemeta.json file and optionally the attributes of the CodeMeta object you wish to manage.\n\n`cme` is used to create and manage \"codemeta.json\". `cmt` is used to generate the following.\n\n- README.md\n- INSTALL.md\n- installer.sh\n- installer.ps1\n- CITATION.cff\n- version.ts, version.js, version.go or version.py\n- about.md\n- page.tmpl (Pandoc template) or page.hbs (handlebars template)\n- Makefile (for Go or Deno based projects)\n- website.mak\n- release.bash\n- publish.bash",
  "funder": {
    "id": "https://ror.org/5dxps055",
    "type": "Organization",
    "name": "Caltech Library"
  },
  "funding": "Caltech Library",
  "keywords": [
    "codemeta",
    "cff",
    "software",
    "code generation",
    "markdown generation"
  ],
  "name": "CMTools",
  "license": "https://caltechlibrary.github.io/CMTools/LICENSE",
  "operatingSystem": [
    "Linux",
    "Windows",
    "macOS"
  ],
  "programmingLanguage": [
    "TypeScript"
  ],
  "relatedLink": "https://caltechlibrary.github.io/CMTools",
  "softwareRequirements": [
    "Deno >= 2.4.3",
    "CMTools >= 0.0.37"
  ],
  "softwareSuggestions": [
    "GNU Make >= 3.81",
    "Pandoc >= 3.1",
    "Git >= 2.39"
  ],
  "version": "0.0.40",
  "developmentStatus": "active",
  "issueTracker": "git+https://github.com/caltechlibrary/CMTools/issues",
  "releaseNotes": "Update page templates generated for Caltech Library.",
  "copyrightYear": 2025,
  "copyrightHolder": "California Institute of Technology"
}

GitHub Events

Total
  • Create event: 33
  • Issues event: 46
  • Release event: 34
  • Watch event: 1
  • Delete event: 1
  • Issue comment event: 22
  • Push event: 165
Last Year
  • Create event: 33
  • Issues event: 46
  • Release event: 34
  • Watch event: 1
  • Delete event: 1
  • Issue comment event: 22
  • Push event: 165

Issues and Pull Requests

Last synced: 4 months ago

All Time
  • Total issues: 29
  • Total pull requests: 0
  • Average time to close issues: 5 days
  • Average time to close pull requests: N/A
  • Total issue authors: 2
  • Total pull request authors: 0
  • Average comments per issue: 0.48
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 29
  • Pull requests: 0
  • Average time to close issues: 5 days
  • Average time to close pull requests: N/A
  • Issue authors: 2
  • Pull request authors: 0
  • Average comments per issue: 0.48
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • rsdoiel (24)
  • tmorrell (5)
Pull Request Authors
Top Labels
Issue Labels
bug (14) enhancement (11) critical (2) question (1) good first issue (1)
Pull Request Labels