Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/sleepingcat4/push-bot

github push repo
https://github.com/sleepingcat4/push-bot

bot github-api github-config

Last synced: 7 days ago
JSON representation

github push repo

Awesome Lists containing this project

README

        

A Python library that streamlines your repository creation and commits on Github in 2 lines of code.

#### Features
1. Repository creation
2. Commits to existing repository
3. Automatically Merge conflicts resolved
4. High-level wrapper

I've built this library to both explore how Github API works and ease my process to create and commit to my Github account. If you're using VS Code editor, it should already be streamlined but for beginners it is not that straightforward. Besides, resolving merge conflicts is another pain that one-might encounter while doing push through git interface (bash). That is why, I have developed this project.

#### Long-term plan

Developing a total terminal interface through which users can perform almost any operation on Github.

### Prerequisites

1. GitHub account
2. Github Personal Access Token (Fine-grained version)
3. Python 3.8. X installed

#### How to receive Github Access Token?

**Head to Github Settings and access "DEVELOPER SETTINGS"**

A Python library that streamlines your repository creation and commits on Github in 2 lines of code.

#### Features
1. Repository creation
2. Commits to existing repository
3. Automatically Merge conflicts resolved
4. High-level wrapper

I've built this library to both explore how Github API works and ease my process to create and commit to my Github account. If you're using VS Code editor, it should already be streamlined but for beginners it is not that straightforward. Besides, resolving merge conflicts is another pain that one-might encounter while doing push through git interface (bash). That is why, I have developed this project.

#### Long-term plan

Developing a total terminal interface through which users can perform almost any operation on Github.

### Prerequisites

1. GitHub account
2. Github Personal Access Token (Fine-grained version)
3. Python 3.8. X installed

#### How to receive Github Access Token?

**Head to Github Settings and access "DEVELOPER SETTINGS"**

A Python library that streamlines your repository creation and commits on Github in 2 lines of code.

#### Features
1. Repository creation
2. Commits to existing repository
3. Automatically Merge conflicts resolved
4. High-level wrapper

I've built this library to both explore how Github API works and ease my process to create and commit to my Github account. If you're using VS Code editor, it should already be streamlined but for beginners it is not that straightforward. Besides, resolving merge conflicts is another pain that one-might encounter while doing push through git interface (bash). That is why, I have developed this project.

#### Long-term plan

Developing a total terminal interface through which users can perform almost any operation on Github.

### Prerequisites

1. GitHub account
2. Github Personal Access Token (Fine-grained version)
3. Python 3.8. X installed

#### How to receive Github Access Token?

**Head to Github Settings and access "DEVELOPER SETTINGS"**

![image](https://github.com/sleepingcat4/push-bot/assets/81933585/4ffb7fc8-471e-439a-9e6f-4db11510b438)

**Now, head to "FINE-GRAINED ACCESS TOKEN"**

![image](https://github.com/sleepingcat4/push-bot/assets/81933585/dce931b2-38bb-41d4-aae6-1d24837b500c)

**Create a new TOKEN and head-to "REPO ACCESS"**

![image](https://github.com/sleepingcat4/push-bot/assets/81933585/c276c9f4-1073-4cf4-8f72-75d2a3b42e99)

(turn-on All repo access to enable creation of both public and private repo)

Now, select the following permissions:

1. ![image](https://github.com/sleepingcat4/push-bot/assets/81933585/91970dcb-4919-4f01-ae13-3bc2051f4087)

(provide both read and write access)

2. ![image](https://github.com/sleepingcat4/push-bot/assets/81933585/085c0ca3-7109-4c29-bc7a-8364609ccfad)

(provide both read and write access)

3.![image](https://github.com/sleepingcat4/push-bot/assets/81933585/a524d7c8-6199-485c-9447-32f034516611)

(provide read and write access both)

**Now create the access token.** After this when you launch an instance of the provided function, it will ask you for your personal access token to perform the repository creation and commits.

**Note:** Errors might be encountered. Don't bother about them and check the repository in your profile once the commits are done and you should be able to view them. If you encounter any weird errors, raise a Github issue on the repo: https://github.com/sleepingcat4/push-bot/issues

## Privacy and Security

Your personal access token is not stored in our servers. It is locally stored in your RAM and once the function ends running. All the data are cleared.

Pointers?
1. push_bot.py files are not committed.
2. repush_bot.py files are not committed

#### Contribution
It is licensed under MIT. Feel free to contribute as you feel fit or leave suggestions and feedback.