Metadata-Version: 2.4
Name: creddit
Version: 0.0.1
Summary: An unofficial cli client for Reddit, aimed at people who regularly browse specific subreddits or topics instead of reading the homepage (r/all).
Author-email: Vishal Nandagopal <dev@vishalnandagopal.com>
License-Expression: MIT
Requires-Python: >=3.13
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: colorama>=0.4.6
Requires-Dist: python-dotenv>=1.1.0
Requires-Dist: requests>=2.32.3
Dynamic: license-file

# creddit - A CLI client for Reddit

An unofficial cli client for Reddit, aimed at people who regularly browse specific subreddits or topics instead of reading the homepage (r/all).

### Features:

-   Distraction free. Can browse a few posts and continue with your day. No flashy gifs, awards, ads or posts.

-   Browse a subreddit by entering just the name.

-   Prints a link to the article mentioned in every post, for you to continue reading it in your browser (`ctrl+click`), in case you are interested.

-   Can browse top comments for every post just by entering the number shown beside the post in the terminal.

Feel free to send a PR with any additional features, or make an issue if you have any feature requests!

This source code is licensed under the MIT license found in the LICENSE file in the root directory of this source tree.

### How to use?

Clone the repo and install the thing as a package

```sh
git clone --depth 1 https://github.com/vishalnandagopal/creddit/ creddit
cd creddit
pip install uv
uv sync
uv build
pip install ./dist/creddit-1.0.0-py3-none-any.whl
```

And to finally run it,

```sh
python -m creddit
```

### Features to add

-   Publish to pip
-   More guidance on MPV, and alternatives if it isn't installed

(Copyright (c) 2024 Vishal N)
