Zulip Terminal uses Zulip's API to store and retrieve all the information it displays. It has an MVC structure overall. Here is a description of some of its files:
| Folder | File | Description |
|---|---|---|
| zulipterminal | api_types.py | Types from the Zulip API, translated into python, to improve type checking |
| core.py | Defines the Controller, which sets up the Model, View, and how they interact |
|
| helper.py | Helper functions used in multiple places | |
| model.py | Defines the Model, fetching and storing data retrieved from the Zulip server |
|
| platform_code.py | Detection of supported platforms & platform-specific functions | |
| server_url.py | Constructs and encodes server_url of messages. | |
| ui.py | Defines the View, and controls where each component is displayed |
|
| unicode_emojis.py | Unicode emoji data, synchronized semi-regularly with the server source | |
| urwid_types.py | Types from the urwid API, to improve type checking | |
| version.py | Keeps track of the version of the current code | |
| widget.py | Process widgets (submessages) like polls, todo lists, etc. | |
| zulipterminal/cli | run.py | Marks the entry point into the application |
| zulipterminal/config | color.py | Color definitions or functions common across all themes |
| keys.py | Keybindings and their helper functions | |
| markdown_examples.py | Examples of input markdown and corresponding html output (rendered in markdown help) | |
| regexes.py | Regular expression constants | |
| symbols.py | Terminal characters used to mark particular elements of the user interface | |
| themes.py | Styles and their colour mappings in each theme, with helper functions | |
| ui_mappings.py | Relationships between state/API data and presentation in the UI | |
| ui_sizes.py | Fixed sizes of UI elements | |
| zulipterminal/ui_tools | boxes.py | UI boxes for entering text: WriteBox, MessageSearchBox, PanelSearchBox |
| buttons.py | UI buttons for narrowing & showing unread counts, eg. All, Stream, Direct, Topic | |
| messages.py | UI to render a Zulip message for display, and respond contextually to actions | |
| tables.py | Helper functions which render tables in the UI | |
| utils.py | The MessageBox for every message displayed is created here |
|
| views.py | UI views for larger elements such as Streams, Messages, Topics, Help, etc | |
| zulipterminal/scripts | Scripts bundled with the application | |
| zulipterminal/themes | Themes bundled with the application |