Skip to main content

A small systray app for git annex assistant. The documentation below assumes a centralized setup with a self-hosted server as described here:

https://git-annex.branchable.com/tips/centralized_git_repository_tutorial/on_your_own_server/

Installation

Install from pypi:

$ pip install --user git-annex-gui

Install from gitlab:

$ git clone
$ mkvirtualenv git-annex-gui
$ pip install -e .

Setup and configuration

Ssh configuration

Create ssh keys. Use default file path or type in. Type in pass phrase:

$ ssh-keygen

Add key to ssh-agent. If not default file path used, type in path:

$ ssh-add

Copy public key to remote git annex server:

$ ssh-copy-id user@gitannex.domain.org

Connect to central repo

Connecting to a central repo is more or less equivalent to whats described under the “make a checkout” section here:

https://git-annex.branchable.com/tips/centralized_git_repository_tutorial/on_your_own_server/

The relevant instructions:

$ git clone ssh://user@gitannex.domain.org/~/annex
$ cd annex
$ git annex init

git-annex-gui also assumes there is a ~/.config/git-annex/autostart file listing the repos to be handled by git-annex assistant. For instance, containing something like:

/home/<user>/annex

With this in place, git-annex-gui can be started:

$ git-annex-gui

An icon should appear in the systray. Right the icon, choose start and the assistants’ web page should appear in its own window, where eventually information about sync activities should be shown.

One could possibly also get the appropriate sync setup by running the git-annex assistant and completing the setup wizard there.

ROADMAP

v0.4 - basic features

  • [ ] Implement open annex dir in file explorer. Use xdg-open? - What about BeOS style file navigation in the systray sub-menu?

  • [ ] Implement start of app when desktop starts.

  • [ ] Implement starting of annex daemon when app starts.

v0.5 - desktop integration

  • [ ] Forward notifications to desktop notification system?

v0.6 - in-app documentation/assistant

  • [ ] add in-app documentation to aid in

    • [ ] starting the assistant wizard

    • [ ] setting remote central repo

  • [ ] see what else of existing documentatio can be used in-app

Development

To setup for development, run:

$ pip install -e .[dev]

Otherwise, this project use sykel for release handling etc: https://pypi.org/project/sykel/

Resources

REST interface

Check the routes file in the git-annex repo (under assistant/webapp) to get an understanding about the REST interface.

Misc

Metadata

Release files for git-annex-gui 0.2.8

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for git-annex-gui 0.2.8
File Size Uploaded
git-annex-gui-0.2.8.tar.gz 5.4 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for git-annex-gui 0.2.8
File Interpreter ABI Platform
git_annex_gui-0.2.8-py3-none-any.whl Python 3 none any Details

Total release size: 24.0 kB

Release files / git-annex-gui-0.2.8.tar.gz

Download URL git-annex-gui-0.2.8.tar.gz
Size 5.4 kB
Tags Source
SHA-256 checksum
How to use checksums
7b5fca48155f8b13d8ae1536e93e75ae5a0775e7543205edc4ebee5c405d2ed0
BLAKE2b-256 checksum
How to use checksums
a38675abf115dcc5ef80434a2eb2c19b464ff4fc68320a7caefbf76164b9921e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.4.1 importlib_metadata/3.10.0 pkginfo/1.7.0 requests/2.23.0 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.8.6

Release files / git_annex_gui-0.2.8-py3-none-any.whl

Download URL git_annex_gui-0.2.8-py3-none-any.whl
Size 18.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
8d3d4c346101db8f668e2bd80e03ef0512be2dcda7ef9bc22f72c185b8f944dd
BLAKE2b-256 checksum
How to use checksums
0558c603eee919be8bde3d186a7480eaae6cdf915bd8a51e8df7972f29f856ca
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.4.1 importlib_metadata/3.10.0 pkginfo/1.7.0 requests/2.23.0 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.8.6

Release history Release notifications | RSS feed

This release

0.2.8 This release

2 release files

0.2.7

2 release files

0.2.4

2 release files

0.2.3

2 release files

0.2.2

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page