Skip to main content

Write i2 Analyst's Notebook Exchange (.anx) files from Python, JSON, or YAML

Project description

anxwritter

Write i2 Analyst's Notebook Exchange (.anx) files from Python, JSON, or YAML.

Output files open directly in i2 ANB 9+ via File > Open — no import wizard, no intermediate CSV. The .anx file embeds the entire chart as XML.

This project is independent and not affiliated with, endorsed by, or sponsored by the makers of i2 Analyst's Notebook — past or present — including IBM, i2 Group Limited, i2 Limited, N.Harris Computer Corporation, Harris Computer Corporation, or Constellation Software Inc. — nor by Esri, Microsoft, or Google. "i2", "i2 Analyst's Notebook", "ANB", "Esri", "Esri Maps", "Microsoft", and "Google" are trademarks of their respective owners and are referenced here solely to identify the file format and the tools this library interoperates with (nominative use).

To produce structurally valid .anx files, this library embeds nine format identifiers: six abstract-root GUIDs required by the lcx:LibraryCatalogue schema and three geo-map property GUIDs required by ANB's Esri Maps subsystem. These are functional tokens (format anchors), not creative content, reproduced for interoperability purposes. The library ships nothing else from i2's type system — no standard-library types, no icon catalog, no palette definitions. All of that content stays in the user's licensed ANB installation and must be supplied by the user.

This design is intentional: organisations are free to define their own default semantic types, palettes, icon mappings, link types, and attribute classes.


Install

# As a library — import in your own code
pip install anxwritter

# With YAML support (optional)
pip install anxwritter[yaml]

# As a command-line tool only (isolated venv, no env conflicts)
pipx install anxwritter

With uv:

# Add to a uv-managed project
uv add anxwritter
uv add 'anxwritter[yaml]'           # with YAML support

# Install globally as a CLI tool
uv tool install anxwritter

# One-off run without installing
uvx anxwritter chart.yaml -o my_chart.anx

Requires Python 3.10+.

Want a standalone executable? pip install pyinstaller (or nuitka) and point it at anxwritter/cli.py. anxwritter does not ship pre-built binaries.


Quick example

from anxwritter import ANXChart

chart = ANXChart()

chart.add_icon(id='Alice', type='Person', color='Blue')
chart.add_icon(id='Bob',   type='Person', color='Red')

chart.add_link(
    from_id='Alice', to_id='Bob',
    type='Telephone Call', arrow='->',
    date='2024-01-15',
)

chart.to_anx('output/my_chart')

This writes output/my_chart.anx. Open it in ANB.

YAML + CLI

# chart.yaml
entities:
  icons:
    - { id: Alice, type: Person, color: Blue }
    - { id: Bob,   type: Person, color: Red }
links:
  - { from_id: Alice, to_id: Bob, type: Telephone Call, arrow: '->', date: '2024-01-15' }
anxwritter chart.yaml -o output/my_chart.anx

What's in the box

  • Typed dataclass APIIcon, Box, Circle, ThemeLine, EventFrame, TextBlock, Label, Link, Card
  • Three input forms — Python objects, JSON, or YAML; all paths produce identical output
  • Org-level config files — separate entity types, link types, attribute classes, palettes from per-chart data; layered configs supported
  • Auto-layout — circle, grid, or random placement; manual x/y always wins
  • Geographic positioning — map entity attributes to lat/lon for canvas layout and/or ANB Esri Maps
  • Auto-coloring — distribute HSV hues across entities; matching link colors
  • Validation — collects every error in one pass before writing the file
  • Semantic types — full lcx:LibraryCatalogue support with custom type extension
  • CLIanxwritter [--config org.yaml ...] data.{json,yaml} -o out.anx

Customize everything ANB exposes

No fixed catalog — every configurable surface in ANB is yours to define:

  • Entity types & link types — names, icons, colors, shading, semantic-type bindings
  • Attribute classes — type, prefix/suffix, decimals, font, merge behavior, icons, visibility
  • Palettes — your own "Insert from Palette" panels with grouped types and pre-filled attribute entries
  • Legend — 8 item types (icon, link, line, font, text, attribute, timezone, icon-frame) with full styling
  • Colors — 40 named, hex, COLORREF, or auto-distributed HSV with link colors that follow the entity
  • Strengths, grades, source types, datetime formats, semantic types — all configurable

Define your defaults once in config.yaml, layer overrides on top, reuse across every chart.


Documentation


License

MIT — see LICENSE. Copyright (c) 2024-2026 gustavo-gkmi.

Developed with the help of AI coding assistants.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

anxwritter-1.0.0.tar.gz (243.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

anxwritter-1.0.0-py3-none-any.whl (97.0 kB view details)

Uploaded Python 3

File details

Details for the file anxwritter-1.0.0.tar.gz.

File metadata

  • Download URL: anxwritter-1.0.0.tar.gz
  • Upload date:
  • Size: 243.0 kB
  • 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":null,"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for anxwritter-1.0.0.tar.gz
Algorithm Hash digest
SHA256 1c96c15d79b48ee513f31d709b75b44bf1e4c198aa33c782f0ab55d377e83f2f
MD5 ba2d61ae4baa679a9a52daae587eaeeb
BLAKE2b-256 79ff916046c156f76a8bdbac3a1da1028abe8b4e37330edbb9c707a4da60f9ff

See more details on using hashes here.

File details

Details for the file anxwritter-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: anxwritter-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 97.0 kB
  • 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":null,"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for anxwritter-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 5802e79811275538001cbda51326c56f334412f8d6624f3170c60116d7e177d1
MD5 a34337e60828222684b0a13960483cca
BLAKE2b-256 d7e918e7ea1c0e2cd2972e8e03ab48374e4bd37129336bce0d9e22e86fd144f2

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page