Metadata-Version: 2.3
Name: lacuscore
Version: 1.17.2
Summary: Core of Lacus, usable as a module
License: BSD-3-Clause
Author: Raphaël Vinot
Author-email: raphael.vinot@circl.lu
Requires-Python: >=3.9.2,<4.0
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Intended Audience :: Information Technology
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: Telecommunications Industry
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Internet
Classifier: Topic :: Security
Provides-Extra: docs
Requires-Dist: Sphinx (>=8.2.3) ; (python_version >= "3.11") and (extra == "docs")
Requires-Dist: async-timeout (>=5.0.1) ; python_version < "3.11"
Requires-Dist: defang (>=0.5.3)
Requires-Dist: dnspython (>=2.7.0)
Requires-Dist: eval-type-backport (>=0.2.2) ; python_version < "3.10"
Requires-Dist: playwrightcapture[recaptcha] (>=1.32.1)
Requires-Dist: pydantic (>=2.11.7)
Requires-Dist: redis[hiredis] (>=5.3.0,<6.0.0)
Requires-Dist: requests (>=2.32.5)
Requires-Dist: typing-extensions (>=4.12.2,<5.0.0) ; python_version < "3.12"
Requires-Dist: ua-parser[regex] (>=1.0.1)
Project-URL: Documentation, https://lacuscore.readthedocs.io/en/latest/
Project-URL: Issues, https://github.com/ail-project/issues
Project-URL: Repository, https://github.com/ail-project/LacusCore
Description-Content-Type: text/markdown

[![Documentation Status](https://readthedocs.org/projects/lacuscore/badge/?version=latest)](https://lacuscore.readthedocs.io/en/latest/?badge=latest)

# Modulable Lacus

Lacus, but as a simple module.

# Installation

```bash
pip install lacuscore
```

# Design

`LacusCore` is the part taking care of enqueuing and capturing URLs or web enabled documents.
It can be used as a module in your own project, see below for the usage

[Lacus](https://github.com/ail-project/lacus) is the webservice that uses `LacusCore`,
and you can use [Pylacus](https://github.com/ail-project/pylacus) to query it.

The `enqueue`, `get_capture_status`, and `get_capture` methods if `LacusCore` and `PyLacus` have
the same parameters which means you can easily use them interchangeably in your project.


For more information regarding the usage of the module and a few examples, please refer to
[the documentation](https://lacuscore.readthedocs.io/en/latest/)

