https://github.com/archivy/archivy-git

Archivy extension to add version control to your knowledge base.
https://github.com/archivy/archivy-git

Last synced: about 2 months ago
JSON representation

Archivy extension to add version control to your knowledge base.

• Host: GitHub
• URL: https://github.com/archivy/archivy-git
• Owner: archivy
• Created: 2020-12-21T22:39:57.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2022-01-18T22:49:30.000Z (over 2 years ago)
• Last Synced: 2024-07-17T21:04:27.399Z (2 months ago)
• Language: Python
• Size: 11.7 KB
• Stars: 12
• Watchers: 5
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
`archivy-git` allows users to use version control with their [Archivy](https://archivy.github.io) instance.

It is an official extension developed by [archivy](https://github.com/archivy/)

## Install

You need to have `archivy` already installed.

Run `pip install archivy_git`.

## Usage

```bash

$ archivy git --help

Usage: archivy git [OPTIONS] COMMAND [ARGS]...

Options:

  --help  Show this message and exit.

Commands:

  pull   Pulls changes from remote to local repository.

  push   Pushes local changes to the remote.

  setup  Creates and sets up git repository.

```

Use the `setup` command to create and configure a new, empty git repository. If you connect your repo to a private GitHub repository, keep in mind you can no longer login with your username / password and you need to create a [personal access token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).

You can also just clone an existing repository, in which case you don't need to run setup

Then you can periodically `pull/push` through the command line. **The plugin is not yet compatible with the web interface.** 

However, it can also be useful to automatically push changes when you make an edit or create a new note / bookmark. To do this, you'll need to configure a [Hook](https://archivy.github.io/reference/hooks).

These are events that Archivy exposes and that you can configure.

To do so, run `archivy hooks` to edit the file and create it if it doesn't exist.

We can use the `sync_dataobj` `archivy-git` method to sync changes when they are made.

Example:

```python

from archivy.config import BaseHooks

class Hooks(BaseHooks):

	def on_edit(self, dataobj):

		from archivy_git import sync_dataobj

		sync_dataobj(dataobj) # syncs / pushes changes

	def on_dataobj_create(self, dataobj):

		# the same for creation

		from archivy_git import sync_dataobj

		sync_dataobj(dataobj)

```