{"id":14064969,"url":"https://github.com/pylipp/financeager-flask","last_synced_at":"2025-04-23T23:48:50.978Z","repository":{"id":38367117,"uuid":"308741202","full_name":"pylipp/financeager-flask","owner":"pylipp","description":"Plugin that enables you to run financeager as a Flask-powered webservice","archived":false,"fork":false,"pushed_at":"2024-02-01T00:30:36.000Z","size":94,"stargazers_count":3,"open_issues_count":9,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-04-23T23:48:45.254Z","etag":null,"topics":["command-line","finances","flask","python","webservice"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/pylipp.png","metadata":{"files":{"readme":"README.md","changelog":"Changelog.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-10-30T20:50:15.000Z","updated_at":"2024-03-13T15:20:13.000Z","dependencies_parsed_at":"2023-02-17T00:05:24.014Z","dependency_job_id":"0b7fc3fe-5ecb-4fa5-9658-420d06f67523","html_url":"https://github.com/pylipp/financeager-flask","commit_stats":{"total_commits":80,"total_committers":4,"mean_commits":20.0,"dds":0.5625,"last_synced_commit":"666ca4fcf73d9f337364088ec72d093b221c3b81"},"previous_names":[],"tags_count":13,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pylipp%2Ffinanceager-flask","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pylipp%2Ffinanceager-flask/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pylipp%2Ffinanceager-flask/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pylipp%2Ffinanceager-flask/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pylipp","download_url":"https://codeload.github.com/pylipp/financeager-flask/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250535107,"owners_count":21446506,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["command-line","finances","flask","python","webservice"],"created_at":"2024-08-13T07:04:12.512Z","updated_at":"2025-04-23T23:48:50.956Z","avatar_url":"https://github.com/pylipp.png","language":"Python","funding_links":[],"categories":["Python"],"sub_categories":[],"readme":"![Build Status](https://github.com/pylipp/financeager-flask/workflows/CI/badge.svg)\n[![Coverage Status](https://coveralls.io/repos/github/pylipp/financeager-flask/badge.svg?branch=master)](https://coveralls.io/github/pylipp/financeager-flask?branch=master)\n\n# financeager-flask\n\nPlugin that enables you to run [financeager](https://github.com/pylipp/financeager) as a Flask-powered webservice!\n\n## Installation\n\n`financeager-flask` requires Python 3.8 or higher.\n\n    pip install financeager-flask\n\nInstallation via [`pipx`](https://pipxproject.github.io/pipx/) is recommended:\n\n    pipx install financeager\n    pipx inject financeager financeager-flask\n\n## Usage\n\nTo run `financeager` as client-server application, start the flask webservice by\n\n    export FLASK_APP=financeager_flask.flask\n    flask run  # --help for more info\n\n\u003e   This does not store data persistently! Specify the environment variable `FINANCEAGER_FLASK_DATA_DIR`.\n\n\u003e   For production use, you should wrap `app = flask.create_app(data_dir=...)` in a WSGI or FCGI (see `examples/` directory).\n\nTo communicate with the webservice, the `financeager` configuration has to be adjusted. Create and open the file `~/.config/financeager/config`. If you're on the machine that runs the webservice, put the lines\n\n    [SERVICE]\n    name = flask\n\nIf you're on an actual remote 'client' machine, put\n\n    [SERVICE]\n    name = flask\n\n    [SERVICE:FLASK]\n    host = https://foo.pythonanywhere.com\n    timeout = 10\n    username = foouser\n    password = S3cr3t\n\nThis specifies the timeout for HTTP requests and username/password for basic auth, if required by the server.\n\nIn any case, you're all set up! The available client CLI commands and options are the same as for the native program.\n\n### Command-line options\n\nThe plugin provides the `fina web-version` command, yielding information about the `financeager` software version installed on the server.\n\n### More Goodies\n\n- `financeager` will store requests if the server is not reachable (the timeout is configurable). The offline backup is restored the next time a connection is established.\n\n## Architecture\n\nThe following diagram sketches the relationship between financeager's modules, and this plugin. See the module docstrings for more information.\n\n          +--------+\n          | plugin |\n          +--------+\n           ¦      ¦\n           V      V\n    +--------+   +-----------+   +---------+\n    | config |--\u003e|    cli    |\u003c-\u003e| offline |\n    +--------+   +-----------+   +---------+\n\n                     ¦   Λ                     +---------+     +---------+\n    [pre-processing] ¦   ¦  [formatting]  \u003c--  | listing | \u003c-- | entries |\n                     V   ¦                     +---------+     +---------+\n\n    +-------------------------------------+\n    |                clients              |\n    +-------------------------------------+\n\n            ¦                     Λ\n            V                     ¦\n\n    +--------------+   |   +--------------+\n    | httprequests |   |   |              |     FRONTEND\n    +--------------+   |   |              |\n    ================   |   |              |    ==========\n    +--------------+   |   | localserver  |\n    |     flask    |   |   |              |     BACKEND\n    +--------------+   |   |              |\n    |  resources   |   |   |              |\n    +--------------+   |   +--------------+\n\n            ¦                     Λ\n            V                     ¦\n    +-------------------------------------+\n    |                server               |\n    +-------------------------------------+\n            ¦                     Λ\n            V                     ¦\n    +-------------------------------------+\n    |                pocket               |\n    +-------------------------------------+\n\n## Known bugs\n\n- see [issues](https://github.com/pylipp/financeager_flask/labels/bug)\n\n## Development\n\n### Set up\n\n    python3 -m venv .venv\n    source .venv/bin/activate\n    make install\n\nYou're all set for hacking!\n\n### Testing\n\nPlease adhere to test-driven development, if possible: When adding a feature, or fixing a bug, try to construct a test first, and subsequently adapt the implementation. Run the tests from the root directory via\n\n    make test\n\nIf you added a non-cosmetic change (i.e. a change in functionality, e.g. a bug fix or a new feature), please update `Changelog.md` accordingly as well. Check this README whether the content is still up to date.\n\n### Releasing\n\n1. Tag the latest commit on master by incrementing the current version accordingly (scheme `v0.major.minor.patch`).\n1. Run `make release`.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpylipp%2Ffinanceager-flask","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpylipp%2Ffinanceager-flask","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpylipp%2Ffinanceager-flask/lists"}