sortmeout 1.0.0__tar.gz

sortmeout-1.0.0/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/PKG-INFO

@@ -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/README.md

@@ -0,0 +1,248 @@
+# 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/pyproject.toml

@@ -0,0 +1,140 @@
+[build-system]
+requires = ["setuptools>=61.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "sortmeout"
+version = "1.0.0"
+description = "Open-source file automation and organization tool for macOS"
+readme = "README.md"
+license = {text = "MIT"}
+authors = [
+    {name = "SortMeOut Contributors"}
+]
+keywords = [
+    "automation",
+    "file-management",
+    "macos",
+    "organization",
+    "rules",
+    "workflow"
+]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Environment :: MacOS X",
+    "Intended Audience :: End Users/Desktop",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: MacOS :: MacOS X",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Topic :: Desktop Environment :: File Managers",
+    "Topic :: System :: Filesystems",
+    "Topic :: Utilities",
+]
+requires-python = ">=3.9"
+dependencies = [
+    "watchdog>=3.0.0",
+    "pyobjc-core>=9.0",
+    "pyobjc-framework-Cocoa>=9.0",
+    "pyobjc-framework-FSEvents>=9.0",
+    "pyobjc-framework-Quartz>=9.0",
+    "pyobjc-framework-ScriptingBridge>=9.0",
+    "pyyaml>=6.0",
+    "python-dateutil>=2.8.0",
+    "rich>=13.0.0",
+    "click>=8.0.0",
+    "appdirs>=1.4.0",
+    "humanize>=4.0.0",
+]
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=7.0.0",
+    "pytest-cov>=4.0.0",
+    "pytest-asyncio>=0.21.0",
+    "pytest-mock>=3.0.0",
+    "mypy>=1.0.0",
+    "black>=23.0.0",
+    "flake8>=6.0.0",
+    "isort>=5.0.0",
+    "pre-commit>=3.0.0",
+]
+gui = [
+    "rumps>=0.4.0",
+    "pyobjc-framework-Cocoa>=9.0",
+]
+
+[project.scripts]
+sortmeout = "sortmeout.cli:main"
+sortmeout-gui = "sortmeout.gui.app:main"
+
+[project.urls]
+Homepage = "https://sortmeout.saidborna.com"
+Documentation = "https://github.com/S-Borna/sortmeout/tree/main/docs"
+Repository = "https://github.com/S-Borna/sortmeout"
+Issues = "https://github.com/S-Borna/sortmeout/issues"
+
+[tool.setuptools.packages.find]
+where = ["."]
+include = ["sortmeout*"]
+
+[tool.black]
+line-length = 100
+target-version = ["py39", "py310", "py311", "py312"]
+include = '\.pyi?$'
+exclude = '''
+/(
+    \.eggs
+  | \.git
+  | \.hg
+  | \.mypy_cache
+  | \.tox
+  | \.venv
+  | _build
+  | buck-out
+  | build
+  | dist
+)/
+'''
+
+[tool.isort]
+profile = "black"
+line_length = 100
+skip_gitignore = true
+
+[tool.mypy]
+python_version = "3.9"
+warn_return_any = true
+warn_unused_configs = true
+ignore_missing_imports = true
+exclude = [
+    "build",
+    "dist",
+    "venv",
+]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+python_files = ["test_*.py", "*_test.py"]
+addopts = "-v --tb=short"
+asyncio_mode = "auto"
+
+[tool.coverage.run]
+source = ["sortmeout"]
+branch = true
+omit = [
+    "*/tests/*",
+    "*/__pycache__/*",
+]
+
+[tool.coverage.report]
+exclude_lines = [
+    "pragma: no cover",
+    "def __repr__",
+    "raise AssertionError",
+    "raise NotImplementedError",
+    "if __name__ == .__main__.:",
+]

sortmeout-1.0.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+