Metadata-Version: 2.4
Name: macro-qgis-core
Version: 0.1.0
Summary: Core library for recording and playing back QGIS macros.
License-Expression: GPL-3.0-only
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Requires-Dist: qgis-plugin-tools>=1.0.0
Requires-Python: >=3.12
Project-URL: homepage, https://macro-qgis-plugin.readthedocs.io
Project-URL: repository, https://github.com/Joonalai/macro-qgis-plugin
Description-Content-Type: text/markdown

# QGIS Macros Core component

[![docs](https://readthedocs.org/projects/macro-qgis-plugin/badge/?version=latest)](https://macro-qgis-plugin.readthedocs.io/en/latest/core/index.html)

This library contains the core macro recording and playback engine.
It can be used independently by other plugins without requiring the
UI plugin with [qgis-plugin-dev-tools](https://github.com/nlsfi/qgis-plugin-dev-tools?tab=readme-ov-file#setup)
`runtime_requires`.

**Package:** `macro-qgis-core` (PyPI) / `qgis_macros` (import)

## Quick start

```python
from qgis_macros.macro_recorder import MacroRecorder
from qgis_macros.macro_player import MacroPlayer

# Record
recorder = MacroRecorder()
recorder.start_recording()
# ... user interactions ...
macro = recorder.stop_recording()
macro.name = "My macro"

# Play back
player = MacroPlayer(playback_speed=1.0)
player.play(macro)
```

## API documentation

See the full [core library documentation](https://macro-qgis-plugin.readthedocs.io/en/latest/core/index.html).
