Skip to content

Latest commit

 

History

History
68 lines (49 loc) · 6.84 KB

README.md

File metadata and controls

68 lines (49 loc) · 6.84 KB
Raw

Documentation

Overview

The repository contains the essential parts of the Robocorp Automation Stack for Python:

  • AI Actions and Action Server are described in the main README.
  • Libraries with which the Actions or Tasks are created are also housed and developed under this repository.

Python Libraries

The framework includes Python libraries for configuring package's entry points and controlling features such as logging.
The project also provides an extensive selection of libraries for the most common automation tasks, and anything else can be easily done through what is already available in the Python ecosystem.

You can find the source code and library API documentation in this repository.
We strongly recommend to surf our documentation website.

The robocorp meta-package

robocorp

The easiest way to get started is to install the robocorp meta-package, which includes the framework's core features such as defining Tasks, logging, Work Items, Vault, Assets and other Control Room integrations.

Packages

It's possible to install individual components of the project as separate dependencies.

Name Release in PyPI Description Metapackage
robocorp.actions robocorp-actions Enables creation of AI Actions for Action Server: "Give hands to your AI" -
robocorp.tasks robocorp-tasks Create entrypoints for your automation project. ✅
robocorp.log robocorp-log Configure and control the execution log. ✅
robocorp.workitems robocorp-workitems Interact with Control Room work items; Read data from previous steps, create output data. ✅
robocorp.vault robocorp-vault Store secret values in Control Room and access them during the execution. ✅
robocorp.storage robocorp-storage Store assets in Control Room and manage them during the execution. ✅
robocorp.browser robocorp-browser Automate actions in a browser, powered by Playwright. -
robocorp.windows robocorp-windows Automate Windows desktop applications, powered by uiautomation. -
robocorp.excel robocorp-excel Read and write Excel files directly, with support for both .xlsx and .xls. -

⚠️ Any library that isn't included by default in robocorp (not having the "Metapackage" mark) should be added as a dependency if you wish to make it available in your Python environment.
Do this by listing any of the above as a requirement in your dependencies configuration file:

  • conda.yaml for automation Task Packages
  • package.yaml for automation Action Packages
  • requirements.txt, pyproject.toml, setup.py|cfg etc. for the rest

On versions

We follow SemVer to the best of our ability in library versioning.
This means that libraries with version 0.x.x are in the development phase, so there can be breaking changes on any version update.
We aim to get libraries to version 1 as soon as possible, and after that, following the expected SemVer rules.

A new major version will be published when breaking changes are introduced, therefore the changelog should contain guidance on migration given what was changed.

Be aware that modules starting with an underscore _ are not considered part of the public API and should not be imported directly!
So only the functions/classes reached from the robocorp.<library> namespace should be used. If availability to some other private object is needed, please create a feature request to address it.

Other libraries

  • RPA Framework for Python

    • For additional automation capabilities on the Robocorp platform, please refer to the wide array of libraries and keywords available in rpaframework.
    • PyPI
    • GitHub
    • Documentation

  • 3rd-party libraries

    • We are also collecting pointers to other 3rd-party libraries that we see as commonly used or just beneficial to automation cases.
    • We try to collect the needed links and provide some common code snippets to help you on your way.
    • Documentation