Installing Kumodd#
Kumodd is a command line utility.
How to Install Kmodd on Windows#
To install Kumodd on Windows, download kumodd.exe from the kumodd release page. Note that the ‘Source code’ files are not required. kumodd.exe is a standalone windows command line utility.
Next, move kumodd.exe to C:\Windows. Moving it to C:\Windows will ensure it is in the default path, and as a result, is avialable on the command line in a CMD or powershell window.
Then, open a cmd shell or powershell, and run it.
kumodd --helpfull
How to Install Kmodd on Unix#
To setup kumodd, install python 3 and git, then install kumodd and its requirements.
On Debian or Ubuntu:
apt install python3 git diff
git clone https://github.com/rich-murphey/kumodd.git
cd kumodd
python3 -m pip install --user -r requirements.txt
kumodd --helpfull
Setup Kmodd on Windows or Unix#
To access Google Drive, Kumodd requires two credential files:
config/google_api_credentials.json - permission to access the Google API
config/google_drive_account_credentials.json - permission to access a user’s Google Drive account
-
Obtain google_api_credentials.json (permission to access the Google API):
- Create a free google clou daccount.
- Login to your Google cloud account.
- Create a Project.
- Create Oauth2 API credential for the project.
- Click “Create Credentials” and select “Oauth client ID”.
- Select the radio button “Web Application”.
- In “Authorized redirect URIs”, enter: http://localhost:8080
- Click “create”. Next, a dialog “OAuth client” will pop up.
- Click OK. Next, it will show the list of “Oauth 2.0 client IDs”.
- Click the down arrow icon at far right of the new ID. The ID will download.
- Copy the downloaded ID it to config/google_api_credentials.json.json.
-
Obtain google_drive_account_credentials.json (permission to access a specific user’s Google Drive account):
- Run Kumodd (e.g. kumodd -list all). Kumodd will launch a web browser to open a Google login page.
- Login to the user’s Google Drive account. Next, it will request approval.
- Click “Approve”. Next, kumodd stores the credentials in config/google_drive_account_credentials.json.
If there is no local browser, or if –nobrowser is used:
- Open a web browser.
- Run Kumodd (e.g. kumodd -list all). Kumodd will list the URL of the Google login page.
- Copy the URL and paste it into a browser.
- Login to the Google Drive account. Next, it will request approval.
- Click “Approve”. Next, the page will show an access token.
- Copy the token from the web page. Paste it into kumodd, and press enter. Next, kumodd saves the credentials in config/google_drive_account_credentials.json.
Once authorized, the login page will not be shown again unless the token expires or google_drive_account_credentials.json is deleted.