kamui

Credits

I have obvioulsy copied code and tweaked it for my purpose. I would like to give the credits to sources from where i have copied the code

1. Demo scripts from pysimplegui github
2. [stackoverflow link ] FIXME: add the link here.
   Name kamui is inpired from the kamui used by the uchihas in the Naruto shipuden. May be the lord fourth teleportation jutsu name can also be a best fit.

What is this actually ?

In short this can be a speed dail to your computer. Show kamui few places to go and it will help you teleport to those places. Save the shortcut and you can reach to the desitnation faster with the help of the Kamui. One can

1. visit a website
2. open a folder location
3. open a file. Currently it is only capable to do only these things and in future its capabilities might be extended (fingers crossed). Contributions are welcome!

How to setup kamui in your system?

There are two steps

1. Creating custom shortcut
2. Adding details into options.json

Creating custom shortcut

Windows

For those who can execute python files by just cliking on them (similar thread) follow the below procedure.

1. Create a shortcut icon for kamui.py
2. 
   Set the defined short cut which you want. Unfortunatley in windows it always has to be CTRL+ALT+ your desired key
3. Thats it. You are all set.

For those who cannot execute python files by just clicking on the file .

1. Create a .bat file which can run the python file. For example python full/path/to/location/of/kamui.py
2. Create a shortcut icon for the bat file.
3. 
   Set the defined short cut which you want. Unfortunatley in windows it always has to be CTRL+ALT+ your desired key
4. Restart your system.
5. Thats it. You are all set.

Linux

Create a custom shortcut which can execute the command python full/path/to/location/of/kamui.py. Creating a custom shortcut is similar in all the linux distros. A reference link to ubuntu on how to create a custom shortcuts.

Adding details into options.json file.

Kamui uses the default apps set in the operating system to open link. One need to edit the options.json file to add their paths/files/links. At the moment Kamui can

1. open a web link.
2. Can open a folder locaiton in file explorer.
3. Can open a file.

This readme assumes that you are familiar with JSON format already. Below is an example options.json file content

//options.json file content
{
    "YT": {
        "type": "link",
        "value": "www.youtube.com"
    },
    "google": {
        "type": "link",
        "value": "www.google.com"
    },
    "mypic":{
        "type": "file",
        "value": "C:/Users/user_1/Downloads/passportsizepic.png"  // always remember to use forward slash
    },
    "users folder": {
        "type": "file",
        "value": "C:/Users/user_1/Downloads/"  // always remember to use forward slash
    }
}

Why kamui takes lot of time to start ?

Kamui can sometimes be slow and it is not because of a the script, its because of windows. Continue reading for detailed answer.

Reason behind Kamui being slow.

From the stackoverflow link

Before launching a program via its shortcut key, Windows first polls all currently running programs and asks "Is this your shortcut key?" If so it switches focus to that window rather than spinning up a new copy of the program.

so switch off the back ground process which are not really usefull for you. I really would not have my calculator running in background i mean what is the calculator app doing in the background ? 🤨.

How to switch off background apps in windows

1. Hit windows button
2. Enter Background apps
3. Switch off whatever is not needed for you.
4. You shall now see improvement in its speed.

Isnt this a problem for linux ?

No this is not a problem for linux.

Limitations

1. During a Microsoft teams screen sharing session, Kamui is not being invoked if the screen that is being shared is your primary screen/monitor. The reason behind this is still being investigated.
2. Kamui does not complain if file/location is not present.Instead it simply exits. There is a plan to implement this in the near future

License

license