Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
gravures committed Feb 22, 2022
1 parent 289fa33 commit 1508ee1
Showing 1 changed file with 19 additions and 23 deletions.
42 changes: 19 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## About

A set of **gnome-builder** extensions for Python development.
This project is a set of **gnome-builder** extensions targeted at Python development.

* **python-517** (a pep-517 build system)

Expand Down Expand Up @@ -45,41 +45,35 @@ $ meson compile -C build
$ meson install -C build
```

## Install only specific plugins
## Configurable options

You can specify with the -Dplugins configure option a list of plugin(s) to install:
##### Install python requirements for plugins

```
$ meson build --prefix=~/.local -Dplugins=python-linter,python-517-build
```

## Flatpak specific installation

To install plugins for your gnome-builder flatpak's distribution use the -Dflatpak option:
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 -Dflatpak=true
$ meson compile -C build
$ meson install -C build
$ meson build --prefix=~/.local -Dpip=true
```

Note: this will only install certains files to the flatpak container (because thoses files can't be share with user space)
##### Install only specific plugins

You will need to install some python packages in the flatpak container, currently those packages will be *packaging* and *tomli* for the python-517 plugin.

To show Python installed packages in your gnome-builder flatpak's distribution:
You can specify with the **-Dplugins=true** configure option a list of plugin(s) to install:

```
$ pip freeze --path ~/.local/share/flatpak/app/org.gnome.Builder/current/active/files/lib/python3.9/site-packages
$ meson build --prefix=~/.local -Dplugins=python-linter,python-517-build
```

To install or upgrade a specific Python requirement to your gnome-builder flatpak's distribution:
##### Flatpak specific installation

To install plugins for a gnome-builder flatpak's distribution use the **-Dflatpak=true** option:

```
pip install packaging>=20.9 --upgrade -t ~/.local/share/flatpak/app/org.gnome.Builder/current/active/files/lib/python3.9/site-packages
$ meson build --prefix=~/.local -Dflatpak=true -Dpip=true
$ meson compile -C build
$ meson install -C build
```

Note: pip does not permit to uninstall package in a custom directory, if you want to remove thoses packages you should do it manually.
Note: this will only install certains files to the flatpak container (because thoses files can't be share with user space).

## python-517 plugin

Expand All @@ -103,12 +97,14 @@ Provide integration with [PyLint](https://pylint.org/) and [Flake8](https://flak
* pylint >= 2.12
* *or* flake8

None of those linter requirements are mandatory, 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 container, instead just install as usual:
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.

## python-isort plugin

[![Imports: isort](https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336)](https://pycqa.github.io/isort/)
Expand All @@ -119,7 +115,7 @@ Add an entry in the source view menu to sort import statements with [isort](http

- isort >= 5.0

For flatpack you don't have to install isort in the gnome-builder container, instead just install as usual.
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.

## python-symbols plugin

Expand Down

0 comments on commit 1508ee1

Please sign in to comment.