https://github.com/johannesjh/favagtk

Desktop application for Fava and Beancount built using Python and GTK. Mirror of https://gitlab.gnome.org/johannesjh/favagtk/
https://github.com/johannesjh/favagtk

beancount desktop-application fava flatpak gnome gtk4 linux python

Last synced: about 1 month ago
JSON representation

Desktop application for Fava and Beancount built using Python and GTK. Mirror of https://gitlab.gnome.org/johannesjh/favagtk/

• Host: GitHub
• URL: https://github.com/johannesjh/favagtk
• Owner: johannesjh
• License: gpl-3.0
• Created: 2021-01-15T20:00:56.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2024-02-06T07:45:24.000Z (10 months ago)
• Last Synced: 2024-05-21T12:48:29.193Z (7 months ago)
• Topics: beancount, desktop-application, fava, flatpak, gnome, gtk4, linux, python
• Language: Python
• Homepage: https://gitlab.gnome.org/johannesjh/favagtk/
• Size: 1.13 MB
• Stars: 25
• Watchers: 5
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG
  • Contributing: CONTRIBUTING.md
  • License: COPYING

Awesome Lists containing this project

• awesome-beancount - Fava-GTK - GNOME Desktop app for Fava and Beancount (User Interfaces)

README

        
# favagtk

[![pipeline status](https://gitlab.gnome.org/johannesjh/favagtk/badges/main/pipeline.svg)](https://gitlab.gnome.org/johannesjh/favagtk/-/commits/main)

[![Latest Development Release](https://gitlab.gnome.org/johannesjh/favagtk/-/badges/release.svg)](https://gitlab.gnome.org/johannesjh/favagtk/-/releases)

Do your finances using fava and beancount.

favagtk makes it easy to use the

[Fava](https://github.com/beancount/fava) and

[Beancount](https://github.com/beancount/beancount)

double-entry bookkeeping software as a GNOME desktop application.

- Easy installation using flatpak.

- Start fava and beancount as you would any other desktop application.

- Built as a GNOME application, using GTK and webkit, packaged using flatpak.

## Screenshot

![Screenshot of favagtk](https://gitlab.gnome.org/johannesjh/favagtk/raw/HEAD/data/screenshots/main.png)

## Installation

favagtk can be installed from [flathub](https://flathub.org/).



System requirements:

- A linux system with [flatpak](https://flatpak.org/) is needed to install and run the flatpak package.

- The app's target platform is the GNOME desktop environment. (Other desktop environments are not targeted, but are likely to work as well).

## Usage

Once installed, you will find an application named "Fava" that can be started in the very same way as any other desktop application, e.g., [using GNOME Shell's activity view](https://help.gnome.org/users/gnome-help/stable/shell-apps-open.html.hi).

The application window that is initially shown prompts to open a beancount file. If you don't have a beancount file yet, you can simply create an empty text file with a `.beancount` extension. Alternatively, it is possible to generate an example beancount file by running [beancount's bean-example command](https://beancount.github.io/docs/tutorial_example.html#generate-an-example-file). Opening the beancount file will display fava's user interface, allowing to view and edit the beancount file.

Note that FavaGTK is only a thin convenience layer around [Fava](https://github.com/beancount/fava) and [Beancount](https://github.com/beancount/beancount). These two programs provide the actual functionality. You can find documentation on how to use these programs for managing your finances on their respective websites.

## Contributing

favagtk is developed in an open-source, community-driven way, as a voluntary effort in the authors' free time.

All contributions are greatly appreciated... pull requests are welcome, and so are bug reports and suggestions for improvement. See [CONTRIBUTING.md](./CONTRIBUTING.md) for details, e.g., how to view debug output when testing and how to setup a development environment.

## License

favagtk is GPL-licensed, see the [COPYING](./COPYING) file.

This program is 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 2

of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful,

but WITHOUT ANY WARRANTY; without even the implied warranty of

MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

GNU General Public License for more details.

Licenses of packages that favagtk depends on:

Most of favagtk's functionality comes from other software packages;

many thanks in particular to the authors of

[Fava](https://github.com/beancount/fava)

and [Beancount](https://github.com/beancount/beancount).

See the `requirements` folder for a list of software packages

that favagtk depends on.