# mac-cleanup-py
[](https://pypi.org/project/mac-cleanup/)
[](https://github.com/mac-cleanup/mac-cleanup-py/actions/workflows/tox.yml)
[](https://github.com/mac-cleanup/mac-cleanup-py/actions/workflows/codeql.yml)
[](https://www.jetbrains.com)
## 🧹 Python cleanup script for macOS
**mac-cleanup-py** is a powerful cleanup script for macOS.\
This project is a rewrite of the original [mac-cleanup-sh](https://github.com/mac-cleanup/mac-cleanup-sh) rewritten in Python.
## 🚀 Features
**mac-cleanup-py** helps you:
1. Empty Trash
2. Delete unnecessary logs & files
3. Clear cache
<details>
<summary>
📦 Default Modules
</summary>
</br>
- `adobe` - Clears **Adobe** cache files
- `android` - Clears **Android** caches
- `brew` - Clears **Homebrew** cache
- `bun` - Clears **Bun** cache
- `cacher` - Clears **Cacher** logs
- `chrome` - Clears **Google Chrome** cache
- `chromium` - Clears **Chromium** cache files
- `composer` - Clears **composer** cache
- `conan` - Clears **Conan** cache
- `docker` - Cleanup dangling **Docker** Images and stopped containers
- `dns_cache` - Clears **DNS** cache
- `dropbox` - Clears **Dropbox** cache
- `ea` - Clears **EA App** cache files
- `gem` - Cleanup any old versions of **Gems**
- `go` - Clears **Go** cache
- `google_drive` - Clears **Google Drive** caches
- `gradle` - Clears **Gradle** caches
- `inactive_memory` - Purge **Inactive Memory**
- `ios_apps` - Cleanup **iOS Applications**
- `ios_backups` - Removes **iOS Device Backups**
- `java_cache` - Removes **Java head dumps** from home directory
- `jetbrains` - Removes logs from **PhpStorm**, **PyCharm** etc
- `kite` - Deletes **Kite** logs
- `lunarclient` - Removes **Lunar Client** logs and cache
- `minecraft` - Remove **Minecraft** logs and cache
- `microsoft_teams` - Remove **Microsoft Teams** logs and cache
- `npm` - Cleanup **npm** Cache
- `obsidian` - Clears **Obsidian** cache files
- `nuget` - Clears **.nuget** package files
- `pnpm` - Cleanup **pnpm** Cache
- `pod` - Cleanup **CocoaPods** Cache Files
- `poetry` - Clears **Poetry** cache
- `pyenv` - Cleanup **Pyenv-VirtualEnv** Cache
- `steam` - Remove **Steam** logs and cache
- `system_caches` - Clear **System cache**
- `system_log` - Clear **System Log** Files
- `telegram` - Clear old **Telegram** Cache
- `trash` - Empty the **Trash** on All Mounted Volumes and the Main HDD
- `wget_logs` - Remove **Wget** logs and hosts
- `xcode` - Cleanup **Xcode Derived Data** and **Archives**
- `xcode_simulators` - Reset **iOS simulators**
- `yarn` - Cleanup **yarn** Cache
</details>
## 📥 Installation
### Using Homebrew
```bash
brew tap mac-cleanup/mac-cleanup-py
brew install mac-cleanup-py
```
### Using pip
```bash
pip3 install mac-cleanup
```
## 🗑️ Uninstallation
### Using Homebrew
```bash
brew uninstall mac-cleanup-py
brew untap mac-cleanup/mac-cleanup-py
```
### Using pip
```bash
pip3 uninstall mac-cleanup
```
## 💡 Usage Options
Help menu:
```
$ mac-cleanup -h
usage: mac-cleanup [-h] [-n] [-u] [-c] [-p] [-f]
Python cleanup script for macOS
Version: 3.1.2
https://github.com/mac-cleanup/mac-cleanup-py
options:
-h, --help show this help message and exit
-n, --dry-run Run without deleting stuff
-u, --update Update Homebrew on cleanup
-c, --configure Open module configuration screen
-p, --custom-path Specify path for custom modules
-f, --force Accept all warnings
```
## 🌟 Contributing
Contributions are always welcome!\
If you have any ideas, suggestions, or bug reports, feel free to submit an issue or open a pull request.
## 📝 License
This project is licensed under the [Apache-2.0 License](https://github.com/mac-cleanup/mac-cleanup-py/blob/main/LICENSE).
## 👏 Acknowledgements
This project is developed using tools provided by the _JetBrains OSS Development Program_.
> Find out more about their program and how they support open source [here](https://jb.gg/OpenSourceSupport).
<a href="https://www.jetbrains.com">
<img src="https://resources.jetbrains.com/storage/products/company/brand/logos/jb_square.svg" alt="JetBrains" width="80">
</a>
Raw data
{
"_id": null,
"home_page": "https://github.com/mac-cleanup/mac-cleanup-py",
"name": "mac_cleanup",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.13,>=3.10",
"maintainer_email": null,
"keywords": "macos, script, cleanup, cleaner",
"author": "efa2d19",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/22/35/ff461fc099469427d37dc97dc57dc13044e9028f098022f47d3b97df4d6a/mac_cleanup-3.1.2.tar.gz",
"platform": null,
"description": "# mac-cleanup-py\n\n[](https://pypi.org/project/mac-cleanup/)\n[](https://github.com/mac-cleanup/mac-cleanup-py/actions/workflows/tox.yml)\n[](https://github.com/mac-cleanup/mac-cleanup-py/actions/workflows/codeql.yml)\n[](https://www.jetbrains.com)\n\n## \ud83e\uddf9 Python cleanup script for macOS\n\n**mac-cleanup-py** is a powerful cleanup script for macOS.\\\nThis project is a rewrite of the original [mac-cleanup-sh](https://github.com/mac-cleanup/mac-cleanup-sh) rewritten in Python.\n\n## \ud83d\ude80 Features\n\n**mac-cleanup-py** helps you:\n\n1. Empty Trash\n2. Delete unnecessary logs & files\n3. Clear cache\n\n\n\n<details>\n <summary>\n \ud83d\udce6 Default Modules\n </summary>\n\n </br>\n\n- `adobe` - Clears **Adobe** cache files\n- `android` - Clears **Android** caches\n- `brew` - Clears **Homebrew** cache\n- `bun` - Clears **Bun** cache\n- `cacher` - Clears **Cacher** logs\n- `chrome` - Clears **Google Chrome** cache\n- `chromium` - Clears **Chromium** cache files\n- `composer` - Clears **composer** cache\n- `conan` - Clears **Conan** cache\n- `docker` - Cleanup dangling **Docker** Images and stopped containers\n- `dns_cache` - Clears **DNS** cache\n- `dropbox` - Clears **Dropbox** cache\n- `ea` - Clears **EA App** cache files\n- `gem` - Cleanup any old versions of **Gems**\n- `go` - Clears **Go** cache\n- `google_drive` - Clears **Google Drive** caches\n- `gradle` - Clears **Gradle** caches\n- `inactive_memory` - Purge **Inactive Memory**\n- `ios_apps` - Cleanup **iOS Applications**\n- `ios_backups` - Removes **iOS Device Backups**\n- `java_cache` - Removes **Java head dumps** from home directory\n- `jetbrains` - Removes logs from **PhpStorm**, **PyCharm** etc\n- `kite` - Deletes **Kite** logs\n- `lunarclient` - Removes **Lunar Client** logs and cache\n- `minecraft` - Remove **Minecraft** logs and cache\n- `microsoft_teams` - Remove **Microsoft Teams** logs and cache\n- `npm` - Cleanup **npm** Cache\n- `obsidian` - Clears **Obsidian** cache files\n- `nuget` - Clears **.nuget** package files\n- `pnpm` - Cleanup **pnpm** Cache\n- `pod` - Cleanup **CocoaPods** Cache Files\n- `poetry` - Clears **Poetry** cache\n- `pyenv` - Cleanup **Pyenv-VirtualEnv** Cache\n- `steam` - Remove **Steam** logs and cache\n- `system_caches` - Clear **System cache**\n- `system_log` - Clear **System Log** Files\n- `telegram` - Clear old **Telegram** Cache\n- `trash` - Empty the **Trash** on All Mounted Volumes and the Main HDD\n- `wget_logs` - Remove **Wget** logs and hosts\n- `xcode` - Cleanup **Xcode Derived Data** and **Archives**\n- `xcode_simulators` - Reset **iOS simulators**\n- `yarn` - Cleanup **yarn** Cache\n\n</details>\n\n## \ud83d\udce5 Installation\n\n### Using Homebrew\n\n```bash\nbrew tap mac-cleanup/mac-cleanup-py\nbrew install mac-cleanup-py\n```\n\n### Using pip\n\n```bash\npip3 install mac-cleanup\n```\n\n## \ud83d\uddd1\ufe0f Uninstallation\n\n### Using Homebrew\n\n```bash\nbrew uninstall mac-cleanup-py\nbrew untap mac-cleanup/mac-cleanup-py\n```\n\n### Using pip\n\n```bash\npip3 uninstall mac-cleanup\n```\n\n## \ud83d\udca1 Usage Options\n\nHelp menu:\n\n```\n$ mac-cleanup -h\nusage: mac-cleanup [-h] [-n] [-u] [-c] [-p] [-f]\n\n Python cleanup script for macOS\n Version: 3.1.2\n https://github.com/mac-cleanup/mac-cleanup-py\n\noptions:\n -h, --help show this help message and exit\n -n, --dry-run Run without deleting stuff\n -u, --update Update Homebrew on cleanup\n -c, --configure Open module configuration screen\n -p, --custom-path Specify path for custom modules\n -f, --force Accept all warnings\n\n```\n\n## \ud83c\udf1f Contributing\n\nContributions are always welcome!\\\nIf you have any ideas, suggestions, or bug reports, feel free to submit an issue or open a pull request.\n\n## \ud83d\udcdd License\n\nThis project is licensed under the [Apache-2.0 License](https://github.com/mac-cleanup/mac-cleanup-py/blob/main/LICENSE).\n\n## \ud83d\udc4f Acknowledgements\n\nThis project is developed using tools provided by the _JetBrains OSS Development Program_.\n\n> Find out more about their program and how they support open source [here](https://jb.gg/OpenSourceSupport).\n\n<a href=\"https://www.jetbrains.com\">\n <img src=\"https://resources.jetbrains.com/storage/products/company/brand/logos/jb_square.svg\" alt=\"JetBrains\" width=\"80\">\n</a>\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Python cleanup script for macOS",
"version": "3.1.2",
"project_urls": {
"Documentation": "https://github.com/mac-cleanup/mac-cleanup-py#install-automatically",
"Homepage": "https://github.com/mac-cleanup/mac-cleanup-py",
"Issue Tracker": "https://github.com/mac-cleanup/mac-cleanup-py/issues",
"Repository": "https://github.com/mac-cleanup/mac-cleanup-py"
},
"split_keywords": [
"macos",
" script",
" cleanup",
" cleaner"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3b1d3a2a9262d84254ce5edaae1696ffa31348edfb33f9f9aac719fe0d815d1f",
"md5": "4300c20d6fa42d5ec1391c30b35a9617",
"sha256": "c0cf15758e77b80f66689655454bb963f80650c0fedf9f9c22135930fe0a7f7a"
},
"downloads": -1,
"filename": "mac_cleanup-3.1.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4300c20d6fa42d5ec1391c30b35a9617",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.13,>=3.10",
"size": 28824,
"upload_time": "2024-10-13T19:08:15",
"upload_time_iso_8601": "2024-10-13T19:08:15.294468Z",
"url": "https://files.pythonhosted.org/packages/3b/1d/3a2a9262d84254ce5edaae1696ffa31348edfb33f9f9aac719fe0d815d1f/mac_cleanup-3.1.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2235ff461fc099469427d37dc97dc57dc13044e9028f098022f47d3b97df4d6a",
"md5": "d644467c57658d39fb30c1128475fcb7",
"sha256": "120219d286d9e628dedf287ebdc762d0fbb819fbc89af6a391816c479fe4d3c4"
},
"downloads": -1,
"filename": "mac_cleanup-3.1.2.tar.gz",
"has_sig": false,
"md5_digest": "d644467c57658d39fb30c1128475fcb7",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.13,>=3.10",
"size": 23287,
"upload_time": "2024-10-13T19:08:16",
"upload_time_iso_8601": "2024-10-13T19:08:16.318745Z",
"url": "https://files.pythonhosted.org/packages/22/35/ff461fc099469427d37dc97dc57dc13044e9028f098022f47d3b97df4d6a/mac_cleanup-3.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-13 19:08:16",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "mac-cleanup",
"github_project": "mac-cleanup-py",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "mac_cleanup"
}
JSON
