Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Textual TUI prototype #508

Merged
merged 10 commits into from
Jan 6, 2025
Merged

Textual TUI prototype #508

merged 10 commits into from
Jan 6, 2025

Conversation

eelcovdw
Copy link
Contributor

@eelcovdw eelcovdw commented Dec 16, 2024

Description

A simple TUI using Textual

image

To try it out:

python syftbox/main.py tui --config <my_config>

changes

  • Add log endpoints and pagination to local client
  • Add TUI + CLI
  • colorize client logfile
    • downside here is that we get color markup in the logs file, making it harder to read without ANSI viewer.

TODO

  • refresh home tab every N seconds (sync status, # apps)
  • open file browser/editor on file select in datasite/sync tab
  • home tab + logs styling (truncate text if too long)
  • [TBD] Option to launch TUI with Client CLI syftbox client --tui
  • SDK client for local syftbox endpoints
  • tests

Affected Dependencies

List any dependencies that are required for this change.

How has this been tested?

  • Describe the tests that you ran to verify your changes.
  • Provide instructions so we can reproduce.
  • List any relevant details for your test configuration.

Checklist

@eelcovdw eelcovdw changed the title [WIP] Textual TUI prototype Textual TUI prototype Jan 6, 2025
Copy link
Contributor

@abyesilyurt abyesilyurt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks very polished already and the code is easy to follow. Nice work!

syftbox/tui/app.py Show resolved Hide resolved
syftbox/tui/widgets/sync_widget.py Outdated Show resolved Hide resolved
@eelcovdw eelcovdw merged commit b6f932e into main Jan 6, 2025
14 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants