Task Object Storage package.
Project description
Transaction management for Robot Framework RPA using MongoDB.
Included are two packages: tos and TOSLibrary. The former is the actual task object storage implementation written in pure Python, without any Robot Framework dependencies. TOSLibrary is a Robot Framework keyword library built on top of tos. It is built as a lightweight dynamic proxy library, so all the changes in tos are immediately available in TOSLibrary keywords.
Quickstart guide
Requirements
MongoDB (version >4)
Python (version >3.6)
Installation
Latest stable version from PyPi with pip:
pip install task-object-storage
Latest development version from PyPi:
pip install task-object-storage --pre
Usage
You can import TOSLibrary into your Robot Framework suite with
*** Settings ***
Library TOSLibrary ${db_server}:${db_port} ${db_name}
If you are using authentication in MongoDB, you can pass credentials:
*** Settings ***
Library TOSLibrary ${db_server}:${db_port} ${db_name} ${db_user} ${db_passw}
Now the keywords are callable from Robot Framework.
This library instance can also be accessed inside Python keywords with
from robot.libraries.BuiltIn import BuiltIn
toslib = BuiltIn().get_library_instance("TOSLibrary")
toslib.keyword_name
The keywords can be also called with:
BuiltIn().run_keyword("<keyword name>")
To use task object storage in Python without any Robot Framework dependencies you should use tos package directly:
from tos.task_object_storage import TaskObjectStorage
tos = TaskObjectStorage(
db_server=server,
db_name=db_name,
db_user=db_user,
db_passw=db_passw,
)
If db_user and db_passw are empty strings, TaskObjectStorage will default to using no authentication.
Available keywords
See the full API documentation.
For developers
Package and deploy code with
scripts/build_and_deploy_to_pypi.sh
You can also install the whl package found in the dist directory with
pip install <package-name>.whl
or put inside requirements.txt:
file:C:/path/to/<package-name>.whl # on windows
file:/path/to/<package-name>.whl # on linux
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distribution
Hashes for task_object_storage-1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8d165a847a62395f842f22c71f05e0cc5e643caa127d164ba601b93daa00a735 |
|
MD5 | 2050a58b81a53ceb032a3c9adf64162b |
|
BLAKE2b-256 | f519cf2b269430aed45d6086fb604788ce6ae724825477c60a1936a6801d9970 |