Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/k1rsn7/submanager

👨‍💼 SubManager is a cross-platform Python tool for automatically managing GitHub subscriptions
https://github.com/k1rsn7/submanager

bot crontab follow follow-bot followers-and-following-lists following github github-api linux macos python python3 subscribe subscriber subscription subscriptions windows windows-app

Last synced: 4 days ago
JSON representation

👨‍💼 SubManager is a cross-platform Python tool for automatically managing GitHub subscriptions

Host: GitHub
URL: https://github.com/k1rsn7/submanager
Owner: K1rsN7
License: mit
Created: 2024-11-20T11:51:44.000Z (about 1 month ago)
Default Branch: main
Last Pushed: 2024-12-19T12:39:13.000Z (6 days ago)
Last Synced: 2024-12-19T13:43:34.300Z (6 days ago)
Topics: bot, crontab, follow, follow-bot, followers-and-following-lists, following, github, github-api, linux, macos, python, python3, subscribe, subscriber, subscription, subscriptions, windows, windows-app
Language: Python
Homepage:
Size: 302 KB
Stars: 27
Watchers: 2
Forks: 2
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

Subscribe to those who subscribe to you!

Project Description

SubManager is a powerful and user-friendly Python tool designed to automate the management of subscriptions in GitHub. In today's world where audience interaction is key, it's important to keep your subscriptions up to date and keep up to date with changes in your network of contacts.

With SubManager, you can easily subscribe users who have subscribed to you and unsubscribe those who have decided to leave you. This makes it much easier to keep your subscription list up-to-date and allows you to focus on engaging with your audience rather than on mundane tasks.

SubManager's key features include:

Cross-platform: The script is written in Python and runs on a variety of operating systems including Windows, macOS and Linux, making it accessible to a wide audience.

Automatic Subscription: The script automatically subscribes to all users who have subscribed to your account, so you don't miss out on new subscribers.

Automatic unsubscribe: You can easily unsubscribe users who have unsubscribed from you, which helps keep your subscription list clean.

Exceptions to the algorithm: SubManager provides the ability to use two files: ban_list_followers.txt and ban_list_following.txt. These files allow you to add users to a blacklist, excluding them from automatic subscriptions and unsubscriptions, giving you complete control over who you want to leave out of the automated process.

Mutual Subscription Management: SubManager allows you to subscribe to new users, and if they do not reciprocate the subscription within a few days, the script will automatically unsubscribe from them. This feature is designed to help increase your audience by maintaining a list of engaged followers only.

Installation

Clone the repository:

git clone https://github.com/K1rsN7/SubManager.git

cd SubManager

Customize the file main.py:

Open the main.py file and change the following fields to your own:

USERNAME = 'YOUR_USERNAME'

TOKEN = 'YOUR_ACCESS_TOKEN'

PROMOTION_ON = True # True if you want to enable promotion

DAYS_PERIOD = 5 # Period in days of waiting for reciprocity

COUNT_PROMOTION_USERS = 50 # Number of new subscriptions per launch

If you are unsure how to generate a personal access token, please refer to the documentation at Generate Token.md for detailed instructions.

Running the program

To run the program manually, run the following command in the terminal:

python3 main.py

Startup automation

To automate the launch of the SubManager script, follow these steps depending on your operating system:

For Linux or macOS

Open crontab for editing:
```
sudo crontab -e
```

Add the following line to the crontab file:
```
0 */2 * * * /usr/bin/python3 GLOBAL_PATH/main.py
```
Replace GLOBAL_PATH to the full path to the main.py file.

Save your changes and exit the editor.

For Windows

Open the Task Scheduler:
- Press Windows + R, then type taskschd.msc and press Enter.

Create a new task:
- In the right pane, select Create Task.

Configure the general settings:
- Enter the name of the task and a description.
- Make sure that the correct version of Windows is selected in the Configuration for field.

Set Trigger:
- Go to the Triggers tab and click Create.
- Select Schedule.
- Set the frequency to Every 2 hours. To do this, you can select “Daily” and then specify the execution interval.

Customize the action:
- Go to the Actions tab and click Create.
- Select Run Program.
- In the “Program or Script” field, specify the path to the Python interpreter, for example:
```
C:\Path\To\Python\python.exe
```
- In the “Arguments” field, specify the path to your script:
```
C:\Path\To\Your\Script\main.py
```

Save the task:
- Click “OK” to save the task settings.

License

This project is licensed under the MIT License. The MIT License is one of the most popular and simple open source licenses. It allows you to:

Use: You can use the project code in your own projects, whether personal or commercial.

Modify: You can modify the project code, adapting it to your needs or improving functionality.

Distribute: You can distribute the original code or your own modifications, and you must specify the authorship of the original project.

It is important to note that the license does not provide any warranty, and the authors are not responsible for any problems that may occur when using the code.

Contacts

If you have any questions, suggestions or would like to discuss the project, please contact me via Telegram: @K1rsN7.

I'm always happy to hear feedback and suggestions for improving the project. Your support and ideas will help me make SubManager even better!