Metadata-Version: 2.1
Name: fileoperator
Version: 0.1.1
Summary: An all-in-one utility package for file operations.
Home-page: https://github.com/michaelsousajr/fileoperator
Author: Michael Sousa
Author-email: ms22dq@fsu.com
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Operating System :: OS Independent
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE.txt
Requires-Dist: cryptography
Requires-Dist: pyperclip

# fileoperator: Python File Operations Package

![logo](./public/logo.png)

## About

`fileoperator` is an all-in-one Python utility package designed to simplify and streamline a wide range of file operations. This package offers comprehensive solutions for file handling, including encryption, compression, file manipulation, and much more. Whether you're dealing with legacy code or need an efficient way to handle complex file operations, `fileoperator` is your go-to library.

## Features

- **File Encryption & Decryption**: Secure your files with state-of-the-art encryption standards.
- **File Compression & Decompression**: Efficiently compress and decompress files using various algorithms.
- **Data Import/Export Utilities**: Streamline the process of importing and exporting data.
- **Advanced File Manipulation**: Perform advanced file operations like batch renaming, searching, and splitting.
- **Cross-Platform Compatibility**: Works seamlessly on Windows, macOS, and Linux.

## Installation

To install fileoperator, simply run the following command in your terminal:
`pip install fileoperator` 

## Usage

Here are some basic examples of how `fileoperator` can be used:

### Encrypting a File
```Python
from fileoperator import encrypt_file

encrypt_file('path/to/your/file.txt', 'path/to/target/file.txt', 'your-encryption-key')
```
### Compression
```Python
from fileoperator import compress_file

compress_file('path/to/your/file.txt','path/to/compressed/file.zip')
```

### Full list of functions
View full list of functions in the tests folder

## Contributing
Contributions to fileoperator are welcome! If you have a suggestion or improvement, feel free to fork the repository and submit a pull request. Check Contributing.md for more details.

## License
fileoperator is licensed under the MIT License. Check LICENSE.txt for more details.
