Skip to main content

A terminal-based TUI for browsing IVS session schedules with fast filtering and keyboard navigation

Project description

IVS Sessions Browser v4 (dev)

A terminal-based TUI for browsing IVS session schedules: master and intensives, with fast filtering, keyboard navigation, and colorized status.

It is worth noting that this script is developed on Linux, for Linux terminal and optimized for a dark background! It is not tested by me on anything else. If you have any question, comment or feedback to this script; Send email -jole 2026

  • TUI: curses interface with smooth navigation
  • Filters: powerful, composable query language
  • Colors: quick status scanning (Released / Processing / Waiting / Cancelled / None)
  • Open in browser: jump to the IVS page for a session
  • Station filtering: filter active/removed/all station sets in expressions
  • Jump to today: one-key shortcut to the current session row
  • Exports: save visible rows to text, colored PDF, or XLSX
  • Statistics: inspect session totals and station contribution plots
  • Inline help: ? shows a centered help box

See also:


Project layout

ivs_sessions_browser/
โ”œโ”€ docs/
โ”‚  โ”œโ”€ ARCHITECTURE.md
โ”‚  โ”œโ”€ FILTER_SYNTAX.md
โ”‚  โ”œโ”€ KEY_BINDINGS.md
โ”‚  โ”œโ”€ ROADMAP.md
โ”‚  โ””โ”€ USER_GUIDE.md
โ”œโ”€ scripts/
โ”‚  โ””โ”€ run_sessions_browser.py	# launcher (imports package main)
โ”œโ”€ src/
โ”‚  โ””โ”€ ivs_sessions_browser/
โ”‚     โ”œโ”€ __init__.py			# CLI entry point (main())
โ”‚     โ”œโ”€ __main__.py			# allows `python -m ivs_sessions_browser`
โ”‚     โ”œโ”€ operators.json		# packaged default operator bindings
โ”‚     โ”œโ”€ defs.py				# constants, headers, argument help text
โ”‚     โ”œโ”€ fetch_sessions.py		# network fetch + response handling
โ”‚     โ”œโ”€ filter_and_sort.py		# filtering and sorting logic
โ”‚     โ”œโ”€ ivstypes.py			# type definitions and data classes
โ”‚     โ”œโ”€ operators.py			# operator management and persistence
โ”‚     โ”œโ”€ sessions_browser.py	# main TUI loop and orchestration
โ”‚     โ”œโ”€ tui.py					# TUI rendering (headers, rows, help)
โ”‚     โ”œโ”€ tui_state.py			# UI state dataclass and theme
โ”‚     โ””โ”€ version.py				# version info (generated by setuptools-scm)
โ”œโ”€ operators.json				# source copy of default operator bindings
โ”œโ”€ operator_assignments.json	# local assignment file, ignored by git
โ”œโ”€ pyproject.toml
โ”œโ”€ requirements.txt				# python requirements for the project
โ”œโ”€ run_browser					# bash wrapper script
โ”œโ”€ LICENSE
โ””โ”€ README.md

Note: The project uses the src/ layout. For development, install it with pip install -e .. Inside PyCharm, mark src/ as Sources Root or use the editable virtualenv interpreter. User-editable settings are read from ~/.config/ivs-sessions-browser/. Missing operators.json, pdf_columns, and startup_defaults.json files are created there from defaults the first time ivs-sessions-browser runs. Edit ~/.config/ivs-sessions-browser/operators.json to replace the default U1-U5 operator labels with your local operator names. Edit ~/.config/ivs-sessions-browser/startup_defaults.json to choose default startup year, scope, filters, and mirrors values. The app also records the last displayed "what's new" version in ~/.config/ivs-sessions-browser/app_state.json.


Requirements

  • Python 3.10+
  • Linux/macOS terminal with curses support Windows users: pip install windows-curses
  • Internet access to fetch schedules from ivscc.gsfc.nasa.gov, or any of the mirror sites

Installation

From PyPI

