Skip to main content

The automation framework for Python

Project description

robocorp-tasks

robocorp-tasks is a Python framework designed to simplify the development of Python automations.

Note: The current version (2.0.0) is now in beta. Semantic versioning is used in the project.

Why

While Python is widely used in the automation world, many solutions end up being ad-hoc, making it difficult to navigate different projects and keep up with the features required for analysing the results of such automations afterwards.

How

robocorp-tasks provides a runner for running tasks that offers logging out of the box for Python code (showing method calls, arguments, assigns, etc) by leveraging robocorp-log, and managing the lifecycle for running such tasks.

Getting started

Replace the code in your __main__ with a method that has the name of your task (which should not have parameters) and decorate it with the @task decorator, like this:

i.e.:

from robocorp.tasks import task

@task
def my_task():
    ...
    
  1. Call your task using the command line below, customizing the directory and task name as needed:
python -m robocorp.tasks run <path/to/file.py or directory> -t <task_name>

Note: if you have only one defined task in your target, the -t <task_name> option is not needed.

Note: the task name is the name of the method decorated with @task.

Note: if a directory is given, only files named *task*.py will be used for collection.

Note: in the current version only one task can be run per invocation. If more than one task is found an error will be given and no tasks will be run.

  1. View the log results in output/log.html.

Guides

API Reference

Information on specific functions or classes: robocorp.tasks

Changelog

A list of releases and corresponding changes can be found in the changelog.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

robocorp_tasks-2.2.0.tar.gz (15.6 kB view details)

Uploaded Source

Built Distribution

robocorp_tasks-2.2.0-py3-none-any.whl (19.9 kB view details)

Uploaded Python 3

File details

Details for the file robocorp_tasks-2.2.0.tar.gz.

File metadata

  • Download URL: robocorp_tasks-2.2.0.tar.gz
  • Upload date:
  • Size: 15.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.6.1 CPython/3.10.12 Linux/5.15.0-1041-azure

File hashes

Hashes for robocorp_tasks-2.2.0.tar.gz
Algorithm Hash digest
SHA256 17ec52f93714482ab45c1e615fa1f591847d85b600b86978f03201414dc86b9c
MD5 eb2e1384b43aa6baa756017accd0c78e
BLAKE2b-256 0264f9b2448a7c3328f913229c3623bd138d80fbf173f5c5fd03f6086cbffd30

See more details on using hashes here.

Provenance

File details

Details for the file robocorp_tasks-2.2.0-py3-none-any.whl.

File metadata

  • Download URL: robocorp_tasks-2.2.0-py3-none-any.whl
  • Upload date:
  • Size: 19.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.6.1 CPython/3.10.12 Linux/5.15.0-1041-azure

File hashes

Hashes for robocorp_tasks-2.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 1078125ffe494f771411057fdf486333736cedeab7d0ae88eefbb1cb9be52d19
MD5 f12c8c329fde9dc21924cd7556f3243d
BLAKE2b-256 e52d11c61eec7cda573638db6cc528d75e539cf7ef8a057c264c821cd017b605

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page