cantaloupe

Name	cantaloupe JSON
Version	0.1.4 JSON
	download
home_page
Summary	An extensible framework for building browser automations.
upload_time	2023-07-20 17:22:52
maintainer
docs_url	None
author	Lemuel Boyce
requires_python	>=3.10,<4.0
license
keywords
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # Cantaloupe

An extensible framework for building browser automations.

> #### Note: This library is still very much WIP 🧪. This means that breaking changes can be introduced at any point in time.

## Getting Started

### Installation

```bash
$ pip install cantaloupe
```

### Usage

```bash
$ poetry run cantaloupe --help
```

#### Example Workflow

A workflow is a YAML file that describes a series of steps to be executed.
The following example workflow will open Google and type "cantaloupe" into the search bar.

Note: nothing will actually happen until a cantaloupe plugin is installed that implements the logic to translate the
workflow steps into browser actions.
Please see the [Plugins](#plugins) section for more information.

```yaml
name: "Google Search"
steps:
  - action: goto
    config:
      url: "https://google.com"
  - action: type
    config:
      selector: "input[name='q']"
      text: "cantaloupe"
```

### Plugins

* [cantaloupe-playwright](#plugins) coming soon

## Development

### Requirements

* Python >= 3.10
* [Poetry](https://python-poetry.org/docs/#installation)

### Creating plugins

Plugins are created by implementing the cantaloupe hookspec.
See [cantaloupe/hookspecs.py](src/cantaloupe/hookspecs.py) for the hookspecs.


            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "cantaloupe",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.10,<4.0",
    "maintainer_email": "",
    "keywords": "",
    "author": "Lemuel Boyce",
    "author_email": "lemuelboyce@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/4f/ef/935cb8007cd63d9259555140df06a675738bd60ba5009abee52b1a3c6804/cantaloupe-0.1.4.tar.gz",
    "platform": null,
    "description": "# Cantaloupe\n\nAn extensible framework for building browser automations.\n\n> #### Note: This library is still very much WIP \ud83e\uddea. This means that breaking changes can be introduced at any point in time.\n\n## Getting Started\n\n### Installation\n\n```bash\n$ pip install cantaloupe\n```\n\n### Usage\n\n```bash\n$ poetry run cantaloupe --help\n```\n\n#### Example Workflow\n\nA workflow is a YAML file that describes a series of steps to be executed.\nThe following example workflow will open Google and type \"cantaloupe\" into the search bar.\n\nNote: nothing will actually happen until a cantaloupe plugin is installed that implements the logic to translate the\nworkflow steps into browser actions.\nPlease see the [Plugins](#plugins) section for more information.\n\n```yaml\nname: \"Google Search\"\nsteps:\n  - action: goto\n    config:\n      url: \"https://google.com\"\n  - action: type\n    config:\n      selector: \"input[name='q']\"\n      text: \"cantaloupe\"\n```\n\n### Plugins\n\n* [cantaloupe-playwright](#plugins) coming soon\n\n## Development\n\n### Requirements\n\n* Python >= 3.10\n* [Poetry](https://python-poetry.org/docs/#installation)\n\n### Creating plugins\n\nPlugins are created by implementing the cantaloupe hookspec.\nSee [cantaloupe/hookspecs.py](src/cantaloupe/hookspecs.py) for the hookspecs.\n\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "An extensible framework for building browser automations.",
    "version": "0.1.4",
    "project_urls": null,
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "d3ac18866bff72ec389af86eded72984b4f2a423280e0e83ca56d0554ce5de94",
                "md5": "57a85cd624205ac8bf42549b33b98d5a",
                "sha256": "0a055e2799a66edb69b9a44267366cc515d8b93b31ca6e376f7f2cfe3e824eda"
            },
            "downloads": -1,
            "filename": "cantaloupe-0.1.4-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "57a85cd624205ac8bf42549b33b98d5a",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10,<4.0",
            "size": 9937,
            "upload_time": "2023-07-20T17:22:50",
            "upload_time_iso_8601": "2023-07-20T17:22:50.846310Z",
            "url": "https://files.pythonhosted.org/packages/d3/ac/18866bff72ec389af86eded72984b4f2a423280e0e83ca56d0554ce5de94/cantaloupe-0.1.4-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "4fef935cb8007cd63d9259555140df06a675738bd60ba5009abee52b1a3c6804",
                "md5": "156d7c5f0c3574863b181d35a4c2351e",
                "sha256": "afbf6bfd21335feb91371351c8b9b5ce075af11553077bb77f2c0634514941d7"
            },
            "downloads": -1,
            "filename": "cantaloupe-0.1.4.tar.gz",
            "has_sig": false,
            "md5_digest": "156d7c5f0c3574863b181d35a4c2351e",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10,<4.0",
            "size": 7037,
            "upload_time": "2023-07-20T17:22:52",
            "upload_time_iso_8601": "2023-07-20T17:22:52.201291Z",
            "url": "https://files.pythonhosted.org/packages/4f/ef/935cb8007cd63d9259555140df06a675738bd60ba5009abee52b1a3c6804/cantaloupe-0.1.4.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-07-20 17:22:52",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "cantaloupe"
}