Small utility to convert the Jargon File DocBook XML and print random entries.
Project description
Jargon utility
Small CLI for browsing the Jargon File from your terminal — random entries, term lookups, colored output. Supports both the classic ESR edition and the actively maintained community edition.
"The Jargon File is a glossary and usage dictionary of slang used by computer programmers. The original Jargon File was a collection of terms from technical cultures such as the MIT AI Lab, the Stanford AI Lab (SAIL) and others of the old ARPANET AI/LISP/PDP-10 communities, including Bolt, Beranek and Newman (BBN), Carnegie Mellon University, and Worcester Polytechnic Institute. It was published in paperback form in 1983 as The Hacker's Dictionary (edited by Guy Steele) and revised in 1991 as The New Hacker's Dictionary (ed. Eric S. Raymond; third edition published 1996)." — Wikipedia
Data sources
- Classic edition — Jargon File 4.1.0 (DocBook XML), last updated 2003 by Eric S. Raymond. Bundled with this repo.
- Community edition — agiacalone/jargonfile, actively maintained. Downloaded on demand with
jargon fetch.
Install
Quick (no clone)
uv tool install 'git+https://github.com/rdubar/jargon.git'
# or:
pipx install 'git+https://github.com/rdubar/jargon.git'
From a clone
gh repo clone rdubar/jargon && cd jargon
uv venv && source .venv/bin/activate
uv pip install -e .
Usage
Classic edition (default)
jargon # random entry
jargon endian # look up a term (case-insensitive, partial match ok)
jargon --all # show all senses for the entry
jargon build # rebuild JSON from bundled XML
Community edition
jargon fetch # download & parse community data (~2300 entries)
jargon -c # random entry from community data
jargon -c ABEND # look up a term in community data
jargon -c --all # show all senses
Commands
| Command | What it does |
|---|---|
jargon [term] |
Random entry, or look up a term in the classic edition |
jargon build |
Rebuild JSON from bundled DocBook XML |
jargon fetch |
Download community edition and build local JSON cache |
jargon -c [term] |
Random entry or lookup from community edition |
Flags: --all / -a show all senses · --rebuild / -r force JSON regeneration · --xml / --json override data paths
Data files
data/jargon.xml— bundled classic DocBook sourcedata/jargon.json— generated from XML (auto-built on first run)data/community.json— generated byjargon fetch(gitignored, local only)
Notes
- Requires Python 3.10+.
- If the console script isn't on your PATH, run
python jargon_tool.py --help.
License
The utility code is MIT licensed — see LICENSE.
The bundled Jargon File data (data/jargon.xml) is copyright 1993 Eric S. Raymond, all rights reserved, and is included here for personal and educational use only.
Author
Roger Dubar — rdubar@gmail.com — github.com/rdubar
Credits
Jargon File 4.1.0 by Eric S. Raymond esr@snark.thyrsus.com — https://catb.org/jargon/
The actively maintained community edition of the Jargon File is at agiacalone/jargonfile — submissions and corrections welcome there.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file jargon_file-0.1.0.tar.gz.
File metadata
- Download URL: jargon_file-0.1.0.tar.gz
- Upload date:
- Size: 1.4 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.11.2 {"installer":{"name":"uv","version":"0.11.2","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
b93c556f8710b637418ed49a931baafb5a9b95d49900a937c9c41f5872a8a525
|
|
| MD5 |
b54d72ca2e900bb2ec511a1a2fa74ed6
|
|
| BLAKE2b-256 |
00fe0287c3248c7a2d831d3161f4b96cb5150b4383bf1ba43d18303fb4d22a98
|
File details
Details for the file jargon_file-0.1.0-py3-none-any.whl.
File metadata
- Download URL: jargon_file-0.1.0-py3-none-any.whl
- Upload date:
- Size: 1.4 MB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.11.2 {"installer":{"name":"uv","version":"0.11.2","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
5c430d7cee51ea48cf17b39b7a74c86661b255dabdc4106086c394a85b3d17a5
|
|
| MD5 |
6204c3f41c93fd8bf6d641d46c3764af
|
|
| BLAKE2b-256 |
b66f0af0af63563b2b8903120b980d57b335ddf5987dc376d1b42fe4fea889ea
|