Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -104,4 +104,11 @@ venv.bak/
.mypy_cache/

# VSCode stuff
.vscode
.vscode

# Sclack user config and logs (contains tokens - never commit!)
.sclack
.sclack_logs/
*.log
~/.sclack
~/.sclack_logs/
70 changes: 70 additions & 0 deletions INSTALL.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
# Installing sclack System-Wide

## Option 1: Using pipx (Recommended for Arch Linux / PEP 668)
`pipx` is perfect for CLI applications and manages its own virtual environment:

```bash
# Install pipx if you don't have it (Arch Linux)
sudo pacman -S python-pipx

# Install sclack using pipx
cd /home/deadc0de/hacking/sclack
pipx install -e .

# Or install normally (not editable)
pipx install .
```

After installation, `sclack` will be available globally:
```bash
which sclack
sclack # Run it!
```

To update:
```bash
pipx upgrade sclack
```

To uninstall:
```bash
pipx uninstall sclack
```

## Option 2: User Installation (Other Linux distros)
For distros without PEP 668 protection:

```bash
# Make sure you're NOT in the venv
deactivate # if you're in a venv

# Install in user directory
pip3 install --user -e .

# Make sure ~/.local/bin is in your PATH
export PATH="$HOME/.local/bin:$PATH"
# Add to ~/.zshrc or ~/.bashrc to make it permanent
```

## Option 3: System-Wide Installation (Not recommended on Arch)
```bash
# Make sure you're NOT in the venv
deactivate # if you're in a venv

# Install system-wide (requires --break-system-packages on Arch)
sudo pip3 install --break-system-packages -e .
```

## Verify Installation
After installation, verify it works:
```bash
which sclack
sclack # Run it!
```

## Development Mode
If you want to keep developing and have changes reflect immediately, use `-e` (editable) flag:
```bash
pipx install -e . # Changes to code will be reflected immediately
```

2 changes: 1 addition & 1 deletion Pipfile
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ name = "pypi"

[packages]
asyncio = "*"
urwid = "==2.0.1"
urwid = ">=3.0.3"
pyperclip = "==1.6.2"
requests = "*"
slackclient = "==1.2.1"
Expand Down
2 changes: 1 addition & 1 deletion requirements.txt
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
asyncio
urwid==2.0.1
urwid>=3.0.3
pyperclip==1.6.2
requests
slackclient==1.2.1
Expand Down
Loading