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

Uploaded Source

Built Distribution

robocorp_tasks-2.3.0-py3-none-any.whl (24.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: robocorp_tasks-2.3.0.tar.gz
  • Upload date:
  • Size: 19.3 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.3.0.tar.gz
Algorithm Hash digest
SHA256 d8bea5ddff8dc0ae948d0ed1c27d38b9cc7c6cc753a6afadfcbe8d0527466ad3
MD5 68911b4d2195515580c522c5e95d7a6a
BLAKE2b-256 35ff3598807470ad507f9b71f5c5cc09d784675c96b81fc95b6b041c3134acd4

See more details on using hashes here.

File details

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

File metadata

  • Download URL: robocorp_tasks-2.3.0-py3-none-any.whl
  • Upload date:
  • Size: 24.6 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.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 7f6e55445438d9334d5caf266b40ef505876524da27a4affe67a1004637bfd33
MD5 714fac7db2f6dee03851f4b50ee77a13
BLAKE2b-256 aaf8d1cac61a1700dbc6a51965e06d3dfaea1f697358722e96c6d83cf428aded

See more details on using hashes here.

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