dissec 0.1

dissec is a Python module used for implementing string dissection patterns, compatible with Elasticsearch‘s Dissect processor.

The project is present at the following locations:

• Official repository on Gitlab;

• Official project on PyPI.

The project’s code and documentation contents are licensed under CeCILL-C as distributed by the CEA, CNRS and Inria on cecill.info.

This documentation is organized using Diátaxis’ structure.

How-to guides

These sections provide guides, i.e. recipes, targeted towards various actors. They guide you through the steps involved in addressing key problems and use-cases.

• General guides
  • Installing dissec
    • pip (generic)
  • Reporting a bug or vulnerability
    • Writing a bug or vulnerability report
    • Sending your bug or vulnerability report
• Developer guides
  • Parsing dissect patterns
  • Using dissect patterns in Pydantic models

Discussion topics

These sections discuss key topics and concepts at a fairly high level, and provide useful background information and explanation.

• Concepts
  • Dissect patterns

References

These sections provide technical reference for APIs and other aspects of dissec’s machinery. They go into detail, and therefore, assume you have a basic understanding of key concepts.

• Code reference
  • dissec – main namespace for the project
    • dissec.errors – Error definitions
    • dissec.patterns – Pattern definitions
    • dissec.utils – General utilities