simple-file-utils 0.1.0__py3-none-any.whl

simple_file_utils/__init__.py

@@ -0,0 +1,13 @@
+from .core import (
+    write_txt, write_bin, write_csv, write_json,
+    read_bin, read_csv, read_json, read_txt,
+    readlines_txt, append_csv, append_txt,
+    exists, delete, file_size, get_extension
+)
+
+__all__ = [
+    "write_txt", "write_bin", "write_csv", "write_json",
+    "read_bin", "read_csv", "read_json", "read_txt",
+    "readlines_txt", "append_csv", "append_txt",
+    "exists", "delete", "file_size", "get_extension"
+]

simple_file_utils/core.py

@@ -0,0 +1,76 @@
+import csv
+import pickle
+import json
+import os
+
+
+# TXT
+def write_txt(file_path: str, data: str):
+    with open(file_path, "w", encoding="utf-8") as f:
+        f.write(data)
+
+
+def read_txt(file_path: str) -> str:
+    with open(file_path, "r", encoding="utf-8") as f:
+        return f.read()
+
+def readlines_txt(file_path: str) -> list:
+    with open(file_path, "r", encoding="utf-8") as f:
+        return f.readlines()
+    
+def append_txt(file_path: str, data: str):
+    with open(file_path, "a", encoding="utf-8") as f:
+        f.write(data)
+
+
+# CSV
+def write_csv(file_path: str, rows: list):
+    with open(file_path, "w", newline="", encoding="utf-8") as f:
+        writer = csv.writer(f)
+        writer.writerows(rows)
+
+
+def read_csv(file_path: str):
+    with open(file_path, "r", encoding="utf-8") as f:
+        reader = csv.reader(f)
+        return list(reader)
+
+def append_csv(file_path: str, rows: list):
+    with open(file_path, "a", newline="", encoding="utf-8") as f:
+        writer = csv.writer(f)
+        writer.writerows(rows)
+
+
+# BIN
+def write_bin(file_path: str, data):
+    with open(file_path, "wb") as f:
+        pickle.dump(data, f)
+
+
+def read_bin(file_path: str):
+    with open(file_path, "rb") as f:
+        return pickle.load(f)
+    
+#JSON
+def write_json(file_path: str, data):
+    with open(file_path, "w", encoding="utf-8") as f:
+        json.dump(data, f)
+
+def read_json(file_path: str):
+    with open(file_path, "r", encoding="utf-8") as f:
+        return json.load(f)
+
+
+#SOME COMMON NECESSARY FUNCTIONS
+
+def exists(file_path: str) -> bool:
+    return os.path.exists(file_path)
+
+def delete(file_path: str):
+    os.remove(file_path)
+
+def file_size(file_path: str)  -> int:
+    return os.path.getsize(file_path)
+
+def get_extension(file_path: str) -> str:
+    return os.path.splitext(file_path)[1].lower()

simple_file_utils-0.1.0.dist-info/METADATA

