git-autofetch

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

★ 10 Open GitHub ↗

This is a simple software for fetching new changes to remote repositories automatically.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Git Autofetch
Git Autofetch is a simple software for fetching new changes from a repo to local repositories after a set time interval.

This program is responsible for checking the remote repo for changes and updating the local copy of the repo after a set delay (can be set in configs file later)

## INSTALLATION
1. Clone this repo.
    ![cloning the repo](https://raw.githubusercontent.com/Shreyas-Ashtamkar/git-autofetch/main/project-screenshots/git-clone.png "Cloning Git Repository")

2. cd into the repo
    ![cloning the repo](https://raw.githubusercontent.com/Shreyas-Ashtamkar/git-autofetch/main/project-screenshots/cd-git-autofetch.png "Navigating inside git folder")

3. Run the install.py. This is important to create important files, and create paths dynamically.

run `python3 install.py`
    
    This will create 3 files which are :
    |S. No|File Name|Purpose|
    |:---:|:--------|:------|
    |  1  |`configs.py`|Basic Configuration (Delay)|
    |  2  |`projectlist.py`|To store the list of projects to update (local folder path)|
    |  3  |`autofetch.service`|Service file to tell systemd to run our program in background|

![cloning the repo](https://raw.githubusercontent.com/Shreyas-Ashtamkar/git-autofetch/main/project-screenshots/install.png "installation of git-autofetch")

4. Register Projects in the newly created projectlist.py
 
 For registering projects, you are required to add a [_Project](projects.py) object[1](#one) in the PROJECT_LIST[2](#two), which will be available in projectlist.py file. You can give `name`, `url` and local `path` of the project as parameters to object.

<a name="one">1</a>. To create objects the syntax is as follows :
 ```python
 _Project(
 path=/path/to/git/project/folder
 ),
 ```
 <a name="two">2</a>. Do remember to add a comma after previous _Project object, or else it will give errors. [see below image `line:7`]
 
 
 ![cloning the repo](https://raw.githubusercontent.com/Shreyas-Ashtamkar/git-autofetch/main/project-screenshots/edit-projectlist.png "Defining projects which need to be autofetched.")

5. Move the newly created autofetcher.service to systemd's folders.
    
    run `sudo mv autofetch.service /lib/systemd/system/`
    ![cloning the repo](https://raw.githubusercontent.com/Shreyas-Ashtamkar/git-autofetch/main/project-screenshots/register-service.png "Registering Systemd Service")

6. Reload the systemd daemon.
    
    run `sudo systemctl daemon-reload`
    ![cloning the repo](https://raw.githubusercontent.com/Shreyas-Ashtamkar/git-autofetch/main/project-screenshots/daemon-reload.png "Make Systemd detect new service.")

7. Start the service autofetcher.service

run `sudo systemctl start autofetcher`

![cloning the repo](https://raw.githubusercontent.com/Shreyas-Ashtamkar/git-autofetch/main/project-screenshots/start-service.png "Start autofetching projects in realtime.")

8. Check the status of autofetcher service

run `sudo systemctl status autofetcher`
    ![cloning the repo](https://raw.githubusercontent.com/Shreyas-Ashtamkar/git-autofetch/main/project-screenshots/status-service.png "Check if service is started or are there any erros.")

8. (optional) Enable the service autofetcher

run `sudo systemctl enable autofetcher`

And you will have your autofetcher running.

---
## ISSUES
In case of issues, please open an issue.
Describe the following :
1. Which OS are you trying this on ? (Windows\Mac\Linux)
2. Steps you followed
3. Run step 8, attach screenshot of errors

git-autofetch

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README