An unofficial ODK Central Management CLI tool
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Anthony Ankrah 28c013143a
Merge pull request #1 from x3ro/minor-quality-of-life-improvements
9 months ago
.gitignore Remove the used creds.py from version control to avoid accidentally leaking credentials 2 years ago
README.md Remove the used creds.py from version control to avoid accidentally leaking credentials 2 years ago
creds.example.py Remove the used creds.py from version control to avoid accidentally leaking credentials 2 years ago
odkCentralAPI_client.py posted v0.0 of project 2 years ago
requirements.txt Only include directly used dependencies in requirements.txt 2 years ago

README.md

An unOfficial CLI Client for ODK Central

Table of Contents

What is this?

unOffCentralMan is a basic CLI tool to help perform some basic ODK Central tasks.

What does it do?

Common tasks supported by unOffCentralMan are:

  • Listing Users
  • Listing Projects
  • Listing Project Forms
  • Creating Users
  • Assigning User Roles
  • Creating Projects
  • Deleting Users
  • Deleting Projects
  • Changing User Password
  • Triggering User Password Reset Email
  • Getting Schema for Forms
  • Getting Form Submissions
  • Exporting Form Submissions to Excel(.csv)

How does it work?

unOffCentralMan was written with python and as such will require a working instance of a Python 3 environment to function. It mainly uses the Requests library and relies heavily on the API documentation for ODK Central

How can I use it?

To use the CLI Client, you can use the checklist below.

  1. Ensure you have a working instance of Python 3.
    • (For Windows Users) You can check this by launching Command prompt (Windows Key + R, type cmd and hit ENTER) then type python -V or python --version
    • (For Linux Users) Launch terminal (Ctrl + Alt + T, type terminal and hit ENTER) then type python -V or python --version
    • (For Mac Users) Launch terminal (Cmd + Spacebar, type terminal and hit RETURN) then type python -V or python --version
    • If you saw anything other than Python 3.x.x displayed after following the most relevant instruction above, then goto the Python Website and get it installed.
  2. Install the required packages
    • Launch Command Prompt or Terminal (see point 1)
    • Type python -m pip install -r requirements.txt
    • If you have multiple instances of python installed on your device:
      • Replace python in the command above with your preferred python3 instance. eg python3.8 -m pip install -r requirements.txt
  3. Copy creds.example.py to creds.py and edit file with the required details. An example is shown below:
logEmail = "sample@email.com"
logPass = "sampleSuperStrongPassword"
apiURL = "https://sampleDomain.com/v1/" # API URL here
  1. Run the odkCentralAPI_client.py file in Command prompt or Terminal.

Can I contribute?

If you're asking this, then you probably know more about this kinda thing than I do😁. I'd like to have a chat☺. Read on!👇👇

Who can I contact?

You can reach out to