Gengir: Genuine* autocompletion for your PyGObject code!

This tool initially started as a fork of fakegir but now it has been rewritten entirely.

Gengir is a tool to create type definitions for PyGObject. It uses modern python standards and it's easy to use

Features

• Supports PEP 484 type annotations
• Installs typings as a PEP 561 stub in the correct site-packages, even for venv! It creates a package named gi-stubs. Once it's installed, it should be recognized by your IDE and it should provide autocompletion and typing errors.
• Uses Sphinx markup on docstrings
• A GTK version switch It's now chosen automatically based on the module dependencies!
• Multithreading! Not anymore! (but it's fast still)

TODO

• Complete overrides.rs
• Typings for .connect signal names and callbacks

Building & Installing

To build this project, you need to have installed the Rust toolchain, version 1.56.0 or newer.

git clone this repository, and run cargo build --release.

You can run the program once using cargo run --release, but if you use separate venvs for your projects, I'd recommend installing it user wide with cargo install --path .

Usage

The *.gir with the type info files should be included with each GNOME library development package in /usr/share/gir-1.0/.

If you wanted to install stubs for libadwaita, run gengir Adw-1. If you're using a venv you'll need to run gengir inside the venv. With poetry for example just run poetry run gengir Module-x.

USAGE:
    gengir [OPTIONS] [MODULES]...

ARGS:
    <MODULES>...    Modules to generate typing stubs for. (e.g. Adw-1 GtkSource-5)

OPTIONS:
    -h, --help                 Print help information
    -n, --no-docs              Exclude docstrings in the typings
    -o, --out-dir <OUT_DIR>    
    -V, --version              Print version information

Editor support

• VSCode has support for stub packages out of the box.
• Jedi supports it too, so any editor using it should work.

^{*not completely genuine, but it's getting there}