This project is a set of gnome-builder extensions targeted at Python development.
-
python-517 (a pep-517 build system)
-
python-linter (integration of flake8 and pylint)
-
python-isort (sort import statements)
-
python-symbol (meaningfull symbol tree view)
After installation a new page in the preferences panel will be available with sections for the different plugins.
- gnome-builder >= 3.32
- Python >=3.6
This project uses the meson build system. Run the following commands to clone this project and initialize the build:
$ git clone https://github.com/gravures/gnome-builder-python-plugins.git
$ cd gnome-builder-python-plugins
$ meson build --prefix=~/.local
Note: build is the build output directory and can be changed to any other
directory name.
To build or re-build after code-changes, run:
$ meson --reconfigure --prefix=~/.local build
To install, run:
$ meson compile -C build
$ meson install -C build
Use the -Dpip=true option to install python requirements. If you have a gnome-builder not running in isolation (not a flatpak), this will pip install all the requirements with the --user option in your personnal site-packages. Otherwise if you use a flapak distribution, requirements that need to be imported by plugins will install in the gnome-builder flatpak, and ones that will be run as command will install in your personnal site-packages.
$ meson build --prefix=~/.local -Dpip=true
You can specify with the -Dplugins=true configure option a list of plugin(s) to install:
$ meson build --prefix=~/.local -Dplugins=python-linter,python-517-build
To install plugins for a gnome-builder flatpak's distribution use the -Dflatpak=true option:
$ meson build --prefix=~/.local -Dflatpak=true -Dpip=true
$ meson compile -C build
$ meson install -C build
Note: this will only install certains files to the flatpak container (because thoses files can't be share with user space).
Provide a modern python build system defined through the PEP 517 (a build-system independent format for source trees). This is also well known as the pyproject.toml interface. Currently the only supported build backend is the Pypa build backend.
- setuptools >= 42.0
- build >= 0.1.0
- pip >= 20.3
- packaging >= 20.9
- tomli >= 1.2
Provide integration with PyLint and Flake8 Python linters.
- pylint >= 2.12
- or flake8
None of those linter requirements are mandatory (they wil not be installed by the -Dpip=true option), the plugin will check at runtime witch linter is available. You can select the linter to use in the preferences window. You can even install a new linter when builder is running (you have to close and open again the preferences window to show the new linter). For flatpack you don't have to install any linter in the gnome-builder flatpak, instead just install as usual your prefered linter:
$ pip install flake8 --user
Of course you could install any linter's extensions you want. There is no special configurations in the preferences ui for the linters, consult linter's documentation to learn how to customize behaviours.
Add an entry in the source view menu to sort import statements with isort.
- isort >= 5.0
For flatpack you don't have to install isort in the gnome-builder container, instead just install as usual or use the -Dpip=true option.
Give to gnome-builder editor a meaningfull symbol code tree view. Symbols shown in the list view can be adjusted in preferences panel (show imported modules, show variables at modules level or at class level).
gnome-builder python plugins are free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version.