creddit 0.0.1__tar.gz → 0.0.3__tar.gz

{creddit-0.0.1 → creddit-0.0.3}/LICENSE

@@ -1,9 +1,9 @@
-MIT License
-
-Copyright (c) 2024 Vishal N
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice (including the next paragraph) shall be included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+MIT License
+
+Copyright (c) 2025 Vishal N
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice (including the next paragraph) shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

{creddit-0.0.1 → creddit-0.0.3}/PKG-INFO

@@ -1,57 +1,51 @@
-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)
+Metadata-Version: 2.4
+Name: creddit
+Version: 0.0.3
+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?
+
+Install the [package](https://pypi.org/project/creddit/) from PyPi.
+
+```sh
+pip install creddit
+```
+
+To run it,
+
+```sh
+python -m creddit
+```
+
+### Features to add
+
+-   More guidance on MPV, and alternatives if it isn't installed
+
+(Copyright (c) 2025 Vishal N)

{creddit-0.0.1 → creddit-0.0.3}/README.md

@@ -1,43 +1,37 @@
-# 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)
+# 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?
+
+Install the [package](https://pypi.org/project/creddit/) from PyPi.
+
+```sh
+pip install creddit
+```
+
+To run it,
+
+```sh
+python -m creddit
+```
+
+### Features to add
+
+-   More guidance on MPV, and alternatives if it isn't installed
+
+(Copyright (c) 2025 Vishal N)

{creddit-0.0.1 → creddit-0.0.3}/pyproject.toml

@@ -1,32 +1,33 @@
-[project]
-name = "creddit"
-version = "0.0.1"
-description = "An unofficial cli client for Reddit, aimed at people who regularly browse specific subreddits or topics instead of reading the homepage (r/all)."
-authors = [
-    {name = "Vishal Nandagopal", email="dev@vishalnandagopal.com"}
-]
-license = "MIT"
-readme = "README.md"
-requires-python = ">=3.13"
-dependencies = [
-    "colorama>=0.4.6",
-    "python-dotenv>=1.1.0",
-    "requests>=2.32.3",
-]
-
-[dependency-groups]
-dev = [
-    "mypy>=1.15.0",
-    "ruff>=0.11.9",
-    "ty>=0.0.0a8",
-    "types-colorama>=0.4.15.20240311",
-    "types-requests>=2.32.0.20250328",
-]
-
-
-[tool.uv]
-required-environments = [
-    "sys_platform == 'darwin'",
-    "sys_platform == 'linux'",
-    "sys_platform == 'windows'"
-]
+[project]
+name = "creddit"
+version = "0.0.3"
+description = "An unofficial cli client for Reddit, aimed at people who regularly browse specific subreddits or topics instead of reading the homepage (r/all)."
+authors = [
+    {name = "Vishal Nandagopal", email="dev@vishalnandagopal.com"}
+]
+license = "MIT"
+readme = "README.md"
+requires-python = ">=3.13"
+dependencies = [
+    "colorama>=0.4.6",
+    "python-dotenv>=1.1.0",
+    "requests>=2.32.3",
+]
+
+[dependency-groups]
+dev = [
+    "mypy>=1.15.0",
+    "ruff>=0.11.9",
+    "ty>=0.0.0a8",
+    "types-colorama>=0.4.15.20240311",
+    "types-requests>=2.32.0.20250328",
+]
+
+
+[tool.uv]
+required-environments = [
+    "sys_platform == 'darwin'",
+    "sys_platform == 'linux'",
+    "sys_platform == 'windows'"
+]
+required-version = ">=0.7"

{creddit-0.0.1 → creddit-0.0.3}/setup.cfg

@@ -1,4 +1,4 @@
-[egg_info]
-tag_build = 
-tag_date = 0
-
+[egg_info]
+tag_build = 
+tag_date = 0
+

{creddit-0.0.1 → creddit-0.0.3}/src/creddit/__init__.py

@@ -1,5 +1,5 @@
-"""
-creddit - A CLI client for Reddit
-"""
-
-from .terminal import run as run
+"""
+creddit - A CLI client for Reddit
+"""
+
+from .terminal import run as run

{creddit-0.0.1 → creddit-0.0.3}/src/creddit/__main__.py

@@ -1,4 +1,4 @@
-from creddit.terminal import run
-
-if __name__ == "__main__":
-    run()
+from creddit.terminal import run
+
+if __name__ == "__main__":
+    run()

{creddit-0.0.1 → creddit-0.0.3}/src/creddit/config.py

@@ -1,113 +1,113 @@
-"""
-A file that stores all the variables that much be read from the env file. Helps me keep track of them at one place, instead of reading and using them where they are needed. This application relies on env for config.
-
-Config is store in a JSON file. TOML, YAML, and ini were options but
-
-TOML - built in library can't write. Don't want to package another module.
-YAML - Built in and ugly
-.ini - Ugly
-
-"""
-
-from json import JSONDecodeError
-from json import dump as json_dump
-from json import load as json_load
-from os import getenv
-from pathlib import Path
-from sys import platform
-from typing import Literal, NotRequired, TypedDict
-
-
-class Config(TypedDict):
-    ignored_users: list[str]
-    no_of_posts_to_print: int
-    ignore_all_mod_posts: bool
-    default_subreddit: NotRequired[str]
-
-
-default_config: Config = {
-    "ignored_users": ["2soccer2bot", "AutoModerator"],
-    "no_of_posts_to_print": 10,
-    "ignore_all_mod_posts": True,
-}
-
-config_folder: Path
-
-if platform == "win32":
-    config_folder = Path(getenv("LOCALAPPDATA", "./config/"))
-elif platform == "darwin":
-    config_folder = Path("~/Library/Application Support/")
-elif platform == "linux":
-    config_folder = Path("~/.config/")
-else:
-    config_folder = Path("./config/")
-
-config_folder = config_folder / "creddit"
-config_folder.mkdir(parents=True, exist_ok=True)
-
-# It's actually a cursed thing that you can divide paths.
-config_path: Path = config_folder / "config.json"
-"""The path of the config"""
-
-
-def check_config_existence() -> bool:
-    """Checks if a config file exists, and that it valid
-
-    Returns:
-        bool: True if file exists and contains all required keys
-    """
-    if not Path(config_path).exists():
-        return False
-
-    with open(config_path, "r") as f:
-        try:
-            config = json_load(f)
-        except JSONDecodeError:
-            return False
-        if not (config or (default_config.keys() < config.keys())):
-            return False
-
-    return True
-
-
-def read_config(config_path: Path = config_path) -> Config:
-    """Read the config file"""
-
-    with open(config_path, "r") as f:
-        config: Config = json_load(f)
-
-    required_keys = default_config.keys()
-
-    if required_keys <= config.keys():
-        # Looks like all keys are present
-        return config
-
-    raise RuntimeError("Looks like some values in the config file are missing")
-
-
-def create_config(c: dict | Config = default_config) -> bool:
-    required_keys = default_config.keys()
-
-    if required_keys <= c.keys():
-        # All the must have keys are present
-        with open(config_path, "w+") as f:
-            json_dump(c, f, indent=4, sort_keys=True)
-            return True
-
-    return False
-
-
-def edit_config(new_config: dict) -> bool:
-    c = read_config()
-    key: Literal[
-        "ignored_users",
-        "no_of_posts_to_print",
-        "ignore_all_mod_posts",
-        "default_subreddit",
-    ]
-    for key in new_config:
-        c[key] = new_config[key]
-    with open(config_path, "w") as f:
-        json_dump(c, f, indent=4, sort_keys=True)
-        return True
-    return False
+"""
+A file that stores all the variables that much be read from the env file. Helps me keep track of them at one place, instead of reading and using them where they are needed. This application relies on env for config.
+
+Config is store in a JSON file. TOML, YAML, and ini were options but
+
+TOML - built in library can't write. Don't want to package another module.
+YAML - Built in and ugly
+.ini - Ugly
+
+"""
+
+from json import JSONDecodeError
+from json import dump as json_dump
+from json import load as json_load
+from os import getenv
+from pathlib import Path
+from sys import platform
+from typing import Literal, NotRequired, TypedDict
+
+
+class Config(TypedDict):
+    ignored_users: list[str]
+    no_of_posts_to_print: int
+    ignore_all_mod_posts: bool
+    default_subreddit: NotRequired[str]
+
+
+default_config: Config = {
+    "ignored_users": ["2soccer2bot", "AutoModerator"],
+    "no_of_posts_to_print": 10,
+    "ignore_all_mod_posts": True,
+}
+
+config_folder: Path
+
+if platform == "win32":
+    config_folder = Path(getenv("LOCALAPPDATA", "./config/"))
+elif platform == "darwin":
+    config_folder = Path("~/Library/Application Support/")
+elif platform == "linux":
+    config_folder = Path("~/.config/")
+else:
+    config_folder = Path("./config/")
+
+config_folder = config_folder / "creddit"
+config_folder.mkdir(parents=True, exist_ok=True)
+
+# It's actually a cursed thing that you can divide paths.
+config_path: Path = config_folder / "config.json"
+"""The path of the config"""
+
+
+def check_config_existence() -> bool:
+    """Checks if a config file exists, and that it valid
+
+    Returns:
+        bool: True if file exists and contains all required keys
+    """
+    if not Path(config_path).exists():
+        return False
+
+    with open(config_path, "r") as f:
+        try:
+            config = json_load(f)
+        except JSONDecodeError:
+            return False
+        if not (config or (default_config.keys() < config.keys())):
+            return False
+
+    return True
+
+
+def read_config(config_path: Path = config_path) -> Config:
+    """Read the config file"""
+
+    with open(config_path, "r") as f:
+        config: Config = json_load(f)
+
+    required_keys = default_config.keys()
+
+    if required_keys <= config.keys():
+        # Looks like all keys are present
+        return config
+
+    raise RuntimeError("Looks like some values in the config file are missing")
+
+
+def create_config(c: dict | Config = default_config) -> bool:
+    required_keys = default_config.keys()
+
+    if required_keys <= c.keys():
+        # All the must have keys are present
+        with open(config_path, "w+") as f:
+            json_dump(c, f, indent=4, sort_keys=True)
+            return True
+
+    return False
+
+
+def edit_config(new_config: dict) -> bool:
+    c = read_config()
+    key: Literal[
+        "ignored_users",
+        "no_of_posts_to_print",
+        "ignore_all_mod_posts",
+        "default_subreddit",
+    ]
+    for key in new_config:
+        c[key] = new_config[key]
+    with open(config_path, "w") as f:
+        json_dump(c, f, indent=4, sort_keys=True)
+        return True
+    return False