Skip to main content

A Windows utility to set folder icons

Project description

FolderIkon

PyPI - Python Version PyPI - Status PyPI - License Lines of code

A Windows utility to set folder icons.

Normally, setting a folder icon (not to be confused with a folder picture) through Windows Explorer requires an icon of ICO format, this means converting it first. Also changing the folder name will make the icon ineffective.

FolderIkon will take a JPG, ICO or a PNG file, convert it, create/edit the configuration file desktop.ini, set the appropriate permissions and notify the Shell about the icon. The icon will be hidden as it has generally no other use, also it is a 256x256 image, nothing beautiful.

However tilted images e.g those of product boxes etc. will not be displayed properly. A square image is recommended for optimum results. I suggest not to use images of other aspect ratios although they will work.

Installation

Requires Python 3.6+ and Windows

pip install --upgrade folderikon

Usage

Set the first ICO, JPG or PNG found in the current folder as the folder icon (subfolders not included).

folderikon

Set image as the folder icon of the current folder. image can be a URL as well.

folderikon -i image

Set image as the folder icon of folder and name the icon as icon

folderikon -i image -d folder -o icon

Note

It may take some time; or a restart of Windows Explorer for the folder icon to appear.

Command-line options

folderikon [-h] [--image IMAGE] [--icon ICON] [--folder FOLDER] [--delete-original] [--raise-on-existing] [--dont-hide-icon] [--silent] [--no-color]

A Windows utility to set folder icons.

optional arguments:
  -h, --help            show this help message and exit
  --image IMAGE, --input IMAGE, -i IMAGE
                        The image to set as folder icon. JPG, ICO and PNG formats are supported. URLs can be specified as well. Defaults to the       
                        first JPG/PNG file found in the current folder.
  --icon ICON, --output ICON, -o ICON
                        Output icon file name. Defaults to the name of first JPG/PNG found in current folder saved with a '.ico' extension.
  --folder FOLDER, -d FOLDER
                        The path of the folder whose icon is to be set. Defaults to the current folder.
  --delete-original, -f
                        Deletes the original image.
  --raise-on-existing   Raise an exception if the folder already has an icon.
  --dont-hide-icon      The folder icon is marked as hidden by default. Use this option to not do it.
  --no-color            Disables colored output.

TODO

Changelog

Licence

FolderIkon is distributed under the MIT License

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

folderikon-0.0.2.tar.gz (8.6 kB view hashes)

Uploaded Source

Built Distribution

folderikon-0.0.2-py3-none-any.whl (8.2 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page