fanbase-cli

The fanbase command: browse, install and update grammars from the Fanbase registry.

The registry itself lives in the fanbase repository; this package is the client. You never need the whole registry: a spec is fetched when you ask for it, and fetched again only when the registry has a newer one.

Install

pip install fanbase

Fandango depends on fanbase, so pip install fandango-fuzzer installs it too.

Using specs with Fandango

fandango -F NAME is fandango -f FILE, for a spec from the registry. The spec is fetched into Fandango's standard library location if it is missing or out of date, and then used:

fandango fuzz -F png -n 10                  # the default PNG spec; writes png-inputs/fandango-0000.png ...
fandango fuzz -F png-apng -n 10 -d apngs    # a named variant, into a directory of your choice
fandango fuzz -F png -f mypng.fan -n 10     # your own rules on top of the Fanbase spec

Since the format is known, the file name extension is set for you, and with neither -o nor -d the files go to a fresh directory (png-inputs, then png-inputs-2, ...). Every other fandango fuzz option works as usual. See the Fandango documentation for details.

Commands

fanbase list [FORMAT]

Without an argument, list the formats in the registry. With a format, list its specs, with a one-line description and any Python packages they need. Installed specs are marked with *.

fanbase list
#   bmp   3 specs
#   png   6 specs

fanbase list png
#  *png             Valid PNGs of every colour type with all the standard chunks
#   png-apng        Animated PNG (APNG) with the usual ancillary chunks
#   ...

fanbase show REF

Print a spec's metadata: description, version, file extensions, required packages.

fanbase install REF... [--into DIR]

Copy specs into the directory Fandango's include() searches, so they can be included straight away. REF is <format>/<kind>, a plain kind such as png-apng, or a plain <format> for the format's default spec. Installing a spec that is already up to date does nothing.

fanbase install png png-apng
#   installed png/png -> ~/Library/Fandango/png/png.fan
#     include("png/png.fan")
#   installed png/png-apng -> ~/Library/Fandango/png/png-apng.fan
#     include("png/png-apng.fan")

A spec that imports third-party Python packages lists them under requires; install those before using the spec. Most specs need nothing beyond the standard library.

--into DIR installs somewhere else. The default follows Fandango's own search order: $FANDANGO_PATH (first entry), then $XDG_DATA_HOME/fandango, then ~/Library/Fandango (macOS) or ~/.local/share/fandango (elsewhere).

fanbase update [REF...]

Bring installed specs up to date. Without arguments, every installed spec is checked.

fanbase reindex [--check]

For registry maintainers. Brings every metadata.yml and the root index.yml in line with the .fan files, and tells you which specs still have no description. Run it before committing changes to the registry. It needs a local checkout.

--check changes nothing and exits with status 1 if anything is out of date, which makes it fit for CI.

Finding the registry

fanbase looks, in order, at:

1. --registry PATH-or-URL (before the subcommand)
2. the FANBASE_REGISTRY environment variable
3. the current directory and its parents, for a registry checkout (specs/ and index.yml)
4. the public registry, https://github.com/fandango-fuzzer/fanbase

fanbase --registry ~/code/fanbase list          # a local checkout
export FANBASE_REGISTRY=https://example.org/my-registry

A github.com URL (optionally .../tree/<ref>) is read through raw.githubusercontent.com. Any other URL must serve raw file bytes. Remote reads use index.yml only: list fetches that one file, install fetches the one spec it installs and checks it against the hash recorded in the index.

If the registry cannot be reached, fandango -F uses the copy that is already installed, with a warning, so a test run does not depend on the network.

Registry layout

specs/<format>/<kind>/<kind>.fan
specs/<format>/<kind>/metadata.yml
index.yml

The default spec of a format is the kind named after the format: specs/png/png/png.fan. Any other kind is named <format>-<what makes it different>, e.g. png-apng.

index.yml is generated: it repeats every metadata.yml, plus each spec's path and SHA-256, so a client can browse the registry from a single file.

An installed spec is <install dir>/<format>/<kind>.fan, with a copy of its metadata next to it as <kind>.yml.

metadata.yml

format: png
kind: png-apng
description: Animated PNG (APNG) with the usual ancillary chunks
fanbase: 0.4.0
fandango: '>=1.3'
requires: []
version: '1.0'
title: Portable Network Graphics
extensions:
- png
mime: image/png
reference: https://www.w3.org/TR/png-3/

key
format, kind	From the folder names.
description	One line. Written by hand.
fanbase	Version of this package that last ran reindex.
fandango	Fandango versions the spec is written for. Defaults to >=1.3; edit by hand.
requires	Third-party Python packages the spec imports, found by scanning its import lines (standard library and Fandango excluded). Listed by import name.
version	Version of the spec. Written by hand.
extensions	File name extensions of the format; the first one is used for generated files.

Other keys (title, mime, reference, ...) are kept as they are.

Run fanbase reindex and it creates metadata.yml where it's missing and refreshes the generated keys. description, fandango and any extra keys you add are left alone.

Development

pip install -e . pytest
pytest

Licence

Apache-2.0.