pylacus

Name	pylacus JSON
Version	1.12.0 JSON
	download
home_page	https://github.com/ail-project/PyLacus
Summary	Python CLI and module for lacus
upload_time	2024-11-06 12:11:08
maintainer	None
docs_url	None
author	Raphaël Vinot
requires_python	<4.0,>=3.9
license	BSD-3-Clause
keywords
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # Python client and module for Lacus

Use this module to interact with a [Lacus](https://github.com/ail-project/lacus) instance.

## Installation

```bash
pip install pylacus
```

## Usage

### Command line

You can use the `pylacus` command:

```bash
$ pylacus -h
usage: pylacus [-h] --url-instance URL_INSTANCE [--redis_up] {enqueue,status,result} ...

Query a Lacus instance.

positional arguments:
  {enqueue,status,result}
                        Available commands
    enqueue             Enqueue a url for capture
    status              Get status of a capture
    result              Get result of a capture.

options:
  -h, --help            show this help message and exit
  --url-instance URL_INSTANCE
                        URL of the instance.
  --redis_up            Check if redis is up.

```

### Library

See [API Reference](https://pylacus.readthedocs.io/en/latest/api_reference.html)

# Example

## Enqueue

```python
from pylacus import PyLacus

lacus = PyLacus("http://127.0.0.1:7100")
uuid = lacus.enqueue(url='google.fr')
```

## Status of a capture

```python
status = lacus.get_capture_status(uuid)
```

## Capture result

```python
result = lacus.get_capture(uuid)
```


            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/ail-project/PyLacus",
    "name": "pylacus",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<4.0,>=3.9",
    "maintainer_email": null,
    "keywords": null,
    "author": "Rapha\u00ebl Vinot",
    "author_email": "raphael.vinot@circl.lu",
    "download_url": "https://files.pythonhosted.org/packages/14/72/29a788f9d0c15c267396a37ee7aa592f011052f0cf136f32aab321c69878/pylacus-1.12.0.tar.gz",
    "platform": null,
    "description": "# Python client and module for Lacus\n\nUse this module to interact with a [Lacus](https://github.com/ail-project/lacus) instance.\n\n## Installation\n\n```bash\npip install pylacus\n```\n\n## Usage\n\n### Command line\n\nYou can use the `pylacus` command:\n\n```bash\n$ pylacus -h\nusage: pylacus [-h] --url-instance URL_INSTANCE [--redis_up] {enqueue,status,result} ...\n\nQuery a Lacus instance.\n\npositional arguments:\n  {enqueue,status,result}\n                        Available commands\n    enqueue             Enqueue a url for capture\n    status              Get status of a capture\n    result              Get result of a capture.\n\noptions:\n  -h, --help            show this help message and exit\n  --url-instance URL_INSTANCE\n                        URL of the instance.\n  --redis_up            Check if redis is up.\n\n```\n\n### Library\n\nSee [API Reference](https://pylacus.readthedocs.io/en/latest/api_reference.html)\n\n# Example\n\n## Enqueue\n\n```python\nfrom pylacus import PyLacus\n\nlacus = PyLacus(\"http://127.0.0.1:7100\")\nuuid = lacus.enqueue(url='google.fr')\n```\n\n## Status of a capture\n\n```python\nstatus = lacus.get_capture_status(uuid)\n```\n\n## Capture result\n\n```python\nresult = lacus.get_capture(uuid)\n```\n\n",
    "bugtrack_url": null,
    "license": "BSD-3-Clause",
    "summary": "Python CLI and module for lacus",
    "version": "1.12.0",
    "project_urls": {
        "Documentation": "https://pylacus.readthedocs.io/en/latest/index.html",
        "Homepage": "https://github.com/ail-project/PyLacus",
        "Repository": "https://github.com/ail-project/PyLacus"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "3832e17e9c4189b20e63502739454293ef21e3ea5edb8f3f3bd1e3dd863c6521",
                "md5": "9c95db50698d312e1001ef456809df2a",
                "sha256": "d3c189b73e6d06cdb79e6ea536bb951d5b9a13f49099996b0553bedff3cd4dca"
            },
            "downloads": -1,
            "filename": "pylacus-1.12.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "9c95db50698d312e1001ef456809df2a",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4.0,>=3.9",
            "size": 6972,
            "upload_time": "2024-11-06T12:11:06",
            "upload_time_iso_8601": "2024-11-06T12:11:06.766727Z",
            "url": "https://files.pythonhosted.org/packages/38/32/e17e9c4189b20e63502739454293ef21e3ea5edb8f3f3bd1e3dd863c6521/pylacus-1.12.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "147229a788f9d0c15c267396a37ee7aa592f011052f0cf136f32aab321c69878",
                "md5": "397efe442da44de4cd0391c1fe39c285",
                "sha256": "295d68c05f44782daf0d2dd7245bb1d30b9a074d4747872f11744b3fedb3c5c6"
            },
            "downloads": -1,
            "filename": "pylacus-1.12.0.tar.gz",
            "has_sig": false,
            "md5_digest": "397efe442da44de4cd0391c1fe39c285",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4.0,>=3.9",
            "size": 6001,
            "upload_time": "2024-11-06T12:11:08",
            "upload_time_iso_8601": "2024-11-06T12:11:08.631214Z",
            "url": "https://files.pythonhosted.org/packages/14/72/29a788f9d0c15c267396a37ee7aa592f011052f0cf136f32aab321c69878/pylacus-1.12.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-11-06 12:11:08",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "ail-project",
    "github_project": "PyLacus",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "pylacus"
}