readx 0.1.0__tar.gz

readx-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Beks1k
+
+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 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.

readx-0.1.0/PKG-INFO

@@ -0,0 +1,64 @@
+Metadata-Version: 2.4
+Name: readx
+Version: 0.1.0
+Summary: Lib for easy use of discord webhook
+Author: Beks1k
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# readx
+
+A micro-library for safe file reading and size inspection. Protects your terminal and memory from crashing when accidentally reading huge or binary files.
+
+## Features
+
+- **Safe Reading**: Automatically stops and raises an error if the file is binary or too large.
+- **Smart Size**: Converts bytes to KB, MB, or GB into clean integer or float values.
+- **No Dependencies**: Built entirely using Python's standard library.
+
+## Installation
+
+Just drop the script into your project folder or install it:
+```bash
+pip install readx
+```
+
+## Usage
+
+### 1. Safe Content Reading
+By default, `readContent` blocks files larger than 200MB or files with binary structures.
+
+```python
+import readx
+
+# Reading a safe text file
+text = readx.readContent("logs.txt")
+
+# Trying to read a 1GB database or a .png image without ignoreWarns=True
+# Will safely raise TooBig or BinaryFile exceptions instead of freezing your PC
+binary_data = readx.readContent("photo.png", ignoreWarns=True)
+```
+
+### 2. Smart File Size Conversion
+Convert file size into any format without messy `if/else` lines.
+
+```python
+import readx
+
+# Returns an exact integer if there is no remainder, or float if there is
+mb_size = readx.size("video.mp4", type="MB")  # e.g., 45 or 45.23
+gb_size = readx.size("archive.zip", type="GB")
+```
+
+## Custom Exceptions
+
+The library provides clear exceptions you can handle with `try/except`:
+- `FileNotFound` - Raised when the path does not exist.
+- `TooBig` - Raised when the file exceeds the threshold.
+- `BinaryFile` - Raised when trying to read a binary file in text mode.
+- `InvalidType` - Raised when a wrong size format is requested.
+
+## License
+MIT

readx-0.1.0/README.md

@@ -0,0 +1,54 @@
+# readx
+
+A micro-library for safe file reading and size inspection. Protects your terminal and memory from crashing when accidentally reading huge or binary files.
+
+## Features
+
+- **Safe Reading**: Automatically stops and raises an error if the file is binary or too large.
+- **Smart Size**: Converts bytes to KB, MB, or GB into clean integer or float values.
+- **No Dependencies**: Built entirely using Python's standard library.
+
+## Installation
+
+Just drop the script into your project folder or install it:
+```bash
+pip install readx
+```
+
+## Usage
+
+### 1. Safe Content Reading
+By default, `readContent` blocks files larger than 200MB or files with binary structures.
+
+```python
+import readx
+
+# Reading a safe text file
+text = readx.readContent("logs.txt")
+
+# Trying to read a 1GB database or a .png image without ignoreWarns=True
+# Will safely raise TooBig or BinaryFile exceptions instead of freezing your PC
+binary_data = readx.readContent("photo.png", ignoreWarns=True)
+```
+
+### 2. Smart File Size Conversion
+Convert file size into any format without messy `if/else` lines.
+
+```python
+import readx
+
+# Returns an exact integer if there is no remainder, or float if there is
+mb_size = readx.size("video.mp4", type="MB")  # e.g., 45 or 45.23
+gb_size = readx.size("archive.zip", type="GB")
+```
+
+## Custom Exceptions
+
+The library provides clear exceptions you can handle with `try/except`:
+- `FileNotFound` - Raised when the path does not exist.
+- `TooBig` - Raised when the file exceeds the threshold.
+- `BinaryFile` - Raised when trying to read a binary file in text mode.
+- `InvalidType` - Raised when a wrong size format is requested.
+
+## License
+MIT

readx-0.1.0/pyproject.toml

