# Make Windows Icons
This script resizes a given image to various sizes and creates a set of icons for a Windows application. The generated icons are saved in PNG format, and an ICO file is created that packs all the icons together.
## Features
- Resize a single source image to multiple sizes.
- Save the resized images in PNG format.
- Create an ICO file containing all the resized icons.
- Optionally, specify additional sizes to resize the image to.
## Requirements
- Python 3.10+
## Installation
1. Install with pip:
```sh
python3 -m pip install makewindowsicons
```
## Usage
```sh
python3 -m makewindowsicons -i <input_image> -a <app_name> [-o <output_directory>] [--no_dir] [-s <size>]...
```
### Arguments
- `-i <input_image>`, `--input_image <input_image>`: Path to the source image.
### Options
- `-a <app_name>`, `--app_name <app_name>`: Name of the application. Default is 'app'.
- `-o <output_directory>`, `--output_dir <output_directory>`: Directory to save the output resources. Default is the current directory.
- `-n`, `--no_dir`: Do not create a 'resources' directory; save images directly to the specified output directory.
- `-s <size>`, `--size <size>`: Optional additional sizes to resize the image to. Can be specified multiple times. Sizes over 256px will be ignored, as this is the largest size supported by Windows for .ICO files.
### Examples
1. **Default behavior**:
Resize the image to the default sizes and save in the `resources` directory within the current directory:
```sh
python3 -m makewindowsicons -i your_source_image.png -a YourAppName
```
2. **Specify output directory**:
Resize the image to the default sizes and save in the `resources` directory within the specified output directory:
```sh
python3 -m makewindowsicons -i your_source_image.png -a YourAppName -o output_path
```
3. **Without creating `resources` directory**:
Resize the image to the default sizes and save directly in the specified output directory:
```sh
python3 -m makewindowsicons -i your_source_image.png -a YourAppName -o output_path -n
```
4. **Add additional sizes**:
Resize the image to the default sizes plus additional sizes (e.g., 37px, 69px) and save in the `resources` directory within the specified output directory:
```sh
python3 -m makewindowsicons -i your_source_image.png -a YourAppName -o output_path -s 42 -s 69 -s 77
```
## Contributing
Feel free to submit issues or pull requests if you find any bugs or have suggestions for improvements.
## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
Raw data
{
"_id": null,
"home_page": "https://github.com/djstompzone/MakeWindowsIcons",
"name": "makewindowsicons",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.10",
"maintainer_email": null,
"keywords": null,
"author": "DJ Stomp",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/31/86/f2777c7f6571291144b76539b7938c2a848e89536b8d0df7a9b7b60ff5e2/makewindowsicons-0.2.0.tar.gz",
"platform": null,
"description": "# Make Windows Icons\n\nThis script resizes a given image to various sizes and creates a set of icons for a Windows application. The generated icons are saved in PNG format, and an ICO file is created that packs all the icons together.\n\n## Features\n\n- Resize a single source image to multiple sizes.\n- Save the resized images in PNG format.\n- Create an ICO file containing all the resized icons.\n- Optionally, specify additional sizes to resize the image to.\n\n## Requirements\n\n- Python 3.10+\n\n## Installation\n\n1. Install with pip:\n\n```sh\npython3 -m pip install makewindowsicons\n```\n\n## Usage\n\n```sh\npython3 -m makewindowsicons -i <input_image> -a <app_name> [-o <output_directory>] [--no_dir] [-s <size>]...\n```\n\n### Arguments\n\n- `-i <input_image>`, `--input_image <input_image>`: Path to the source image.\n\n### Options\n\n- `-a <app_name>`, `--app_name <app_name>`: Name of the application. Default is 'app'.\n- `-o <output_directory>`, `--output_dir <output_directory>`: Directory to save the output resources. Default is the current directory.\n- `-n`, `--no_dir`: Do not create a 'resources' directory; save images directly to the specified output directory.\n- `-s <size>`, `--size <size>`: Optional additional sizes to resize the image to. Can be specified multiple times. Sizes over 256px will be ignored, as this is the largest size supported by Windows for .ICO files.\n\n### Examples\n\n1. **Default behavior**:\n \n Resize the image to the default sizes and save in the `resources` directory within the current directory:\n\n ```sh\n python3 -m makewindowsicons -i your_source_image.png -a YourAppName\n ```\n\n2. **Specify output directory**:\n\n Resize the image to the default sizes and save in the `resources` directory within the specified output directory:\n\n ```sh\n python3 -m makewindowsicons -i your_source_image.png -a YourAppName -o output_path\n ```\n\n3. **Without creating `resources` directory**:\n\n Resize the image to the default sizes and save directly in the specified output directory:\n\n ```sh\n python3 -m makewindowsicons -i your_source_image.png -a YourAppName -o output_path -n\n ```\n\n4. **Add additional sizes**:\n\n Resize the image to the default sizes plus additional sizes (e.g., 37px, 69px) and save in the `resources` directory within the specified output directory:\n\n ```sh\n python3 -m makewindowsicons -i your_source_image.png -a YourAppName -o output_path -s 42 -s 69 -s 77\n ```\n\n## Contributing\n\nFeel free to submit issues or pull requests if you find any bugs or have suggestions for improvements.\n\n## License\n\nThis project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Easily create all appropriate icon sizes for a Windows app from a single source image",
"version": "0.2.0",
"project_urls": {
"Homepage": "https://github.com/djstompzone/MakeWindowsIcons",
"Repository": "https://github.com/djstompzone/MakeWindowsIcons"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "fb45b43fa8cb39c375916e132f9ac129688ea86f19735e3f403232aa20e8f88d",
"md5": "c547c0ad0ec2c96255094150f8d3e1c1",
"sha256": "879e43182455c268db665038760cfbf5c9ab4825ed06fca9476848eaae8b7d7f"
},
"downloads": -1,
"filename": "makewindowsicons-0.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c547c0ad0ec2c96255094150f8d3e1c1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.10",
"size": 5999,
"upload_time": "2024-07-17T14:14:08",
"upload_time_iso_8601": "2024-07-17T14:14:08.208775Z",
"url": "https://files.pythonhosted.org/packages/fb/45/b43fa8cb39c375916e132f9ac129688ea86f19735e3f403232aa20e8f88d/makewindowsicons-0.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3186f2777c7f6571291144b76539b7938c2a848e89536b8d0df7a9b7b60ff5e2",
"md5": "562626217f752c16b8b3becf542b4abb",
"sha256": "aeba8be57feffb9a15d004c113d82eebb001f58e024d4dcdf73360b4624abb94"
},
"downloads": -1,
"filename": "makewindowsicons-0.2.0.tar.gz",
"has_sig": false,
"md5_digest": "562626217f752c16b8b3becf542b4abb",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.10",
"size": 4858,
"upload_time": "2024-07-17T14:15:01",
"upload_time_iso_8601": "2024-07-17T14:15:01.476154Z",
"url": "https://files.pythonhosted.org/packages/31/86/f2777c7f6571291144b76539b7938c2a848e89536b8d0df7a9b7b60ff5e2/makewindowsicons-0.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-17 14:15:01",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "djstompzone",
"github_project": "MakeWindowsIcons",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "makewindowsicons"
}
JSON
