rflogs

Name	rflogs JSON
Version	0.22.0 JSON
	download
home_page	None
Summary	A CLI tool for uploading Robot Framework test results to rflogs.io
upload_time	2024-10-15 18:51:32
maintainer	None
docs_url	None
author	Mikko Korpela
requires_python	<4.0,>=3.8
license	Apache-2.0
keywords
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

# rflogs CLI

`rflogs` is a command-line interface tool for uploading and managing Robot Framework test results with the RF Logs service. It provides an easy way to integrate RF Logs with your CI/CD pipelines or local development workflow.

## Installation

Install `rflogs` using pipx (recommended) or pip:

```bash
pipx install rflogs
```

```bash
pip install rflogs
```

## Usage

### Authentication

`rflogs` uses an API key for authentication. Set your RF Logs API key as an environment variable:

```bash
export RFLOGS_API_KEY=your_api_key_here
```

You can add this line to your shell configuration file (e.g., `.bashrc`, `.zshrc`) to make it permanent.
Without a valid API key, rflogs commands will not work. Ensure you have set this environment variable before proceeding with any operations.

After setting up your API key and installing rflogs, you can start using the tool. Here are the main commands:

- `rflogs upload`: Upload test results
- `rflogs list`: List available runs
- `rflogs info`: Get information about a specific run
- `rflogs download`: Download test results
- `rflogs delete`: Delete a specific run

### Uploading Test Results

Upload test results after running your Robot Framework tests:

```bash
rflogs upload [OPTIONS] [OUTPUTDIR]
```

- `OUTPUTDIR`: Optional. Specifies the location of the test output files. Default is the current directory.
- The command does not perform a recursive search.

Options:
- `-o`, `--output`: Specify the XML output file. Default: output.xml
- `-l`, `--log`: Specify the HTML log file. Default: log.html
- `-r`, `--report`: Specify the HTML report file. Default: report.html
- Use `NONE` as the value to skip uploading a specific file type.

This command will:
1. Find relevant test result files in the specified directory
2. Compress output.xml using gzip if it's larger than 1MB
3. Upload all files to the RF Logs server
4. Provide a link to view the uploaded results

Example usage:

```bash
rflogs upload ./results --output custom_output.xml --log custom_log.html --report NONE
```

Example output:

```
$ rflogs upload ./results
Uploading results
output.xml 1.20 MB - compressed to 800.00 KB [OK]
log.html 256.00 KB [OK]
report.html 128.00 KB [OK]
screenshot1.png 45.00 KB [OK]
screenshot2.png 52.00 KB [OK]

Run ID: 1234abcd
Files: 5
Size: 1.28 MB

HTML Files:
Log: https://rflogs.io/files/log.html
Report: https://rflogs.io/files/report.html
Run: https://rflogs.io/run-details.html?runId=1234abcd
```

## Tagging Runs

You can associate tags with your test runs to categorize and filter them. Tags can be specified using the `--tag` or `-t` option when uploading results.

### Tag Format

- **Key-Value Tags:** `key:value`
- **Simple Tags:** `tag`

### Examples

```bash
rflogs upload -t env:production -t browser:chrome -t regression
```

