# 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
- `cacher` - Clears **Cacher** logs
- `chrome` - Clears **Google Chrome** cache
- `composer` - Clears **composer** cache
- `dns_cache` - Clears **DNS** cache
- `docker` - Cleanup dangling **Docker** Images and stopped containers
- `dropbox` - Clears **Dropbox** cache
- `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
- `microsoft_teams` - Remove **Microsoft Teams** logs and cache
- `minecraft` - Remove **Minecraft** logs and cache
- `npm` - Cleanup **npm** Cache
- `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
- `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]
A Mac Cleanup Utility in Python
3.0.4
https://github.com/mac-cleanup/mac-cleanup-py
options:
-h, --help show this help message and exit
-n, --dry-run Dry run without deleting stuff
-u, --update Update HomeBrew on cleanup
-c, --configure Configure default and custom modules
-p, --custom-path Specify path for custom modules
```
## 🌟 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": "",
"docs_url": null,
"requires_python": ">=3.10,<3.12",
"maintainer_email": "",
"keywords": "macos,script,cleanup,cleaner",
"author": "Drugsosos",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/57/98/d606698374019b8d1de30d7464136bcf16f9c6a0d8d835e3b5245c819514/mac_cleanup-3.0.4.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\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 - `cacher` - Clears **Cacher** logs\n - `chrome` - Clears **Google Chrome** cache\n - `composer` - Clears **composer** cache\n - `dns_cache` - Clears **DNS** cache\n - `docker` - Cleanup dangling **Docker** Images and stopped containers\n - `dropbox` - Clears **Dropbox** cache\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 - `microsoft_teams` - Remove **Microsoft Teams** logs and cache\n - `minecraft` - Remove **Minecraft** logs and cache\n - `npm` - Cleanup **npm** Cache\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 - `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\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\n\nusage: mac-cleanup [-h] [-n] [-u] [-c] [-p]\n\n A Mac Cleanup Utility in Python\n 3.0.4\n https://github.com/mac-cleanup/mac-cleanup-py \n\noptions:\n -h, --help show this help message and exit\n -n, --dry-run Dry run without deleting stuff\n -u, --update Update HomeBrew on cleanup\n -c, --configure Configure default and custom modules\n -p, --custom-path Specify path for custom modules\n\n```\n\n\n## \ud83c\udf1f Contributing\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\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\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.0.4",
"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": "cbca46e5d83fdcb4cd958396d79ead82ddaae65a6716fd78d435bf5f062da3c7",
"md5": "0162a845bdedb063464f44c21b467021",
"sha256": "4f92d6fa7f389bb09d6d4fff0c6a5d3664c2d208bfcef621b4e92f85c3d83cea"
},
"downloads": -1,
"filename": "mac_cleanup-3.0.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0162a845bdedb063464f44c21b467021",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10,<3.12",
"size": 28253,
"upload_time": "2023-07-21T00:17:37",
"upload_time_iso_8601": "2023-07-21T00:17:37.841114Z",
"url": "https://files.pythonhosted.org/packages/cb/ca/46e5d83fdcb4cd958396d79ead82ddaae65a6716fd78d435bf5f062da3c7/mac_cleanup-3.0.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5798d606698374019b8d1de30d7464136bcf16f9c6a0d8d835e3b5245c819514",
"md5": "f10a7f68128eebf0ab1e057a24387076",
"sha256": "9dc1fb55b345ae39a1d087171647a2355f97748544dc6628fd25b32347e34352"
},
"downloads": -1,
"filename": "mac_cleanup-3.0.4.tar.gz",
"has_sig": false,
"md5_digest": "f10a7f68128eebf0ab1e057a24387076",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10,<3.12",
"size": 22632,
"upload_time": "2023-07-21T00:17:39",
"upload_time_iso_8601": "2023-07-21T00:17:39.358656Z",
"url": "https://files.pythonhosted.org/packages/57/98/d606698374019b8d1de30d7464136bcf16f9c6a0d8d835e3b5245c819514/mac_cleanup-3.0.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-07-21 00:17:39",
"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
