Difference between revisions of "Python Bindings"
m (→Other Linux distributions / GnuCash from source: link IPython, FixMe) |
(t→Other Linux distributions / GnuCash from source: <syntaxhighlight ...>; minor formating) |
||
| Line 30: | Line 30: | ||
=== Other Linux distributions / GnuCash from source === | === Other Linux distributions / GnuCash from source === | ||
;Fix me:Is it still possible since we require Python3? | ;Fix me:Is it still possible since we require Python3? | ||
| − | I use https://en.wikipedia.org/wiki/IPython IPython for an interactive shell. If you prefer something else, let us know if there is any difference. | + | I use https://en.wikipedia.org/wiki/IPython IPython for an interactive shell. If you prefer something else, let us know if there is any difference. <syntaxhighlight lang="sh"> |
| − | + | export PYTHONPATH=$PYTHONPATH:/export/gnucash/lib/python{{Python_Version}}/site-packages | |
| − | + | </syntaxhighlight> | |
| − | |||
This adds the gnucash python bindings to your PYTHONPATH assuming that your gnucash resides in /export/gnucash. | This adds the gnucash python bindings to your PYTHONPATH assuming that your gnucash resides in /export/gnucash. | ||
| − | You can then either start up an interactive python session with ipython or call your script to be executed | + | You can then either start up an interactive python session with ipython or call your script to be executed: <syntaxhighlight lang="sh"> |
| − | + | gnucash-env ipython | |
| − | + | gnucash-env python /path/to/script | |
| − | + | </syntaxhighlight> | |
| − | + | ;Notes | |
| − | + | :To install ipython run <syntaxhighlight lang="sh"> | |
| − | + | sudo pip ipython | |
| + | </syntaxhighlight> | ||
| + | :[https://pypi.org/project/pip/ pip] is the package installer for Python. | ||
== Mac OSX == | == Mac OSX == | ||
Revision as of 21:20, 31 March 2020
Python in gnucash has two main aspects:
- Python bindings
- Python shell
Python bindings provide SWIG wrapper functions for some of gnucashs C/C++ parts. They can be used to write standalone scripts to work with the gnucash financial data. In the source tree they are located at bindings/python.
The python shell opens at gnucash startup and provides a python environment to use with the running gnucash instance. In the source tree it is located at gnucash/python. You use the python bindings in this shell. Be careful: gnucash is not designed to have multiple instances changing the data at the same time, reading should be secure.
Contents
General notice
Python bindings have been added to gnucash in 2008 or earlier. There is still very little documentation and probably few people would know how to use it. While not a manual, this page was created in the hope to provide information for those interested in gnucash and python.
See also
- http://article.gmane.org/gmane.comp.gnome.apps.gnucash.devel/23800 "Re: documentation for python bindings" and
- http://article.gmane.org/gmane.comp.gnome.apps.gnucash.devel/23613 "Re: documentation for python bindings" with some pointers on how to look up the existing documentation
Setting things up
N.B. GnuCash's Python bindings is known to work with CPython version 3.6 or later as of GnuCash 3.0.
Linux
Ubuntu/Debian
The easiest way to install the GnuCash Python bindings is via apt-get:
sudo apt-get install python-gnucash
Other Linux distributions / GnuCash from source
- Fix me
- Is it still possible since we require Python3?
export PYTHONPATH=$PYTHONPATH:/export/gnucash/lib/python{{Python_Version}}/site-packages
This adds the gnucash python bindings to your PYTHONPATH assuming that your gnucash resides in /export/gnucash.
You can then either start up an interactive python session with ipython or call your script to be executed:gnucash-env ipython
gnucash-env python /path/to/script
- Notes
- To install ipython run
sudo pip ipython
- pip is the package installer for Python.
Mac OSX
Install GnuCash via MacPorts
sudo port install gnucash +python36
Note: at the time of writing, only the non-quartz environment is supported.
Setup the PYTHONPATH to point to your macports install
export PYTHONPATH=$PYTHONPATH:/opt/local/lib/python3.6/site-packages
You can then either start up an interactive python session with ipython or call your script to be executed.
ipython python /path/to/script
Documentation
As pointed out in the introductory paragraph, the documentation is rather slim at this point in time. Here are some sources where you might be able to find what you are looking for. Generally speaking, this is not yet end-user friendly stuff.
- Have a look at the page python-bindings in doxygen source-documentation
- scripts from the source code.
- business functions documentation
- inside ipython
- big long list of stuff
- import gnucash.gnucash_core_c
- help(gnucash.gnucash_core_c)
- dir(gnucash.gnucash_core_c)
- higher abstraction level help
- import gnucash.gnucash_core
- import gnucash.gnucash_business
- help(gnucash.gnucash_core)
- help(gnucash.gnucash_business)
- big long list of stuff
Again, http://article.gmane.org/gmane.comp.gnome.apps.gnucash.devel/23613 contains some more hopefully useful pointers.
Example Usages
This section should contain some pointers to scripts using the GnuCash Python bindings:
- https://github.com/hjacobs/gnucash-qif-import --- imports transactions from QIF text files into GnuCash's own file format
- https://github.com/hjacobs/gnucash-stock-portfolio --- script using the GnuCash commodity/price table
- https://github.com/hjacobs/gnucash-fiximports --- tries to fix target accounts using regular expression rules (e.g. PIZZA -> Expenses:Dining)
NB: GnuCash uses DeprecationWarnings, which are disabled by default in Python. Be sure to test periodically with python -Wd or with PYTHONWARNINGS=default set in the environment so that you know about API that will disappear in the next major release. See Development_Process#LibGnuCash API Stability for the policy.
