Data

Tools

Indexes

Applications

Experiments

Open Source Science

https://github.com/caltechlibrary/flatlaketools

flatlakeTools is a prototype for making use of the content generate by CloudCannon's FlatLake

https://github.com/caltechlibrary/flatlaketools

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 (11.4%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

flatlakeTools is a prototype for making use of the content generate by CloudCannon's FlatLake

Basic Info
  • Host: GitHub
  • Owner: caltechlibrary
  • License: other
  • Language: HTML
  • Default Branch: main
  • Size: 355 KB
Statistics
  • Stars: 0
  • Watchers: 0
  • Forks: 0
  • Open Issues: 1
  • Releases: 2
Created 8 months ago · Last pushed 8 months ago
Metadata Files
Readme License Citation Codemeta

README.md

flatlakeTools

This is an experimental proof of concept set of tools for working with the FlatLake API generated by CloudCannon's Flat. The goal is to easily generate RSS 2.0 feeds from the JSON API as well as generated index blog page(s).

The primary tool is called flt. It is a command line tool supporting a YAML configuration file and actions for processing the JSON API provided by FlatLake application. The configuration is combined with an action and data source path to produce the desired content via standard out.

Here's the basic form of the command.

flt blogit COMMONMARK_FILE flt rss CHANNEL_NAME JSON_API_FILE flt markdown CHANNEL_NAME JSON_API_FILE

Here's an example of rendering a RSS 2.0 rss.xml for the "posts" channel.

shell flt rss posts api/all/page-1.json >rss.xml

Here's an example of rendering a CommonMark index.md file suitable for a blog index using the "posts" channel.

shell flt markdown posts api/all/page-1.json >index.md

The flt.yaml file might look something like this.

yaml channels: - name: posts title: "Tech Insights Blog" description: "The latest insights and news from the world of technology." link: "https://example.com/tech-insights" language: "en-us" copyright: "Copyright 2023 Tech Insights Blog. All rights reserved." managingEditor: "editor@techinsights.com" webMaster: "webmaster@techinsights.com"

Release Notes

  • version: 0.0.2
  • status: concept

This is a proof of concept

Authors

  • Doiel, R. S. Doiel

Software Requirements

  • Deno >= 2.4.3
  • CMTools >= 0.0.37

Software Suggestions

  • Pandoc >= 3.5
  • GNU Make >= 3
  • FlatLake >= 0.4.3
  • PageFind >= 1.3.0

Runtime platform

Deno

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: flatlakeTools
abstract: "This is an experimental proof of concept set of tools for working with the FlatLake API generated by CloudCannon's Flat. The goal is to easily generate RSS 2.0 feeds from the JSON API as well as generated index blog page(s)."
authors:
  - family-names: Doiel
    given-names: R. S. Doiel
    orcid: orcid.org/0000-0003-0900-6903
    email: rsdoiel@caltech.edu


repository-code: "https://github.com/caltechlibrary/flatlakeTools"
version: 0.0.2
date-released: 2025-08-04

license-url: "https://caltechlibrary.github.io/flatlakeTools/LICENSE"
keywords:
  - RSS
  - FlatLake
  - JSON

CodeMeta (codemeta.json) 

{
  "@context": "https://w3id.org/codemeta/3.0",
  "type": "SoftwareSourceCode",
  "codeRepository": "https://github.com/caltechlibrary/flatlakeTools",
  "author": [
    {
      "id": "orcid.org/0000-0003-0900-6903",
      "type": "Person",
      "givenName": "R. S. Doiel",
      "familyName": "Doiel",
      "email": "rsdoiel@caltech.edu"
    }
  ],
  "dateCreated": "2025-08-01",
  "dateModified": "2025-08-04",
  "datePublished": "2025-08-04",
  "description": "This is an experimental proof of concept set of tools for working with the FlatLake API generated by CloudCannon's Flat. The goal is to easily generate RSS 2.0 feeds from the JSON API as well as generated index blog page(s).",
  "keywords": [
    "RSS",
    "FlatLake",
    "JSON"
  ],
  "name": "flatlakeTools",
  "license": "https://caltechlibrary.github.io/flatlakeTools/LICENSE",
  "programmingLanguage": [
    "TypeScript"
  ],
  "runtimePlatform": "Deno",
  "softwareRequirements": [
    "Deno >= 2.4.3",
    "CMTools >= 0.0.37"
  ],
  "softwareSuggestions": [
    "Pandoc >= 3.5",
    "GNU Make >= 3",
    "FlatLake >= 0.4.3",
    "PageFind >= 1.3.0"
  ],
  "version": "0.0.2",
  "developmentStatus": "concept",
  "issueTracker": "https://github.com/caltechlibrary/flatlakeTools/issues",
  "releaseNotes": "working proof of concept supporting RSS and Markdown generations as well as copying a CommonMark document into the blog directory string after validation.",
  "copyrightYear": 2025,
  "copyrightHolder": "California Institute of Technology"
}

GitHub Events

Total
  • Create event: 2
  • Release event: 1
  • Issues event: 1
  • Push event: 4
Last Year
  • Create event: 2
  • Release event: 1
  • Issues event: 1
  • Push event: 4