| Name | filecraft JSON |
| Version |
0.0.1
JSON |
| download |
| home_page | None |
| Summary | A comprehensive package to ease the file/folder management |
| upload_time | 2024-12-25 03:28:10 |
| maintainer | None |
| docs_url | None |
| author | Zack |
| requires_python | >=3.6 |
| license | None |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# 📂 FileCraft: Your All-in-One File Management Toolkit!
**FileCraft** is a Python package designed to make working with files, directories, and images effortless. Whether you’re reading, writing, compressing, or manipulating images, FileCraft has got you covered!
---
## ✨ Features
- **File Operations**:
Effortlessly read, write, and append text to files.
- **Directory Management**:
Quickly list files and subdirectories.
- **Compression**:
Compress entire directories into a `.zip` archive or extract existing archives.
- **Image Processing**:
- List all images in a directory.
- Copy images to new locations.
- Resize images with customizable dimensions.
---
## 📦 Installation
### Using `pip`
Install the package directly from your local directory:
```bash
pip3 install filecraft
```
---
## 🚀 Quick Start
### **1. File Operations**
```python
from filecraft import read_file, write_file, append_to_file
write_file("example.txt", "Hello, filecraft!")
append_to_file("example.txt", "\nAdding more content.")
print(read_file("example.txt"))
```
### **2. Directory Management**
```python
from filecraft import list_files, list_directories
print("Files:", list_files("."))
print("Directories:", list_directories("."))
```
### **3. Compression & Extraction**
```python
from filecraft import compress_directory, extract_archive
compress_directory("./data", "data.zip")
extract_archive("data.zip", "./extracted_data")
```
### **4. Image Processing**
```python
from filecraft import list_images, copy_images, resize_image
print("Images:", list_images("./images"))
copy_images("./images", "./backup_images")
resize_image("example.png", "resized_example.png", 100, 100)
```
---
## 📄 License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
---
## 🤝 Contributing
Contributions are welcome! If you find a bug or have a feature request, please open an issue or submit a pull request.
---
## 🌟 Stay Connected
Feel free to connect and follow updates on:
- **GitHub**: [filecraft Repository](https://github.com/username/filecraft)
- **Twitter**: [@filecraft](https://twitter.com/filecraft)
Happy Coding! 🎉
Raw data
{
"_id": null,
"home_page": null,
"name": "filecraft",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": null,
"author": "Zack",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/60/86/44a052c819f44ab871279ea20056b13badb0cb2c8f4c04856c343fe913d4/filecraft-0.0.1.tar.gz",
"platform": null,
"description": "# \ud83d\udcc2 FileCraft: Your All-in-One File Management Toolkit! \n\n**FileCraft** is a Python package designed to make working with files, directories, and images effortless. Whether you\u2019re reading, writing, compressing, or manipulating images, FileCraft has got you covered! \n\n---\n\n## \u2728 Features \n\n- **File Operations**: \n Effortlessly read, write, and append text to files. \n\n- **Directory Management**: \n Quickly list files and subdirectories. \n\n- **Compression**: \n Compress entire directories into a `.zip` archive or extract existing archives. \n\n- **Image Processing**: \n - List all images in a directory. \n - Copy images to new locations. \n - Resize images with customizable dimensions. \n\n---\n\n## \ud83d\udce6 Installation \n\n### Using `pip` \nInstall the package directly from your local directory: \n```bash\npip3 install filecraft\n``` \n\n---\n\n## \ud83d\ude80 Quick Start \n\n### **1. File Operations** \n\n```python\nfrom filecraft import read_file, write_file, append_to_file\n\nwrite_file(\"example.txt\", \"Hello, filecraft!\")\nappend_to_file(\"example.txt\", \"\\nAdding more content.\")\nprint(read_file(\"example.txt\"))\n``` \n\n### **2. Directory Management** \n\n```python\nfrom filecraft import list_files, list_directories\n\nprint(\"Files:\", list_files(\".\"))\nprint(\"Directories:\", list_directories(\".\"))\n``` \n\n### **3. Compression & Extraction** \n\n```python\nfrom filecraft import compress_directory, extract_archive\n\ncompress_directory(\"./data\", \"data.zip\")\nextract_archive(\"data.zip\", \"./extracted_data\")\n``` \n\n### **4. Image Processing** \n\n```python\nfrom filecraft import list_images, copy_images, resize_image\n\nprint(\"Images:\", list_images(\"./images\"))\ncopy_images(\"./images\", \"./backup_images\")\nresize_image(\"example.png\", \"resized_example.png\", 100, 100)\n``` \n\n---\n\n## \ud83d\udcc4 License \n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details. \n\n---\n\n## \ud83e\udd1d Contributing \n\nContributions are welcome! If you find a bug or have a feature request, please open an issue or submit a pull request. \n\n---\n\n## \ud83c\udf1f Stay Connected \n\nFeel free to connect and follow updates on: \n- **GitHub**: [filecraft Repository](https://github.com/username/filecraft) \n- **Twitter**: [@filecraft](https://twitter.com/filecraft) \n\nHappy Coding! \ud83c\udf89\n\n",
"bugtrack_url": null,
"license": null,
"summary": "A comprehensive package to ease the file/folder management",
"version": "0.0.1",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "608644a052c819f44ab871279ea20056b13badb0cb2c8f4c04856c343fe913d4",
"md5": "8b0c4e76dec721c016b9f699a354e6b8",
"sha256": "be89de8e89670afb0c38c21f1b664240b3c0c7c071229f305131a2a8a0d41022"
},
"downloads": -1,
"filename": "filecraft-0.0.1.tar.gz",
"has_sig": false,
"md5_digest": "8b0c4e76dec721c016b9f699a354e6b8",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 7384,
"upload_time": "2024-12-25T03:28:10",
"upload_time_iso_8601": "2024-12-25T03:28:10.154456Z",
"url": "https://files.pythonhosted.org/packages/60/86/44a052c819f44ab871279ea20056b13badb0cb2c8f4c04856c343fe913d4/filecraft-0.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-25 03:28:10",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "filecraft"
}
