robotframework-extensions-collection 0.10.1
Additional Robot Framework keywords
Requires Python: >=3.0

# Package Description

The **RobotframeworkExtensions** extend the functionality of the Robot
Framework by some useful keywords.

## How to install

The **RobotframeworkExtensions** can be installed in two different ways.

1.  Installation via PyPi (recommended for users)

    ``` 
    pip install RobotframeworkExtensions
    ```

    [RobotframeworkExtensions in
    PyPi](https://pypi.org/project/RobotframeworkExtensions/)

2.  Installation via GitHub (recommended for developers)

    -   Clone the **robotframework-extensions-collection** repository to
        your machine.

        ``` 
        git clone https://github.com/test-fullautomation/robotframework-extensions-collection.git
        ```

        [RobotframeworkExtensions in
        GitHub](https://github.com/test-fullautomation/robotframework-extensions-collection)

    -   Install dependencies

        **RobotframeworkExtensions** requires some additional Python
        libraries. Before you install the cloned repository sources you
        have to install the dependencies manually. The names of all
        related packages you can find in the file `requirements.txt` in
        the repository root folder. Use pip to install them:

        ``` 
        pip install -r ./requirements.txt
        ```

        Additionally install **LaTeX** (recommended: TeX Live). This is
        used to render the documentation.

    -   Configure dependencies

        The installation of **RobotframeworkExtensions** includes to
        generate the documentation in PDF format. This is done by an
        application called **GenPackageDoc**, that is part of the
        installation dependencies (see `requirements.txt`).

        **GenPackageDoc** uses **LaTeX** to generate the documentation
        in PDF format. Therefore **GenPackageDoc** needs to know where
        to find **LaTeX**. This is defined in the **GenPackageDoc**
        configuration file

        ``` 
        packagedoc\packagedoc_config.json
        ```

        Before you start the installation you have to introduce the
        following environment variable, that is used in
        `packagedoc_config.json`:

        -   `GENDOC_LATEXPATH` : path to `pdflatex` executable

    -   Use the following command to install the
        **RobotframeworkExtensions**:

        ``` 
        setup.py install
        ```

## Package Documentation

A detailed documentation of the **RobotframeworkExtensions** can be
found here:

[RobotframeworkExtensions.pdf](https://github.com/test-fullautomation/robotframework-extensions-collection/blob/develop/RobotframeworkExtensions/RobotframeworkExtensions.pdf)

## Feedback

To give us a feedback, you can send an email to [Thomas
Pollerspöck](mailto:Thomas.Pollerspoeck@de.bosch.com)

In case you want to report a bug or request any interesting feature,
please don\'t hesitate to raise a ticket.

## Maintainers

[Holger Queckenstedt](mailto:Holger.Queckenstedt@de.bosch.com)

[Thomas Pollerspöck](mailto:Thomas.Pollerspoeck@de.bosch.com)

## Contributors

[Holger Queckenstedt](mailto:Holger.Queckenstedt@de.bosch.com)

[Thomas Pollerspöck](mailto:Thomas.Pollerspoeck@de.bosch.com)

## License

Copyright 2020-2024 Robert Bosch GmbH

Licensed under the Apache License, Version 2.0 (the \"License\"); you
may not use this file except in compliance with the License. You may
obtain a copy of the License at

> [![License: Apache
> v2](https://img.shields.io/pypi/l/robotframework.svg)](http://www.apache.org/licenses/LICENSE-2.0.html)

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an \"AS IS\" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.