nexus-tui 0.1.0__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
nexus/tools.toml
ADDED
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# Default Configuration
|
|
2
|
+
# You can override this by creating a `tools.local.toml` in this directory
|
|
3
|
+
# or `~/.config/nexus/tools.toml` (Linux), `~/Library/Application Support/Nexus/tools.toml` (Mac),
|
|
4
|
+
# or `%LOCALAPPDATA%\Nexus\tools.toml` (Windows).
|
|
5
|
+
|
|
6
|
+
# To set your project root (where Nexus looks for projects):
|
|
7
|
+
# project_root = "~/Projects" # Tilde is expanded to User Home
|
|
8
|
+
|
|
9
|
+
[[tool]]
|
|
10
|
+
label = "Neovim"
|
|
11
|
+
category = "DEV"
|
|
12
|
+
description = "Hyperextensible text editor"
|
|
13
|
+
command = "nvim"
|
|
14
|
+
requires_project = true
|
|
15
|
+
|
|
16
|
+
[[tool]]
|
|
17
|
+
label = "Lazygit"
|
|
18
|
+
category = "DEV"
|
|
19
|
+
description = "Git TUI interface"
|
|
20
|
+
command = "lazygit"
|
|
21
|
+
requires_project = true
|
|
22
|
+
|
|
23
|
+
[[tool]]
|
|
24
|
+
label = "Htop"
|
|
25
|
+
category = "UTIL"
|
|
26
|
+
description = "Process viewer"
|
|
27
|
+
command = "htop"
|
|
28
|
+
requires_project = false
|
|
@@ -0,0 +1,145 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: nexus-tui
|
|
3
|
+
Version: 0.1.0
|
|
4
|
+
Summary: A modular TUI for managing development workflows
|
|
5
|
+
License-File: LICENSE
|
|
6
|
+
Requires-Python: >=3.12
|
|
7
|
+
Requires-Dist: pydantic>=2.12.5
|
|
8
|
+
Requires-Dist: textual>=0.86.0
|
|
9
|
+
Description-Content-Type: text/markdown
|
|
10
|
+
|
|
11
|
+
# Nexus
|
|
12
|
+
|
|
13
|
+
Nexus is a terminal interface designed for creating efficient development workflows. It serves as a centralized dashboard for launching command line utilities and managing projects across various operating systems.
|
|
14
|
+
|
|
15
|
+
## Prerequisites
|
|
16
|
+
|
|
17
|
+
* Python 3.12 or newer.
|
|
18
|
+
* The `uv` package manager.
|
|
19
|
+
* A modern terminal emulator such as Windows Terminal, ghostty, or iTerm2.
|
|
20
|
+
|
|
21
|
+
## Installation
|
|
22
|
+
|
|
23
|
+
Install Nexus globally using the `uv` tool manager:
|
|
24
|
+
|
|
25
|
+
```bash
|
|
26
|
+
# Always latest stable
|
|
27
|
+
uv tool install nexus-tui
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
### Upgrade
|
|
31
|
+
|
|
32
|
+
To update to the latest version:
|
|
33
|
+
```bash
|
|
34
|
+
uv tool upgrade nexus-tui
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
### Local Development
|
|
38
|
+
|
|
39
|
+
```bash
|
|
40
|
+
git clone https://github.com/jdluu/Nexus
|
|
41
|
+
cd Nexus
|
|
42
|
+
uv tool install --editable .
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
## Cross Platform Support
|
|
46
|
+
|
|
47
|
+
Nexus supports Linux, MacOS, and Windows.
|
|
48
|
+
|
|
49
|
+
* **Linux**: Fully supported on standard terminals.
|
|
50
|
+
* **MacOS**: Fully supported.
|
|
51
|
+
* **Windows**: Recommended to use PowerShell 7 or Git Bash within Windows Terminal.
|
|
52
|
+
|
|
53
|
+
## Configuration
|
|
54
|
+
|
|
55
|
+
Nexus utilizes the standard configuration paths for your operating system.
|
|
56
|
+
|
|
57
|
+
* **Linux**: `~/.config/nexus/tools.toml`
|
|
58
|
+
* **MacOS**: `~/Library/Application Support/Nexus/tools.toml`
|
|
59
|
+
* **Windows**: `%LOCALAPPDATA%\Nexus\tools.toml`
|
|
60
|
+
|
|
61
|
+
### Project Directory
|
|
62
|
+
|
|
63
|
+
To define the workspace where Nexus looks for projects, add the `project_root` key to your configuration file.
|
|
64
|
+
|
|
65
|
+
```toml
|
|
66
|
+
# Example configuration
|
|
67
|
+
project_root = "~/Development"
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
### Tool Definitions
|
|
71
|
+
|
|
72
|
+
Tools are defined in the configuration file using the `[[tool]]` table.
|
|
73
|
+
|
|
74
|
+
```toml
|
|
75
|
+
[[tool]]
|
|
76
|
+
label = "Neovim"
|
|
77
|
+
category = "DEV"
|
|
78
|
+
description = "Text editor"
|
|
79
|
+
command = "nvim"
|
|
80
|
+
requires_project = true
|
|
81
|
+
```
|
|
82
|
+
|
|
83
|
+
* **label**: The display name.
|
|
84
|
+
* **category**: The grouping identifier (for example DEV, UTIL).
|
|
85
|
+
* **description**: A short explanation of the function.
|
|
86
|
+
* **command**: The executable command line instruction.
|
|
87
|
+
* **requires_project**: Indicates if the tool needs a working directory.
|
|
88
|
+
|
|
89
|
+
### Keybindings
|
|
90
|
+
|
|
91
|
+
Custom keybindings can be defined in the `[keybindings]` section.
|
|
92
|
+
|
|
93
|
+
```toml
|
|
94
|
+
[keybindings]
|
|
95
|
+
quit = "alt+q"
|
|
96
|
+
toggle_favorite = "ctrl+f"
|
|
97
|
+
```
|
|
98
|
+
|
|
99
|
+
## Usage
|
|
100
|
+
|
|
101
|
+
Launch the application using the following command:
|
|
102
|
+
|
|
103
|
+
```bash
|
|
104
|
+
nexus
|
|
105
|
+
```
|
|
106
|
+
|
|
107
|
+
### Features
|
|
108
|
+
|
|
109
|
+
* **Smart Search**: Filter projects using fuzzy matching logic.
|
|
110
|
+
* **Persistence**: Automatically tracks recent projects and favorites.
|
|
111
|
+
* **Favorites**: Pin frequently used tools for quick access.
|
|
112
|
+
|
|
113
|
+
### Controls
|
|
114
|
+
|
|
115
|
+
* **Arrow Keys**: Navigate through lists.
|
|
116
|
+
* **Enter**: Confirm selection or launch tool.
|
|
117
|
+
* **F**: Toggle the favorite status of a tool.
|
|
118
|
+
* **Type**: Instantly filter lists by text.
|
|
119
|
+
* **Esc**: Return to the previous screen.
|
|
120
|
+
* **Q**: Exit the application.
|
|
121
|
+
|
|
122
|
+
## Development
|
|
123
|
+
|
|
124
|
+
To configure the development environment:
|
|
125
|
+
|
|
126
|
+
1. Synchronize dependencies:
|
|
127
|
+
```bash
|
|
128
|
+
uv sync
|
|
129
|
+
```
|
|
130
|
+
|
|
131
|
+
2. Run the application locally:
|
|
132
|
+
```bash
|
|
133
|
+
uv run nexus
|
|
134
|
+
```
|
|
135
|
+
|
|
136
|
+
3. Execute the comprehensive test suite:
|
|
137
|
+
```bash
|
|
138
|
+
uv run pytest --cov=nexus
|
|
139
|
+
```
|
|
140
|
+
|
|
141
|
+
4. Perform static analysis and type checking:
|
|
142
|
+
```bash
|
|
143
|
+
uv run ruff check .
|
|
144
|
+
uv run mypy .
|
|
145
|
+
```
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
nexus/tools.toml,sha256=uYfBA7WMLAu6fPDRzB4p5ggk0aVTUpDPrxRrzLnGiMA,740
|
|
2
|
+
nexus_tui-0.1.0.dist-info/METADATA,sha256=QueZS1eGFxb7ZOfS-RqcXWSFfTdyAKlFqGU2faQMhDE,3309
|
|
3
|
+
nexus_tui-0.1.0.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
|
|
4
|
+
nexus_tui-0.1.0.dist-info/entry_points.txt,sha256=FLWKPqsNYxxaU0JyVfJoKJDTrFtx-LJVPejbvUdnc6o,41
|
|
5
|
+
nexus_tui-0.1.0.dist-info/licenses/LICENSE,sha256=gtmNw2nOOujPlKSYxW0EQC-cg2aSe--mVlMxElz5AmI,1062
|
|
6
|
+
nexus_tui-0.1.0.dist-info/RECORD,,
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 jdluu
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|