Revision as of 19:29, 5 October 2023

Python in gnucash has two main aspects:

• Python bindings
• Python shell

Python bindings provide SWIG wrapper functions for some of gnucashs C/C++ API. 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 on the other hand (if enabled) 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. The python bindings can be used in this shell. Be careful: gnucash is not designed to have multiple instances manipulating the data at the same time, reading should be secure.

Note, that there is also a pure python client, piecash, to read and manipulate GnuCash books if saved in of the three SQL backends (sqlite, MySQL, Postgres). Currently (Oct 2020), piecash supports files created up to GnuCash 4.2.

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. Python bindings are not installed on Windows.

See also

• http://article.gmane.org/gmane.comp.gnome.apps.gnucash.devel/23800^[1] "Re: documentation for python bindings" and
• http://article.gmane.org/gmane.comp.gnome.apps.gnucash.devel/23613^[1] "Re: documentation for python bindings" with some pointers on how to look up the existing documentation
• Perhaps it was this thread: documentation for python bindings

Setting things up

Requirements

At Runtime

A Python package must be installed:

Gnucash 5.x

requires Python ≥ 3.6.

GnuCash 3.x

GnuCash's Python bindings has been known to work with CPython version 3.2 or later as of GnuCash 3.0.

At Buildtime

Python Bindings must have been enabled like

cmake -DWITH_PYTHON=ON $OTHER_OPTIONS

If you are bulding GnuCash yourself see CMake#GnuCash Configuration Variables for the OTHER_OPTIONS.

GnuCash 5.4 will use the newest version of Python if there are multiple versions installed. The next release will revert this to prefer the "default" version again (the one executed with "python3" or "python").

Linux

If they were enabled depends on your distribution:

Enabled

In Archlinux they are installed with the gnucash package.

Split in a separate package

You need to install an additional package, usually named python3-gnucash. In Debian based distributions like Ubuntu the easiest way to install the GnuCash Python bindings is via apt-get:

sudo apt-get install python3-gnucash

Flatpak#Known Issues

Interactive Shell

export PYTHONPATH=$PYTHONPATH:/opt/gnc/git/lib/python3.6/site-packages

Note

3.6 should now be 3.6.

This adds the gnucash python bindings to your PYTHONPATH assuming that your gnucash resides in /opt/gnc/git/. Notice that if even if you install to the default CMAKE_INSTALL_PREFIX of /usr/local, the Ubuntu/Debian python is compiled to search for packages in dist-packages and does not find them in site-packages.

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

1. Install GnuCash via MacPorts:

   sudo port install gnucash +python36
   

   Notes

   1. 36 should now be 36.
   2. at the time of writing, only the non-quartz environment is supported.

2. Setup the PYTHONPATH to point to your macports install:

   export PYTHONPATH=$PYTHONPATH:/opt/local/lib/python3.6/site-packages
   

   Note

   3.6 should now be 3.6.

ipython
python /path/to/script

Documentation

As pointed out in the introductory paragraph, the documentation is rather slim at this point in time. Below you will find some sources where you might be able to find what you are looking for. Generally speaking, this is not yet end-user friendly stuff.

Principles

Python bindings provide SWIG wrapper functions for some of gnucashs C/C++ API. They can be used to write standalone scripts to work with the gnucash financial data.

What SWIG does

• see Doxygen - python-bindings (bugfix branch)

How to use the Python bindings

• see Doxygen - python-bindings (bugfix branch)

Further Docs

Doxygen

Have a look at the python-bindings (bugfix branch) or python-bindings (feature branch) in the doxygen API documentation.

• business functions documentation
• Example scripts

Github

The source code of gnucash including the python bindings can be accessed on github.

• Example scripts from the source code.

Inside python

Using python or ipython there is some sparse help:

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)

Mailing list

Again, http://article.gmane.org/gmane.comp.gnome.apps.gnucash.devel/23613^[1] contained some more hopefully useful pointers, but the page is no longer available.

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)

Important

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.