@@ -0,0 +1,18 @@
+[build-system]
+requires = ["setuptools>=61.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "readx"
+version = "0.1.0"
+readme = "README.md"
+description = "Lib for easy use of discord webhook"
+requires-python = ">=3.8"
+authors = [
+    { name = "Beks1k"}
+]
+
+
+[tool.setuptools]
+# Указываем setuptools искать пакеты строго внутри директории src
+package-dir = {"" = "src"}

readx-0.1.0/setup.cfg

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

readx-0.1.0/src/__init__.py

@@ -0,0 +1,5 @@
+from .readx import readContent, size
+from expections import(
+    FileNotFound, TooBig, BinaryFile, InvalidType
+)
+__all__ = ["readContent", "size", "FileNotFound", "TooBig", "BinaryFile", "InvalidType"]

readx-0.1.0/src/readx.egg-info/PKG-INFO

@@ -0,0 +1,64 @@
+Metadata-Version: 2.4
+Name: readx
+Version: 0.1.0
+Summary: Lib for easy use of discord webhook
+Author: Beks1k
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# readx
+
+A micro-library for safe file reading and size inspection. Protects your terminal and memory from crashing when accidentally reading huge or binary files.
+
+## Features
+
+- **Safe Reading**: Automatically stops and raises an error if the file is binary or too large.
+- **Smart Size**: Converts bytes to KB, MB, or GB into clean integer or float values.
+- **No Dependencies**: Built entirely using Python's standard library.
+
+## Installation
+
+Just drop the script into your project folder or install it:
+```bash
+pip install readx
+```
+
+## Usage
+
+### 1. Safe Content Reading
+By default, `readContent` blocks files larger than 200MB or files with binary structures.
+
+```python
+import readx
+
+# Reading a safe text file
+text = readx.readContent("logs.txt")
+
+# Trying to read a 1GB database or a .png image without ignoreWarns=True
+# Will safely raise TooBig or BinaryFile exceptions instead of freezing your PC
+binary_data = readx.readContent("photo.png", ignoreWarns=True)
+```
+
+### 2. Smart File Size Conversion
+Convert file size into any format without messy `if/else` lines.
+
+```python
+import readx
+
+# Returns an exact integer if there is no remainder, or float if there is
+mb_size = readx.size("video.mp4", type="MB")  # e.g., 45 or 45.23
+gb_size = readx.size("archive.zip", type="GB")
+```
+
+## Custom Exceptions
+
+The library provides clear exceptions you can handle with `try/except`:
+- `FileNotFound` - Raised when the path does not exist.
+- `TooBig` - Raised when the file exceeds the threshold.
+- `BinaryFile` - Raised when trying to read a binary file in text mode.
+- `InvalidType` - Raised when a wrong size format is requested.
+
+## License
+MIT

readx-0.1.0/src/readx.egg-info/SOURCES.txt

@@ -0,0 +1,9 @@
+LICENSE
+README.md
+pyproject.toml
+src/__init__.py
+src/readx.py
+src/readx.egg-info/PKG-INFO
+src/readx.egg-info/SOURCES.txt
+src/readx.egg-info/dependency_links.txt
+src/readx.egg-info/top_level.txt

readx-0.1.0/src/readx.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

readx-0.1.0/src/readx.egg-info/top_level.txt

@@ -0,0 +1,2 @@
+__init__
+readx

readx-0.1.0/src/readx.py

@@ -0,0 +1,40 @@
+import os
+
+from expections import(
+    FileNotFound, TooBig, BinaryFile, InvalidType
+)
+
+def readContent(path:str, ignoreWarns = False, treshHold:int = 209715200):
+    if not path:
+        raise ValueError("PATH CANT BE EMPTY")
+    if not os.path.exists(path):
+        raise FileNotFound("PATH DONT EXSITS")
+    if os.path.getsize(path) > treshHold:
+        if not ignoreWarns:
+            raise TooBig("FILE TOO BIG")
+    try:
+        with open(path, "r", encoding="utf-8") as file:
+            data = file.read() 
+    except UnicodeDecodeError:
+        if not ignoreWarns:
+            raise BinaryFile("FILE IS BINARY")
+            
+        with open(path, "rb") as file:
+            data = file.read()
+    return data
+
+def size(path:str, type:str = "MB"):
+    if not path:
+        raise ValueError("PATH CANT BE EMPTY")
+    if not os.path.exists(path):
+        raise FileNotFound("PATH DONT EXSITS")
+    types = ["B", "KB", "MB", "GB"]
+    siz = os.path.getsize(path)
+    if type in types:
+        index = 1024 ** types.index(type)
+        if siz % index == 0:
+            return siz // index
+        else:
+            return siz / index
+    else:
+        raise InvalidType(f"INVALID TYPE MUST BE ONE OF {types}")