Installation

Windows

The latest installer and/or executable can be found in the release section.

Launch the program from the start menu.

Note

Multiple instances of the program can be launched to watch different folders for file creations.

From a Terminal

Requirements

  • Windows: A terminal such as Git Bash.

  • All platforms: Download and install the appropriate miniconda package or micromamba package for your platform.

  • All platforms: Check if pip is installed, else conda install pip or mamba install pip.

Installation steps

Open a terminal and execute (Windows: right click on a folder and choose Git Bash from the context menu.)

pip install git+https://github.com/echemdb/autotag-metadata

Windows: Create an icon in the start menu

desktop-app install autotag_metadata

Starting Autotag-Metadata

python -m autotag_metadata

Note

Multiple instances of the program can be launched to observe different folders.

For developers

The project uses pixi to manage all environments and tasks. Its configuration lives in pyproject.toml under [tool.pixi.*] — there is no separate pixi.toml.

Download the repository and set up the environments:

git clone ssh://git@github.com/echemdb/autotag-metadata.git
cd autotag-metadata
pixi install

Run the application:

pixi run autotag-metadata

Common development tasks:

pixi run -e python-312 doctest   # run the test suite
pixi run -e dev lint             # ruff check + format + isort
pixi run -e dev doc              # build the Sphinx documentation
pixi run -e packaging package    # build a PyInstaller binary

In headless environments set QT_QPA_PLATFORM=offscreen before running the tests.

To verify changes made to the documentation refer to the readme in the repository.