Metadata-Version: 2.4
Name: celar
Version: 0.1.9
Summary: Simple CLI Social Media App
Author-email: simon0302010 <simon0302010@gmail.com>
License-Expression: GPL-3.0-only
Project-URL: Homepage, https://github.com/simon0302010/celar
Classifier: Operating System :: POSIX :: Linux
Classifier: Operating System :: Microsoft :: Windows
Requires-Python: <4.0,>=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: requests
Requires-Dist: questionary
Requires-Dist: textual
Requires-Dist: textual-image
Requires-Dist: textual-fspicker
Requires-Dist: Pillow
Dynamic: license-file

# Celar Client

Terminal user interface (TUI) client for Celar, built with [Textual](https://textual.textualize.io/).

## Requirements

- Python 3.9+
- Terminal with image support (recommended: iTerm2, Kitty, or modern terminals)
- Internet connection when connecting to a remote server

## Installation

### Install from PyPI
```bash
pip install celar
```

## Usage

### Starting the Application

After installation, run:
```bash
celar
```

You can also run:
```bash
python -m celar
```

### API Url

On launch, you'll be prompted to set the server URL
- Default: `http://127.0.0.1:8000`
- You can set this to `https://celar.simon.hackclub.app` if you don't want to set up your own server (registration disabled).
- Change this to match your Celar server location

### Navigation

- **Arrow Keys**: Navigate between UI elements
- **Tab/Shift+Tab**: Move between focusable elements
- **Enter/Space**: Activate buttons
- **Escape**: Go back or exit
- **D**: Toggle between dark and light themes
- **Q**: Quit the application

### Features

- View posts from all users
- Give coins to posts by clicking the coin button
- See how many coins your posts have received
- See how many coins other posts have received
- Create posts

## License

This project is licensed under the GPL-3.0 License - see the [LICENSE](LICENSE) file for details.
