sortmeout 1.0.0__py3-none-any.whl

sortmeout-1.0.0.dist-info/METADATA

@@ -0,0 +1,302 @@
+Metadata-Version: 2.4
+Name: sortmeout
+Version: 1.0.0
+Summary: Open-source file automation and organization tool for macOS
+Author: SortMeOut Contributors
+License: MIT
+Project-URL: Homepage, https://sortmeout.saidborna.com
+Project-URL: Documentation, https://github.com/S-Borna/sortmeout/tree/main/docs
+Project-URL: Repository, https://github.com/S-Borna/sortmeout
+Project-URL: Issues, https://github.com/S-Borna/sortmeout/issues
+Keywords: automation,file-management,macos,organization,rules,workflow
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: MacOS X
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: MacOS :: MacOS X
+Classifier: Programming Language :: Python :: 3
+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: Topic :: Desktop Environment :: File Managers
+Classifier: Topic :: System :: Filesystems
+Classifier: Topic :: Utilities
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: watchdog>=3.0.0
+Requires-Dist: pyobjc-core>=9.0
+Requires-Dist: pyobjc-framework-Cocoa>=9.0
+Requires-Dist: pyobjc-framework-FSEvents>=9.0
+Requires-Dist: pyobjc-framework-Quartz>=9.0
+Requires-Dist: pyobjc-framework-ScriptingBridge>=9.0
+Requires-Dist: pyyaml>=6.0
+Requires-Dist: python-dateutil>=2.8.0
+Requires-Dist: rich>=13.0.0
+Requires-Dist: click>=8.0.0
+Requires-Dist: appdirs>=1.4.0
+Requires-Dist: humanize>=4.0.0
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0.0; extra == "dev"
+Requires-Dist: pytest-cov>=4.0.0; extra == "dev"
+Requires-Dist: pytest-asyncio>=0.21.0; extra == "dev"
+Requires-Dist: pytest-mock>=3.0.0; extra == "dev"
+Requires-Dist: mypy>=1.0.0; extra == "dev"
+Requires-Dist: black>=23.0.0; extra == "dev"
+Requires-Dist: flake8>=6.0.0; extra == "dev"
+Requires-Dist: isort>=5.0.0; extra == "dev"
+Requires-Dist: pre-commit>=3.0.0; extra == "dev"
+Provides-Extra: gui
+Requires-Dist: rumps>=0.4.0; extra == "gui"
+Requires-Dist: pyobjc-framework-Cocoa>=9.0; extra == "gui"
+Dynamic: license-file
+
+# SortMeOut 📁✨
+
+An open-source file automation and organization tool for macOS, inspired by Noodlesoft Hazel.
+
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Python 3.9+](https://img.shields.io/badge/python-3.9+-blue.svg)](https://www.python.org/downloads/)
+[![macOS](https://img.shields.io/badge/platform-macOS-lightgrey.svg)](https://www.apple.com/macos/)
+
+## 🎯 Overview
+
+SortMeOut watches folders you specify and automatically organizes files according to rules you create. Move, rename, tag, archive, or delete files based on name, date, type, content, and much more.
+
+## ✨ Features
+
+### Core Features
+
+- **Folder Watching**: Monitor multiple folders for file changes in real-time
+- **Rule-Based Organization**: Create powerful rules with conditions and actions
+- **Pattern Matching**: Use glob patterns, regex, and smart matching
+- **File Operations**: Move, copy, rename, delete, archive files
+- **macOS Integration**: Tags, Spotlight metadata, Finder comments
+
+### Conditions
+
+- File name (contains, starts with, ends with, matches pattern)
+- File extension/type (documents, images, videos, etc.)
+- File size (greater than, less than, between)
+- Date attributes (created, modified, accessed, added)
+- File contents (text search, regex)
+- macOS tags and Finder comments
+- Source URL/application (where downloaded from)
+- Nested conditions (AND, OR, NOT logic)
+
+### Actions
+
+- Move to folder (with subfolder creation)
+- Copy to folder
+- Rename (with pattern substitution)
+- Add/remove macOS tags
+- Set Finder comments
+- Archive (zip, tar, gzip)
+- Delete / Move to Trash
+- Run shell script
+- Execute AppleScript
+- Open with application
+- Send notification
+- Import to Photos/Music
+
+### Advanced Features
+
+- **Trash Management**: Auto-clean trash based on age/size
+- **App Sweep**: Detect and remove app support files when uninstalling
+- **Preview Mode**: See what rules would do without executing
+- **Rule Import/Export**: Share rules with others
+- **Logging**: Detailed logs of all operations
+- **Menu Bar App**: Quick access and status
+
+## 🚀 Quick Start
+
+### Installation
+
+```bash
+# Clone the repository
+git clone https://github.com/yourusername/sortmeout.git
+cd sortmeout
+
+# Create virtual environment
+python3 -m venv venv
+source venv/bin/activate
+
+# Install dependencies
+pip install -r requirements.txt
+
+# Install the application
+pip install -e .
+```
+
+### Basic Usage
+
+```python
+from sortmeout import SortMeOut, Rule, Condition, Action
+
+# Create a new instance
+app = SortMeOut()
+
+# Add a folder to watch
+app.add_folder("~/Downloads")
+
+# Create a rule to organize PDF files
+rule = Rule(
+    name="Organize PDFs",
+    conditions=[
+        Condition("extension", "equals", "pdf")
+    ],
+    actions=[
+        Action("move", destination="~/Documents/PDFs")
+    ]
+)
+
+# Add rule to the Downloads folder
+app.add_rule("~/Downloads", rule)
+
+# Start watching
+app.start()
+```
+
+### GUI Application
+
+```bash
+# Launch the GUI
+sortmeout-gui
+```
+
+## 📖 Documentation
+
+- [User Manual](docs/user-manual.md)
+- [Rule Creation Guide](docs/rules-guide.md)
+- [API Reference](docs/api-reference.md)
+- [Contributing Guide](CONTRIBUTING.md)
+- [FAQ](docs/faq.md)
+
+## 🗺️ Roadmap
+
+### Phase 1: Core Engine (v0.1.0) ✅
+
+- [x] Folder monitoring with FSEvents
+- [x] Basic rule engine
+- [x] File conditions (name, extension, size, date)
+- [x] Basic actions (move, copy, rename, delete)
+
+### Phase 2: Advanced Conditions (v0.2.0)
+
+- [ ] Content-based matching
+- [ ] macOS metadata (tags, comments)
+- [ ] Download source detection
+- [ ] Compound conditions (AND/OR/NOT)
+
+### Phase 3: Advanced Actions (v0.3.0)
+
+- [ ] Archive creation
+- [ ] Shell script execution
+- [ ] AppleScript integration
+- [ ] Notifications
+
+### Phase 4: GUI & UX (v0.4.0)
+
+- [ ] Menu bar application
+- [ ] Rule editor interface
+- [ ] Preview mode
+- [ ] Activity log viewer
+
+### Phase 5: System Features (v0.5.0)
+
+- [ ] Trash management
+- [ ] App Sweep functionality
+- [ ] Spotlight integration
+- [ ] Photos/Music import
+
+### Phase 6: Polish & Release (v1.0.0)
+
+- [ ] Performance optimization
+- [ ] Comprehensive testing
+- [ ] Documentation complete
+- [ ] Community feedback integration
+
+## 🛠️ Development
+
+### Prerequisites
+
+- macOS 10.15 (Catalina) or later
+- Python 3.9 or later
+- Xcode Command Line Tools
+
+### Setup Development Environment
+
+```bash
+# Install development dependencies
+pip install -r requirements-dev.txt
+
+# Run tests
+pytest
+
+# Run with coverage
+pytest --cov=sortmeout
+
+# Type checking
+mypy sortmeout
+
+# Linting
+flake8 sortmeout
+black sortmeout
+```
+
+### Project Structure
+
+```
+sortmeout/
+├── sortmeout/              # Main package
+│   ├── __init__.py
+│   ├── app.py              # Main application class
+│   ├── core/               # Core functionality
+│   │   ├── __init__.py
+│   │   ├── watcher.py      # Folder watching (FSEvents)
+│   │   ├── rule.py         # Rule definitions
+│   │   ├── condition.py    # Condition types
+│   │   └── action.py       # Action types
+│   ├── conditions/         # Condition implementations
+│   ├── actions/            # Action implementations
+│   ├── macos/              # macOS-specific integrations
+│   ├── gui/                # GUI components
+│   ├── utils/              # Utility functions
+│   └── config/             # Configuration management
+├── tests/                  # Test suite
+├── docs/                   # Documentation
+├── examples/               # Example rules and scripts
+└── resources/              # Icons, assets
+```
+
+## 🤝 Contributing
+
+We welcome contributions! Please see our [Contributing Guide](CONTRIBUTING.md) for details.
+
+### Ways to Contribute
+
+- Report bugs and request features via [Issues](https://github.com/yourusername/sortmeout/issues)
+- Submit pull requests for bug fixes or new features
+- Improve documentation
+- Share your custom rules
+- Help translate the application
+
+## 📄 License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+## 🙏 Acknowledgments
+
+- Inspired by [Noodlesoft Hazel](https://www.noodlesoft.com)
+- Built with [watchdog](https://github.com/gorakhargosh/watchdog) for cross-platform file monitoring
+- Uses [PyObjC](https://pyobjc.readthedocs.io/) for macOS integration
+
+## 📬 Contact
+
+- GitHub Issues: For bug reports and feature requests
+- Discussions: For questions and community support
+
+---
+
+**Note**: This is an independent open-source project and is not affiliated with Noodlesoft.

sortmeout-1.0.0.dist-info/RECORD

@@ -0,0 +1,27 @@
+sortmeout/__init__.py,sha256=Ap9DETDBO_FM2Dw9_xAaPQPOr5c8koK69wQH5n9nJZU,535
+sortmeout/app.py,sha256=VHBbakCD3a5TsMY2ryvq7ohsyOtCfimRoj_wpPBF7gI,19535
+sortmeout/cli.py,sha256=X5FDq45dNh1tlJOiehXPlRKzacKB4wlxYUTP5NUq2Pc,16745
+sortmeout/config/__init__.py,sha256=WXC9kRjC4btHauoAC1XLgYCIL7BOPK0kEsuTXRBvQ7c,199
+sortmeout/config/manager.py,sha256=2AbVsj0QgX1g7X18aUXDZpbgqzUUWbvPZRqrzU09DDA,9396
+sortmeout/config/settings.py,sha256=vg_pa_BC7ZUAuYqn6WXbiDriwmvMWdhqZlF-vrxaVV8,7310
+sortmeout/core/__init__.py,sha256=7egI0IwpndkfafMnGWNqp8KumwuKSrjuQb0wqTTYsqA,501
+sortmeout/core/action.py,sha256=9Yp3w449s8K8SWmAhGS3PoywPPDtOYYkvcVpEUq5yZw,29860
+sortmeout/core/condition.py,sha256=a5OC9gKg43iOq-QZDJP20HPSHlJsSso5mN56ZjIWVcU,22949
+sortmeout/core/engine.py,sha256=2W62M2JTVXFOLYTfzoWjHavDqjptJQlxuiFys5yYi-o,12346
+sortmeout/core/rule.py,sha256=yXllTSsO_37S1D4UuL-CZuVSH9mrajMdovB0ZNB9pEY,8360
+sortmeout/core/watcher.py,sha256=YPTRNwiUEmGssyASpaPmuFm0AmNTzSePoCMldvNuFt8,13854
+sortmeout/gui/__init__.py,sha256=Ix0TtKSrND8vD9oaS4BYPQLPyQtaQyyYt4Wbzc6u2NA,127
+sortmeout/gui/app.py,sha256=yBV7ivN0EbfsOc5NhnRNbPoi3RoXrT9BQHeIcBzdQww,10508
+sortmeout/macos/__init__.py,sha256=X-OU9MRmw0eK6WbHUNr7ult38XhBlzh7iOxYocj7DjQ,459
+sortmeout/macos/spotlight.py,sha256=qLW0ZPbf_CUwolFzD_89ALkb-SwOHvuP6JJk6hVuMU8,8471
+sortmeout/macos/tags.py,sha256=cBYEUBsZ2CYqGPbXW53ejn_ljvM8nvBj0L0g_h-35Ds,7206
+sortmeout/macos/trash.py,sha256=zfPvkEb5LFONpCu6LXVRODI5SU0-DZ5ih_X4A7Ym4hI,11989
+sortmeout/utils/__init__.py,sha256=x9Mb7OEuQs47hUCzObBNtokk9pu_p_feMCb6MnDev1w,230
+sortmeout/utils/file_info.py,sha256=JKTK56VSUCdzSuDqpNt_W3_Hby_VegjFtAd7G4HyYsA,9852
+sortmeout/utils/logger.py,sha256=jzNc8iZnKJ1ML2yawTbCT7jyrLkEr1r7eqwLGG6o_hM,5584
+sortmeout-1.0.0.dist-info/licenses/LICENSE,sha256=TDyRoc2MaTsSKooQQE8pjE04O3SisR0CFbP-lGmqB9U,1079
+sortmeout-1.0.0.dist-info/METADATA,sha256=dP32kt6OvS7gkvf2yLBTwunyTFWx5ytt7iusNiqutYM,8863
+sortmeout-1.0.0.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
+sortmeout-1.0.0.dist-info/entry_points.txt,sha256=739npal24AFq2-335O9G5kpuoXFWTXfwjFEHmZlmOEU,88
+sortmeout-1.0.0.dist-info/top_level.txt,sha256=jnlVjHBFfRoTfyW9d98r-oRGMnuXj66ZQ06KVD9_SdA,10
+sortmeout-1.0.0.dist-info/RECORD,,

sortmeout-1.0.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
+

sortmeout-1.0.0.dist-info/entry_points.txt

@@ -0,0 +1,3 @@
+[console_scripts]
+sortmeout = sortmeout.cli:main
+sortmeout-gui = sortmeout.gui.app:main

sortmeout-1.0.0.dist-info/licenses/LICENSE

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

sortmeout-1.0.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+sortmeout