For normal use as a command-line app, pipx is recommended:

pipx install ivs-sessions-browser
ivs-sessions-browser --init-config
ivs-sessions-browser

On Linux distributions with externally managed Python environments, avoid installing into system Python with pip --break-system-packages.

From source

git clone git@github.com:jonleithe/ivs_sessions_browser.git
cd ivs_sessions_browser

python3 -m venv .venv
source .venv/bin/activate            # Windows PowerShell: .\.venv\Scripts\Activate.ps1

pip install -r requirements.txt

Editable development install

pip install -e .

You can now run:

ivs-sessions-browser

On Windows, use .\.venv\Scripts\ivs-sessions-browser.exe.

To create the editable default config files without starting the TUI:

ivs-sessions-browser --init-config

To read the bundled manual page:

ivs-sessions-browser --man

How to run (terminal)

You have multiple equivalent ways. Pick your favorite:

A) Console script (recommended after install)

ivs-sessions-browser

B) Wrapper script

run_browser is included in the project root:

./run_browser

C) Run the package as a module

python -m ivs_sessions_browser

Usage

Most usage is interactive (TUI). Command-line flags typically include:

--year 2025                    # single year
--year "2021,2025"             # explicit multi-year list
--year "2022-2025"             # inclusive year range
--scope master|intensive|both  # select scope
--filters "code:R1|R4"         # initial filter expression
--output -                     # write text output to stdout and exit
--pretty-print OP|TYPE|STATIONS
--format pdf                  # write a colored PDF using the same pretty-printed lines
--format xlsx                 # write an Excel workbook with spreadsheet cells
--no-mirrors                  # disable startup default mirror checking for this run
--verbose-fetch                # show fetch/progress output even with --output
--init-config                  # create default user config files and exit. Usually done after install.
--man                          # show the bundled manual page and exit

Run with -h/--help (help) to see current options.

When --year, --scope, --filters, or --mirrors are omitted, the app checks ~/.config/ivs-sessions-browser/startup_defaults.json before falling back to built-in defaults. Command-line arguments always override the file.

{
  "filters": "status:released; stations:Nn",
  "mirrors": false,
  "scope": "both",
  "year": null
}

Once inside the TUI:

  • Use arrow keys / PgUp / PgDn / Home / End to navigate
  • Press T to jump to today
  • Press / to enter/edit a filter
  • Press C to clear filters
  • Press D to save the current filter as the startup default
  • Press 0-5 to assign an operator to the selected session (or clear with '0')
  • Press Enter to open the selected session in your browser
  • Press P to export visible rows to PDF
  • Press X to export visible rows to XLSX
  • Press S to show session statistics
  • Press G to save/open a station contribution plot; repeated presses cycle session %, hours, and weighted hours
  • Press ? for inline help
  • Press q/Q to quit

Inline help (?)

Navigation:
  โ†‘ โ†“ PgUp PgDn Home End   Move around the session list
  T                        Jump to todayโ€™s session
  Enter                    Open session page in web browser
  q or Q                   Quit

Filtering:
  /                        Enter a filter expression
  C                        Clear current filters
  D                        Save current filter as startup default
  Examples:
    code:R1|R4             โ†’ match sessions with code R1 or R4
    stations:Nn&Ns         โ†’ sessions including both Nn and Ns
    stations_removed:Ft|Ur โ†’ removed stations include Ft or Ur

Operator Assignment:
  0-5                      Assign operator to selected session
                          (operators configured in ~/.config/ivs-sessions-browser/operators.json)

Other:
  P                        Export visible rows to PDF and open it
  X                        Export visible rows to XLSX and open it
  S                        Show session statistics
  G                        Save/open station contribution plot
  ?                        Show this help screen

Notes:
- Station names are **case-sensitive**
- Other fields are **case-insensitive**
- Clauses separated by `;` are AND
- Tokens separated by space, `,`, `+`, or `|` are OR

Full details:

