Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 5 additions & 6 deletions README.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -22,14 +22,13 @@ module more "Pythonic".
To write a plugin, inherit from the `geany.Plugin` class and implmenent the
required members (see `geany/plugin.py` documentation comments). Then put the
plugin in a searched plugin path. Currently two locations are search for
plugins. The first is `PREFIX/share/geany/geanypy/plugins` and the recommended
plugins. The first is `PREFIX/lib/geany` and the recommended
location is under your personal Geany directory (usually
`~/.config/geany/plugins/geanypy/plugins`). To load or unload plugins, click
the Python Plugin Manager item under the Tools menu which will appear when you
activate GeanyPy through Geany's regular plugin manager.
`~/.config/geany/plugins`). To load or unload plugins, use Geany's regular Plugin
Manager. Python plugins appear there once GeanyPy is activated.

When GeanyPy plugin is loaded, it will add a new tab to the notebook in the
message window area that contains an interactive Python shell with the `geany`
When the Python Console plugin is enabled, it will add a new tab to the notebook in
the message window area that contains an interactive Python shell with the `geany`
module pre-imported. You can tinker around with API with this console, for
example:

Expand Down
40 changes: 18 additions & 22 deletions docs/source/starting.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,34 +7,30 @@ GeanyPy, it's important to note how it works and some features it provides.
What the heck is GeanyPy, really?
=================================

GeanyPy is "just another Geany plugin", really. Geany sees GeanyPy as any
other `plugin <http://www.geany.org/manual/current/index.html#plugins>`_, so
to activate GeanyPy, use Geany's
GeanyPy is a proxy plugin. Geany initially sees GeanyPy as any other
`plugin <http://www.geany.org/manual/current/index.html#plugins>`_, but
GeanyPy registers some additional stuff that enables Geany to load python plugins
through GeanyPy. So to activate, use Geany's
`Plugin Manager <http://www.geany.org/manual/current/index.html#plugin-manager>`_
under the Tools menu as you would for any other plugin.

Once the GeanyPy plugin has been activated, a few elements are added to Geany's
user interface as described below.
Once the GeanyPy plugin has been activated, Geany should rescan the plugin
directories and pick those up that are supported through GeanyPy. It'll integrate
the python plugins into the Plugin Manager in an additional hierarchy level below
GeanyPy.

Python Plugin Manager
=====================
* [ ] Geany plugin 1
* [x] GeanyPy
* [ ] Python plugin 1
* [x] Python plugin 2
* [ ] Python plugin 3
* [ ] Geany plugin 3

Under the Tools menu, you will find the Python Plugin Manager, which is meant
to be similar to Geany's own Plugin Manager. This is where you will activate
any plugins written in Python.
Remember that Geany looks in three places for plugins:

The Python Plugin Manager looks in exactly two places for plugins:

1. For system-wide plugins, it will search in PREFIX/share/geany/geanypy/plugins.
2. In Geany's config directory under your home directory, typically ~/.config/geany/plugins/geanypy/plugins.

Where `PREFIX` is the prefix used at configure time with Geany/GeanyPy (see
the previous section, Installation). Both of these paths may vary depending on
your platform, but for most \*nix systems, the above paths should hold true.

Any plugins which follow the proper interface found in either of those two
directories will be listed in the Python Plugin Manager and you will be able
to activate and deactivate them there.
1. For system-wide plugins, it will search in (usually) /usr/share/geany or /usr/local/share/geany.
2. In Geany's config directory under your home directory, typically ~/.config/geany/plugins.
3. A user-configurable plugin directory (useful during plugin development).

Python Console
==============
Expand Down
2 changes: 0 additions & 2 deletions geany/Makefile.am
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
geanypy_sources = __init__.py \
console.py \
manager.py \
loader.py \
logger.py \
plugin.py \
signalmanager.py
Expand Down
4 changes: 2 additions & 2 deletions geany/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,8 @@
import encoding
import filetypes
import highlighting
import loader
import glog
import main
import manager
import msgwindow
import navqueue
import prefs
Expand All @@ -27,6 +25,7 @@
import search
import templates
import ui_utils
import keybindings

from app import App
from prefs import Prefs, ToolPrefs
Expand All @@ -45,6 +44,7 @@
"interface_prefs",
"app",
"glog",
"keybindings",
"general_prefs",
"search_prefs",
"template_prefs",
Expand Down
172 changes: 0 additions & 172 deletions geany/loader.py

This file was deleted.

Loading