Skip to main content

Sync python dicts, strings ad modules to git repository.

Project description

syncgit

Sync python dicts, strings and modules to files in git repository.

NOTE: syncgit calls git using subprocess, setup git so it does not ask for username or password, otherwise you will get a timeout exception.

Installation

python -m pip install syncgit

Documentation

https://syncgit.readthedocs.io/en/latest/

Example

from typing import List

import time

from syncgit import Repo, SyncConfig

# This callback is called when changes are pushed to the repo
def update_callback(repo: Repo, changes: List[SyncConfig]) -> None:
    print(f"Updated to commit {repo.commit_hash}")

    for change in changes:
        print(f"Updated {change.name}")

# Create repo class and import files from repository
rp = Repo("example_repo", "git@github.com:RainingComputers/syncgit-test.git", "main")
rp.set_config([
    SyncConfig("about_alice", "alice.json", "json"),
    SyncConfig("about_bob", "bob.yml"),
    SyncConfig("text", "text_file.txt", "text"),
    SyncConfig("hello_module", "say_hello.py")
])

# Register call back
rp.set_update_callback(update_callback)

# Start sync
rp.start_sync()

# Imported files will be available as attributes on the repo class
# Changes are reflected immediately on these attributes real time
try:
    while True:
        time.sleep(1)
        print(rp.about_alice)
        print(rp.about_bob)
        print(rp.text)
        rp.hello_module.say_hello("Alice")
except KeyboardInterrupt:
    print("Stopping sync")
    rp.stop_sync()

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

syncgit-0.4.4.tar.gz (6.6 kB view hashes)

Uploaded Source

Built Distribution

syncgit-0.4.4-py3-none-any.whl (7.2 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page