Export formats

  • --format text writes the ANSI-colored textual listing.
  • --format pdf writes a monospaced PDF that preserves the existing header and row colors from the textual export.
  • --format xlsx writes spreadsheet cells with headers, filters, frozen first row, code hyperlinks, and operator row colors.
  • --append only applies to text output; PDF and XLSX export always write a new file.

Example:

./run_browser --year 2025 --output sessions.pdf --format pdf
./run_browser --year 2025 --output sessions.xlsx --format xlsx

Filter basics (quick primer)

  • Clauses separated by ; are AND.
  • Stations fields are case-sensitive.
  • Other fields are case-insensitive.
  • Within a non-station field, tokens split by space/comma/+/| are OR.

Examples:

  • code:R1|R4 โ†’ codes matching R1 or R4
  • stations:Nn&Ns โ†’ requires both Nn and Ns present (active stations)
  • stations_removed:Ag|Kk โ†’ removed stations include Ag or Kk
  • stations_active:Ft|Ur โ†’ active stations include Ft or Ur
  • stations_all:Ke|Oe โ†’ any stations (active or removed) include Ke or Oe
  • Combine filters: code:R1|R4; stations:Nn&Ns; status:released

Troubleshooting

ModuleNotFoundError: No module named 'ivs_sessions_browser' Use one of:

  • pip install -e ., then ivs-sessions-browser
  • ./run_browser wrapper
  • In PyCharm, use the project virtualenv or mark src/ as Sources Root

Windows: curses import error Install: pip install windows-curses.

No colors / weird characters Use a modern terminal with UTF-8 and 256-color support; ensure $TERM is e.g. xterm-256color.


Versioning

This project uses setuptools-scm. Version strings are derived from Git tags. To cut a release:

git tag v4.0.0
git push --tags

Contributing

  • Keep the TUI responsive; avoid blocking network calls on the UI thread.
  • Prefer small, focused modules under src/ivs_sessions_browser/.
  • Write clear commit messages; tag releases for versioning.

License

MIT โ€” see LICENSE.


Acknowledgments

  • IVS Central Bureau & Goddard Space Flight Center for session listings
  • Contributors and testers across Ny-ร…lesund & Brandal observatories

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

ivs_sessions_browser-4.0.10.tar.gz (81.5 kB view details)

Uploaded Source

Built Distribution

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

ivs_sessions_browser-4.0.10-py3-none-any.whl (66.0 kB view details)

Uploaded Python 3

File details

Details for the file ivs_sessions_browser-4.0.10.tar.gz.

File metadata

  • Download URL: ivs_sessions_browser-4.0.10.tar.gz
  • Upload date:
  • Size: 81.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for ivs_sessions_browser-4.0.10.tar.gz
Algorithm Hash digest
SHA256 62d58abb01e24562086ee81efd8e30f4b848e555e0bee87726e71393a0c6b187
MD5 91f80f6f89c908eb810f634d769ae4b4
BLAKE2b-256 2706977ecd386a28a895008800e9d6739ff472784851b9844c1ed076a4004b43

See more details on using hashes here.

Provenance

The following attestation bundles were made for ivs_sessions_browser-4.0.10.tar.gz:

Publisher: publish.yml on jonleithe/ivs_sessions_browser

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file ivs_sessions_browser-4.0.10-py3-none-any.whl.

File metadata

File hashes

Hashes for ivs_sessions_browser-4.0.10-py3-none-any.whl
Algorithm Hash digest
SHA256 03155d5848cd71427e8bb6c248b7b311ced90eef10f75d303ccf4e49a59e721b
MD5 90ba22bd83d430cc74f30556585351eb
BLAKE2b-256 7e570d0e68fcb7017bbb6e9d37fde74569a61991764ed9ef67cb0d366141375d

See more details on using hashes here.

Provenance

The following attestation bundles were made for ivs_sessions_browser-4.0.10-py3-none-any.whl:

Publisher: publish.yml on jonleithe/ivs_sessions_browser

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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