Deepomatic Platform
  • Overview
  • Release notes
    • May 2025
    • January 2025
    • November 21, 2024
    • October 17, 2024
    • September 19, 2024
    • July 18, 2024
    • June 27, 2024
    • May 23, 2024
    • April 18, 2024
    • March 21, 2024
    • February 22, 2024
    • January 18, 2024
    • December 13, 2023
    • October 26, 2023
    • July 20, 2023
    • June 29, 2023
    • May 29, 2023
    • April 27, 2023
    • March 30, 2023
    • February 17, 2023
    • January 19, 2023
    • December 22, 2022
    • November 18, 2022
    • October 19, 2022
    • September 19, 2022
    • July 27, 2022
    • June 26, 2022
    • May 17, 2022
    • April 13, 2022
    • March 17, 2022
    • February 10, 2022
    • December 21, 2021
    • October 26, 2021
  • Getting started
  • ADMIN & USER MANAGEMENT
    • Invite and manage users
      • Invite group of users at once
      • SSO
        • OIDC
        • SAML
  • Deepomatic Engage
    • Integrate applications
      • Deepomatic vocabulary
      • Deepomatic connectors
        • Set-up
        • Camera Connector
        • Work Order Connector with token
        • Work Order Connector with authentication
      • API integration
        • Authentication
        • Errors
        • API reference
          • Work order management
          • Analysis
            • Guide field workers
            • Perform an analysis
            • Correct an analysis
          • Data retrieval
          • Endpoints' list
      • Batch processing
        • Format
        • Naming conventions
        • Processing
        • Batch status & errors
      • Data export
    • Use the mobile application
      • Configure a mobile application
      • Create & visualize work orders
      • Complete work orders
      • Offline experience
    • Manage your business operations with customisable solutions
      • Roles
      • Alerting
      • Field services
        • Reviewing work orders
        • Exploring work orders
        • Grouping work orders
        • Monitoring assets performance
      • Insights
  • Security
    • Security
    • Data Protection
Powered by GitBook
On this page
  • Python setup
  • DeepoCLI module
  • Upgrading

Was this helpful?

  1. Deepomatic CLI

Installation

Last updated 1 month ago

Was this helpful?

Python setup

The Deepomatic Command-Line Interface requires Python 3.4+. We strongly recommend using a Python version management system.

If you don't have any, you might want to look into and . You will find a detailed tutorial to get started in:

DeepoCLI module

Once you have set up your Python version management system, all you have to do is specify the corresponding version and install the packages. Below you will find two ways to do it using pip or pipenv and pyenv.

# Install python 3.8+ as an example
pyenv install 3.8.12

# Generate a pipenv environment with the installed python version
pipenv --python 3.8

# Install the stable deepomatic-cli release...
pipenv install deepomatic-cli
# ... or the latest release
pipenv install git+https://github.com/deepomatic/deepocli#egg=deepomatic-cli

# Verify the install with pipenv
pipenv run deepo -h

# Spawn a pre-configured shell and verify the install
pipenv shell
deepo -h
# Install the stable deepomatic-cli release...
pip install deepomatic-cli
# ... or the latest release
pip install git+https://github.com/deepomatic/deepocli#egg=deepomatic-cli

# Verify the install
deepo -h

Upgrading

If you want to upgrade your package, simply reinstall with pip or pipenv:

# Upgrade DeepoCLI with pipenv to latest version
pipenv update deepomatic-cli

# Upgrade DeepoCLI with pip to latest version
pip install --upgrade deepomatic-cli

# Check the current version
deepo -v

Pyenv
Pipenv
Why you should use pyenv + Pipenv for your Python projects
The Hitchhiker's Guide to Python: Pipenv & Virtual Environments