Tags help in organizing and filtering your test runs on the RF Logs platform.

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "rflogs",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<4.0,>=3.8",
    "maintainer_email": null,
    "keywords": null,
    "author": "Mikko Korpela",
    "author_email": "mikko.korpela@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/66/fe/ed3e03b1bdcfab5507d27598174541cd283a81cf6c464f4225da69c92472/rflogs-0.22.0.tar.gz",
    "platform": null,
    "description": "# rflogs CLI\n\n`rflogs` is a command-line interface tool for uploading and managing Robot Framework test results with the RF Logs service. It provides an easy way to integrate RF Logs with your CI/CD pipelines or local development workflow.\n\n## Installation\n\nInstall `rflogs` using pipx (recommended) or pip:\n\n```bash\npipx install rflogs\n```\n\nor\n\n```bash\npip install rflogs\n```\n\n## Usage\n\n### Authentication\n\n`rflogs` uses an API key for authentication. Set your RF Logs API key as an environment variable:\n\n```bash\nexport RFLOGS_API_KEY=your_api_key_here\n```\n\nYou can add this line to your shell configuration file (e.g., `.bashrc`, `.zshrc`) to make it permanent.\nWithout a valid API key, rflogs commands will not work. Ensure you have set this environment variable before proceeding with any operations.\n\nAfter setting up your API key and installing rflogs, you can start using the tool. Here are the main commands:\n\n- `rflogs upload`: Upload test results\n- `rflogs list`: List available runs\n- `rflogs info`: Get information about a specific run\n- `rflogs download`: Download test results\n- `rflogs delete`: Delete a specific run\n\n### Uploading Test Results\n\nUpload test results after running your Robot Framework tests:\n\n```bash\nrflogs upload [OPTIONS] [OUTPUTDIR]\n```\n\n- `OUTPUTDIR`: Optional. Specifies the location of the test output files. Default is the current directory.\n- The command does not perform a recursive search.\n\nOptions:\n- `-o`, `--output`: Specify the XML output file. Default: output.xml\n- `-l`, `--log`: Specify the HTML log file. Default: log.html\n- `-r`, `--report`: Specify the HTML report file. Default: report.html\n- Use `NONE` as the value to skip uploading a specific file type.\n\nThis command will:\n1. Find relevant test result files in the specified directory\n2. Compress output.xml using gzip if it's larger than 1MB\n3. Upload all files to the RF Logs server\n4. Provide a link to view the uploaded results\n\nExample usage:\n\n```bash\nrflogs upload ./results --output custom_output.xml --log custom_log.html --report NONE\n```\n\nExample output:\n\n```\n$ rflogs upload ./results\nUploading results\n  output.xml    1.20 MB - compressed to 800.00 KB [OK]\n  log.html    256.00 KB [OK]\n  report.html 128.00 KB [OK]\n  screenshot1.png 45.00 KB [OK]\n  screenshot2.png 52.00 KB [OK]\n\nRun ID: 1234abcd\nFiles:  5\nSize:   1.28 MB\n\nHTML Files:\n  Log:      https://rflogs.io/files/log.html\n  Report:   https://rflogs.io/files/report.html\n  Run:      https://rflogs.io/run-details.html?runId=1234abcd\n```\n\n## Tagging Runs\n\nYou can associate tags with your test runs to categorize and filter them. Tags can be specified using the `--tag` or `-t` option when uploading results.\n\n### Tag Format\n\n- **Key-Value Tags:** `key:value`\n- **Simple Tags:** `tag`\n\n### Examples\n\n```bash\nrflogs upload -t env:production -t browser:chrome -t regression\n```\n\nTags help in organizing and filtering your test runs on the RF Logs platform.\n\n",
    "bugtrack_url": null,
    "license": "Apache-2.0",
    "summary": "A CLI tool for uploading Robot Framework test results to rflogs.io",
    "version": "0.22.0",
    "project_urls": null,
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "0d28ca0bb44200b69bd4e5778fad90e8dee09e3620da4a28210b5920abc080e0",
                "md5": "f6ba798df6cb777bc07e3d5d14dc0679",
                "sha256": "d230baab65a72c96235d9a9ef1679f58eb30922ff8035b0cc30fe29ab352a201"
            },
            "downloads": -1,
            "filename": "rflogs-0.22.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "f6ba798df6cb777bc07e3d5d14dc0679",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4.0,>=3.8",
            "size": 11318,
            "upload_time": "2024-10-15T18:51:30",
            "upload_time_iso_8601": "2024-10-15T18:51:30.771536Z",
            "url": "https://files.pythonhosted.org/packages/0d/28/ca0bb44200b69bd4e5778fad90e8dee09e3620da4a28210b5920abc080e0/rflogs-0.22.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "66feed3e03b1bdcfab5507d27598174541cd283a81cf6c464f4225da69c92472",
                "md5": "59006801bca234d0465acf56f369b8ca",
                "sha256": "6b0881cc0374f04a8ce702f6a0d40ee6803d9542948be2c9cc1d285c5c143789"
            },
            "downloads": -1,
            "filename": "rflogs-0.22.0.tar.gz",
            "has_sig": false,
            "md5_digest": "59006801bca234d0465acf56f369b8ca",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4.0,>=3.8",
            "size": 10367,
            "upload_time": "2024-10-15T18:51:32",
            "upload_time_iso_8601": "2024-10-15T18:51:32.366835Z",
            "url": "https://files.pythonhosted.org/packages/66/fe/ed3e03b1bdcfab5507d27598174541cd283a81cf6c464f4225da69c92472/rflogs-0.22.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-10-15 18:51:32",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "rflogs"
}

Mikko Korpela