@@ -0,0 +1,216 @@
+Metadata-Version: 2.4
+Name: simple-file-utils
+Version: 0.1.0
+Summary: A beginner-friendly library for simplified file handling in Python.
+Author: M R Darshan
+License: MIT
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Topic :: Utilities
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# 📁 Simple File Utils
+
+A lightweight Python library for simplified file handling operations.
+It provides easy-to-use functions for working with text, CSV, JSON, and binary files.
+
+### ✨ Features
+
+- Read / Write / Append TXT files
+- Read / Write / Append CSV files
+- Read / Write JSON files
+- Binary file support using pickle
+- Utility helpers:
+    - `exists()`
+    - `delete()`
+    - `file_size()`
+    - `get_extension()`
+
+---
+
+### 📦 Installation
+
+```bash
+pip install simple-file-utils
+```
+
+
+### 🚀 Quickstart
+```bash
+import simple_file_utils as sfu
+```
+---
+
+## 📄 TXT FILE FUNCTIONS
+
+`write_txt(file_path, data)`
+
+Writes text to a file (overwrites if it exists).
+
+```bash
+sfu.write_txt("example.txt", "Hello World")
+```
+---
+
+`read_txt(file_path)`
+
+Reads entire file content as a string.
+
+```bash
+content = sfu.read_txt("example.txt")
+print(content)
+```
+---
+
+`readlines_txt(file_path)`
+
+Returns file content as a list of lines.
+
+```bash
+lines = sfu.readlines_txt("example.txt")
+print(lines)
+```
+---
+
+`append_txt(file_path, data)`
+
+Appends text to an existing file.
+
+```bash
+sfu.append_txt("example.txt", "\nNew line added")
+```
+---
+
+## 📊 CSV FILE FUNCTIONS
+`write_csv(file_path, rows)`
+
+Writes a list of rows to a CSV file.
+
+```bash
+rows = [
+    ["Name", "Age"],
+    ["John",18]
+]
+```
+
+sfu.write_csv("data.csv", rows)
+---
+
+`read_csv(file_path)`
+
+Reads CSV file and returns list of rows.
+
+```bash
+data = sfu.read_csv("data.csv")
+print(data)
+```
+---
+
+`append_csv(file_path, rows)`
+
+Appends rows to an existing CSV file.
+
+```bash
+sfu.append_csv("data.csv", [["Alex", 22]])
+```
+---
+
+## 🧾 JSON Functions
+`write_json(file_path, data)`
+
+Writes a dictionary or list to a JSON file.
+
+```bash
+user = {
+    "name": "John",
+    "age": 18
+}
+
+sfu.write_json("user.json", user)
+```
+---
+
+`read_json(file_path)`
+
+Reads JSON file and returns Python object.
+
+```bash
+data = sfu.read_json("user.json")
+print(data)
+```
+---
+
+## 💾 Binary Functions
+`write_bin(file_path, data)`
+
+Saves a Python object to a binary file.
+
+```bash
+numbers = [1, 2, 3, 4]
+sfu.write_bin("numbers.bin", numbers)
+```
+
+`read_bin(file_path)`
+
+Loads a Python object from a binary file.
+
+```bash
+numbers = sfu.read_bin("numbers.bin")
+print(numbers)
+```
+---
+
+## 🛠 Utility Functions
+`exists(file_path)`
+
+Checks if file exists.
+
+```bash
+print(sfu.exists("example.txt"))
+```
+---
+
+`delete(file_path)`
+
+Deletes a file.
+
+```bash
+sfu.delete("example.txt")
+```
+---
+
+`file_size(file_path)`
+
+Returns file size in bytes.
+
+```bash
+size = sfu.file_size("data.csv")
+print(size)
+```
+---
+
+`get_extension(file_path)`
+
+Returns file extension in lowercase.
+
+```bash
+print(sfu.get_extension("data.csv"))   # .csv
+```
+---
+## 🎯 Why Use This Library?
+
+- Reduces repetitive file-handling boilerplate
+- Beginner-friendly and easy to understand
+- Clean and readable function names
+- Great for small scripts and learning projects

simple_file_utils-0.1.0.dist-info/RECORD

@@ -0,0 +1,7 @@
+simple_file_utils/__init__.py,sha256=-pMznJ9MyWadROXIMaJxumkY1hBKQ4q_jfA9ZGQIA58,431
+simple_file_utils/core.py,sha256=8dfDnIe0mioOoCGZBA_oqMb90LJBEXCtO1B6ZEv-0bk,1825
+simple_file_utils-0.1.0.dist-info/licenses/LICENSE,sha256=RrxW6AmDCskP0BLiPoDUDI8ZD9qB6NZ20zFaVF7tkDA,1068
+simple_file_utils-0.1.0.dist-info/METADATA,sha256=YTxcADEQIBBt07u_fwxDMkahAxsWsl5JZ_-CnDjmMDM,3685
+simple_file_utils-0.1.0.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
+simple_file_utils-0.1.0.dist-info/top_level.txt,sha256=57Z5cr12q9hWK1XwSCpSbTJcvFxWyp_9rzL-JH4CEZs,18
+simple_file_utils-0.1.0.dist-info/RECORD,,

simple_file_utils-0.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.10.2)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

simple_file_utils-0.1.0.dist-info/licenses/LICENSE

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

simple_file_utils-0.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+simple_file_utils