Back to Daytona

daytona_toolbox_api_client

libs/toolbox-api-client-python/README.md

0.173.019.7 KB
Original Source

daytona_toolbox_api_client

Daytona Daemon Toolbox API for file operations, process execution, git operations, LSP, computer use, and more.

This Python package is automatically generated by the OpenAPI Generator project:

  • API version: v0.0.0-dev
  • Package version: 0.0.0-dev
  • Generator version: 7.12.0
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements

Python 3.8+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

sh
pip install git+https://github.com/daytonaio/daytona.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/daytonaio/daytona.git)

Then import the package:

python
import daytona_toolbox_api_client

Setuptools

Install via Setuptools.

sh
python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

python
import daytona_toolbox_api_client

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

python

import daytona_toolbox_api_client
from daytona_toolbox_api_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:22221
# See configuration.py for a list of all supported configuration parameters.
configuration = daytona_toolbox_api_client.Configuration(
    host = "http://localhost:22221"
)



# Enter a context with an instance of the API client
with daytona_toolbox_api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = daytona_toolbox_api_client.ComputerUseApi(api_client)
    request = daytona_toolbox_api_client.MouseClickRequest() # MouseClickRequest | Mouse click request

    try:
        # Click mouse button
        api_response = api_instance.click(request)
        print("The response of ComputerUseApi->click:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ComputerUseApi->click: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to http://localhost:22221

ClassMethodHTTP requestDescription
ComputerUseApiclickPOST /computeruse/mouse/clickClick mouse button
ComputerUseApidragPOST /computeruse/mouse/dragDrag mouse
ComputerUseApiget_computer_use_statusGET /computeruse/process-statusGet computer use process status
ComputerUseApiget_computer_use_system_statusGET /computeruse/statusGet computer use status
ComputerUseApiget_display_infoGET /computeruse/display/infoGet display information
ComputerUseApiget_mouse_positionGET /computeruse/mouse/positionGet mouse position
ComputerUseApiget_process_errorsGET /computeruse/process/{processName}/errorsGet process errors
ComputerUseApiget_process_logsGET /computeruse/process/{processName}/logsGet process logs
ComputerUseApiget_process_statusGET /computeruse/process/{processName}/statusGet specific process status
ComputerUseApiget_windowsGET /computeruse/display/windowsGet windows information
ComputerUseApimove_mousePOST /computeruse/mouse/moveMove mouse cursor
ComputerUseApipress_hotkeyPOST /computeruse/keyboard/hotkeyPress hotkey
ComputerUseApipress_keyPOST /computeruse/keyboard/keyPress key
ComputerUseApirestart_processPOST /computeruse/process/{processName}/restartRestart specific process
ComputerUseApiscrollPOST /computeruse/mouse/scrollScroll mouse wheel
ComputerUseApistart_computer_usePOST /computeruse/startStart computer use processes
ComputerUseApistop_computer_usePOST /computeruse/stopStop computer use processes
ComputerUseApitake_compressed_region_screenshotGET /computeruse/screenshot/region/compressedTake a compressed region screenshot
ComputerUseApitake_compressed_screenshotGET /computeruse/screenshot/compressedTake a compressed screenshot
ComputerUseApitake_region_screenshotGET /computeruse/screenshot/regionTake a region screenshot
ComputerUseApitake_screenshotGET /computeruse/screenshotTake a screenshot
ComputerUseApitype_textPOST /computeruse/keyboard/typeType text
FileSystemApicreate_folderPOST /files/folderCreate a folder
FileSystemApidelete_fileDELETE /filesDelete a file or directory
FileSystemApidownload_fileGET /files/downloadDownload a file
FileSystemApifind_in_filesGET /files/findFind text in files
FileSystemApiget_file_infoGET /files/infoGet file information
FileSystemApilist_filesGET /filesList files and directories
FileSystemApimove_filePOST /files/moveMove or rename file/directory
FileSystemApireplace_in_filesPOST /files/replaceReplace text in files
FileSystemApisearch_filesGET /files/searchSearch files by pattern
FileSystemApiset_file_permissionsPOST /files/permissionsSet file permissions
FileSystemApiupload_filePOST /files/uploadUpload a file
FileSystemApiupload_filesPOST /files/bulk-uploadUpload multiple files
GitApiadd_filesPOST /git/addAdd files to Git staging
GitApicheckout_branchPOST /git/checkoutCheckout branch or commit
GitApiclone_repositoryPOST /git/cloneClone a Git repository
GitApicommit_changesPOST /git/commitCommit changes
GitApicreate_branchPOST /git/branchesCreate a new branch
GitApidelete_branchDELETE /git/branchesDelete a branch
GitApiget_commit_historyGET /git/historyGet commit history
GitApiget_statusGET /git/statusGet Git status
GitApilist_branchesGET /git/branchesList branches
GitApipull_changesPOST /git/pullPull changes from remote
GitApipush_changesPOST /git/pushPush changes to remote
InfoApiget_project_dirGET /project-dirGet project directory
InfoApiget_versionGET /versionGet version
LspApicompletionsPOST /lsp/completionsGet code completions
LspApidid_closePOST /lsp/did-closeNotify document closed
LspApidid_openPOST /lsp/did-openNotify document opened
LspApidocument_symbolsGET /lsp/document-symbolsGet document symbols
LspApistartPOST /lsp/startStart LSP server
LspApistopPOST /lsp/stopStop LSP server
LspApiworkspace_symbolsGET /lsp/workspaceSymbolsGet workspace symbols
PortApiget_portsGET /portGet active ports
PortApiis_port_in_useGET /port/{port}/in-useCheck if port is in use
ProcessApicreate_sessionPOST /process/sessionCreate a new session
ProcessApidelete_sessionDELETE /process/session/{sessionId}Delete a session
ProcessApiexecute_commandPOST /process/executeExecute a command
ProcessApiget_sessionGET /process/session/{sessionId}Get session details
ProcessApiget_session_commandGET /process/session/{sessionId}/command/{commandId}Get session command details
ProcessApiget_session_command_logsGET /process/session/{sessionId}/command/{commandId}/logsGet session command logs
ProcessApilist_sessionsGET /process/sessionList all sessions
ProcessApisession_execute_commandPOST /process/session/{sessionId}/execExecute command in session

Documentation For Models

<a id="documentation-for-authorization"></a>

Documentation For Authorization

Endpoints do not require authorization.

Author