Skip to main content

Simple CRUD operations for file handling in Python

Project description

File Crud Simple CRUD operations for files and directories in Python.

Description file-crud is a lightweight Python package that provides basic Create, Read, Update, and Delete (CRUD) functions for handling files and directories easily. It includes safe operations with error handling and supports nested directories. Perfect for beginners or simple file management tasks.

The package normalizes file and directory paths across different operating systems (Windows, Linux, macOS), ensuring consistent behavior regardless of how paths are written or used.

Features Create a new file with content.

Read the content of a file.

Update (append) content to an existing file.

Delete a file safely with error handling.

Create and delete directories, including nested folders.

Optional recursive deletion: remove directories even if they contain files/subfolders.

Copy and move files with optional overwrite protection.

Copy and move directories recursively with optional overwrite.

Cross-platform path normalization to handle differences between operating systems.

Installation bash Copiar Editar pip install file-crud Usage

import file_crud as fc #more easy to use

Create a file

fc.create_file('example.txt', 'Hello, world!') # If you don’t want content, pass None

Read the file

content = fc.read_file('example.txt')

Update the file

fc.update_file('example.txt', '\nThis is an added line.') # If no content to add, pass None

Delete the file

fc.delete_file('example.txt')

Create a directory (nested paths allowed)

fc.create_directory('my_folder/subfolder')

Delete a directory (only if empty)

fc.delete_directory('my_folder/subfolder')

Delete a directory recursively (removes all contents)

fc.delete_directory('my_folder', recursive=True)

Copy a file (won't overwrite by default)

fc.copy_file('source.txt', 'destination.txt')

Move a file (won't overwrite by default)

fc.move_file('old_location.txt', 'new_location.txt')

Copy a directory recursively (won't overwrite by default)

fc.copy_directory('source_folder', 'destination_folder')

Move a directory recursively (won't overwrite by default)

fc.move_directory('old_folder', 'new_folder')

Notes on recursive deletion and overwrite

delete_directory with recursive=True removes the entire directory and all its contents — use with caution.

Copy and move functions accept an overwrite parameter (default False) to control whether existing files/directories get overwritten.

Path Normalization

All functions internally normalize file and directory paths to ensure compatibility across Windows, Linux, and macOS. This means you can use paths with ~, relative paths, or different slash styles, and they will be handled correctly.

Author

Frank Pineda Email: fpineda11@gmail.com

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

file_crud-0.2.0.tar.gz (4.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

file_crud-0.2.0-py3-none-any.whl (4.3 kB view details)

Uploaded Python 3

File details

Details for the file file_crud-0.2.0.tar.gz.

File metadata

  • Download URL: file_crud-0.2.0.tar.gz
  • Upload date:
  • Size: 4.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.2

File hashes

Hashes for file_crud-0.2.0.tar.gz
Algorithm Hash digest
SHA256 6eeaae3b3978be34c05c50e395dc9da8093120f573c30bb46eb1e615d47e8ed4
MD5 2f0daff4f72cb8cc15bc703305ba13e7
BLAKE2b-256 c88c6531c1ff225d6ee5580c1723d4e87062a406c49d152aa8cbc59f1379aaeb

See more details on using hashes here.

File details

Details for the file file_crud-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: file_crud-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 4.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.2

File hashes

Hashes for file_crud-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 6df99a0d89f157597228770be37060aa7cabd12395aa0d6db3b8670a07124af7
MD5 d664d79728c450aa1ddcfff3a1894f83
BLAKE2b-256 aba474e32907947a55a0d6597053ea5040d72a84de4b57955771f61e39b3e6ca

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page