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.4.0.tar.gz (20.5 kB view details)

Uploaded Source

Built Distribution

robocorp_tasks-2.4.0-py3-none-any.whl (25.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: robocorp_tasks-2.4.0.tar.gz
  • Upload date:
  • Size: 20.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.6.1 CPython/3.10.12 Linux/6.2.0-1015-azure

File hashes

Hashes for robocorp_tasks-2.4.0.tar.gz
Algorithm Hash digest
SHA256 181eb4741001dee9caf0d7d4bfe75b414a180baed6eb0411b7407540704558b9
MD5 b0721e06004c7c191accd96615388d28
BLAKE2b-256 fb7b517aae673c4a23b0963103d879b538de0f7013e6df8d9ee5198c81868fbf

See more details on using hashes here.

Provenance

File details

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

File metadata

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

File hashes

Hashes for robocorp_tasks-2.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 756ec4ac32659edc7c748e8b480db533cf1d33b7822837f2064aba739e9c63f6
MD5 d2534912b89a6ab7aa5967ed1c6da018
BLAKE2b-256 bfb690c9a76695dd3f828834a4dee4ef83ae9644bff197f281f54af3f3c52097

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