A short description of your module
Project description
ModuleX 📁
A simple and intuitive Python package for file and folder management operations. ModuleX provides easy-to-use functions for creating, deleting, and managing files and directories with built-in error handling.
✨ Features
- Interactive Main Panel: Easy-to-use menu system for all operations
- Create Folders: Easily create new directories with automatic name formatting
- Delete Folders: Remove directories (including non-empty ones) with safety checks
- Create Files: Generate text files with custom content
- Delete Files: Remove files with confirmation and error handling
- Smart Input Processing: Automatic space-to-underscore conversion
- Error Handling: Built-in exception handling for robust operations
- Flexible Usage: Choose between interactive panel or individual function calls
🚀 Installation
pip install modulex
That's it! No additional dependencies required.
📖 Quick Start
Interactive Main Panel (Recommended for Testing)
If you want to test the module or prefer an easier directory management experience, use the interactive main panel:
import modulex
# Launch the interactive file manager
modulex.mainpanel()
This opens a user-friendly menu where you can:
- Choose operations through numbered options (1-5)
- Navigate through all available functions
- Perfect for testing and general file management
Advanced Individual Function Usage
For more advanced editing or when integrating into your own scripts, you can call individual functions directly:
import modulex
# Create a new folder
modulex.createfolder()
# Create a new text file
modulex.createFile()
# Delete a folder
modulex.deletefolder()
# Delete a file
modulex.deleteFile()
🎯 Usage Examples
Using the Main Panel
import modulex
modulex.mainpanel()
# Opens interactive menu:
# === ModuleX File Manager ===
# 1. Create Folder
# 2. Delete Folder
# 3. Create File
# 4. Delete File
# 5. Exit
Individual Function Examples
Creating a Folder
import modulex
modulex.createfolder()
# Prompts: "Enter a name for a new folder: "
# Input: "my project folder"
# Creates: "my_project_folder" directory
Creating a Text File
import modulex
modulex.createFile()
# Prompts for filename (max 20 characters)
# Currently supports .txt files only
# Allows you to add content to the file
Managing Files and Folders
- All functions include automatic input validation
- Spaces in names are automatically converted to underscores
- Built-in checks prevent overwriting existing files/folders
- Error messages guide you through any issues
📋 Function Reference
| Function | Description | Input Requirements |
|---|---|---|
mainpanel() |
Interactive file management menu | None - guided through prompts |
createfolder() |
Creates a new directory | Folder name (any length) |
deletefolder() |
Removes an existing directory | Existing folder name |
createFile() |
Creates a new text file with content | Filename (≤20 chars), .txt extension |
deleteFile() |
Removes an existing file | Existing filename |
⚠️ Important Notes
- File names are limited to 20 characters maximum
- Currently supports only
.txtfile extension - Folder and file names with spaces are automatically converted (spaces → underscores)
- All operations include safety checks to prevent accidental overwrites
🛠️ Requirements
- Python 3.6 or higher
- No external dependencies required
🤝 Contributing
We welcome contributions! If you have suggestions for improvements or find any issues, please feel free to reach out through PyPI or create discussions around the package.
📝 License
This project is licensed under the MIT License.
🐛 Issues & Support
If you encounter any issues or have questions about ModuleX, you can:
- Check the PyPI project page for updates
- Review the documentation above
- Contact the maintainer through PyPI
🚧 Roadmap
- Support for additional file extensions
- Batch operations for multiple files/folders
- Configuration file support
- Enhanced error reporting
- GUI interface option
Made with ❤️ by Bojidar Georgiev
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file modulex-1.2.2.tar.gz.
File metadata
- Download URL: modulex-1.2.2.tar.gz
- Upload date:
- Size: 40.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.13.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
a77c8b92f29f46aa2c88d96246dd4788d9f89b77eb7b782e0d9c585514e5f814
|
|
| MD5 |
03fa2046990a3c8f08d92f102b629c4d
|
|
| BLAKE2b-256 |
9e1551284995d8f8087c2c97666c28c552c5333fa057b9116b79137f711ba98a
|
File details
Details for the file modulex-1.2.2-py3-none-any.whl.
File metadata
- Download URL: modulex-1.2.2-py3-none-any.whl
- Upload date:
- Size: 27.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.13.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
fc66351da1493d4d9ff58ed45023dcbe8df20320f4b70e162407b2d9737081a1
|
|
| MD5 |
1d178fa1345b3386b90cb8e38c78e6c1
|
|
| BLAKE2b-256 |
aa751c51795b4072405592428cdb593ee7ea1a408891ec5265f5018a96b3be72
|