Merge pull request #1 from aps08/dev

Merging Dev to Main

Author: aps08

.github/workflows/actions.yml

@@ -1,42 +1,44 @@
-name: teltotwt
+name: tweegramBot in Action
 
 on:
-  push:
-    branches:
-      - main
+  schedule:
+    - cron: "0 * * * *"
 
 jobs:
   build:
     runs-on: ubuntu-latest
-    timeout-minutes: 4
+    timeout-minutes: 3
     steps:
-      - name: checkout repository
+      - name: Checkout tweegramBot repository
         uses: actions/checkout@v3
 
-      - name: setup python
+      - name: Setting python 3.10
         uses: actions/setup-python@v4
         with:
           python-version: "3.10"
 
-      - name: install python packages
+      - name: Installing python packages
         run: |
           python -m pip install --upgrade pip
           pip install -r requirements.txt
-      - name: execution
+
+      - name: Setting environmental variables and executing
         env:
-          TEL_API_ID: ${{ secrets.TEL_API_ID }}
-          TEL_API_HASH: ${{ secrets.TEL_API_HASH }}
-          TEL_GROUP: ${{ secrets.TEL_GROUP }}
-          TWT_API_KEY: ${{ secrets.TWT_API_KEY }}
-          TWT_API_SECRET: ${{ secrets.TWT_API_SECRET }}
-          TWT_ACCESS_TOKEN: ${{ secrets.TWT_ACCESS_TOKEN }}
-          TWT_ACCESS_TOKEN_SECRET: ${{ secrets.TWT_ACCESS_TOKEN_SECRET }}
+          ENTITY: ${{ secrets.ENTITY }}
+          USERNAME: ${{ secrets.USERNAME }}
+          API_ID: ${{ secrets.API_ID }}
+          API_HASH: ${{ secrets.API_HASH }}
+          BEARER_TOKEN: ${{ secrets.BEARER_TOKEN }}
+          API_KEY: ${{ secrets.API_KEY }}
+          API_SECRET: ${{ secrets.API_SECRET }}
+          ACCESS_TOKEN: ${{ secrets.ACCESS_TOKEN }}
+          ACCESS_TOKEN_SECRET: ${{ secrets.ACCESS_TOKEN_SECRET }}
         run: python src/main.py
 
-      - name: auto commit
+      - name: Auto commit from GitHub Actions
         run: |
-          git config --local user.email "${{ secrets.EMAIL }}"
-          git config --local user.name "aps08"
-          git add .
-          git commit -m "Commit from Github Actions"
-          git push -f origin main
+          git config --local user.email "<GITHUB USERNAME>@users.noreply.github.com"
+          git config --local user.name "<GITHUB USERNAME>"
+          git add -A
+          git commit -m "Automated Commit"
+          git push

.gitignore

@@ -5,7 +5,7 @@ __pycache__/
 
 # C extensions
 *.so
-
+.env
 # Distribution / packaging
 .Python
 build/

.vscode/settings.json

@@ -2,9 +2,9 @@
     "editor.formatOnSave": true,
     "python.formatting.provider": "black",
     "python.formatting.blackArgs": [
-        "--line-length=100"
+        "--line-length=120"
     ],
-    "python.sortImports.args": [
+    "isort.args": [
         "--profile=black"
     ],
     "python.linting.lintOnSave": true,
@@ -13,5 +13,14 @@
         "editor.codeActionsOnSave": {
             "source.organizeImports": true
         }
-    }
+    },
+    "python.testing.unittestArgs": [
+        "-v",
+        "-s",
+        "./tests/",
+        "-p",
+        "*_test.py"
+    ],
+    "python.testing.pytestEnabled": false,
+    "python.testing.unittestEnabled": true
 }

README.md

@@ -1,33 +1,76 @@
-# twigramBot
+![banner](./docs/images/banner.png)
+<p align="center">
+    <img src="https://img.shields.io/badge/Visual_Studio_Code-0078D4?style=for-the-badge&logo=visual%20studio%20code&logoColor=white" alt="vscode">
+    <img src="https://img.shields.io/badge/python-3670A0?style=for-the-badge&logo=python&logoColor=ffdd54" alt="Python">
+    <img src="https://img.shields.io/badge/Twitter-1DA1F2?style=for-the-badge&logo=twitter&logoColor=white" alt="Twitter">
+    <img src="https://img.shields.io/badge/GitHub_Actions-2088FF?style=for-the-badge&logo=github-actions&logoColor=white" alt="GitHub Actions">
+    <img src="https://img.shields.io/badge/Telegram-2CA5E0?style=for-the-badge&logo=telegram&logoColor=white" alt="Telegram">
+</p>
+
+# tweegramBot
+A semi-configured respository, which help you convert your telegram messages to twitter tweets, also retweet the tweets tweeted by specific list of users.
+
+### How to use
+* Fork this repository.
+* Get your API_ID and API_HASH for telegram from [here](https://my.telegram.org/apps).
+* Create a python file in your local, and paste the code given below.
+```python
+from telethon.sync import TelegramClient
+
+client = TelegramClient("tweegramBot", "<API_ID>", "<API_HASH>").start()
+```
+* Give your number and enter code you get on telegram, and that will create a `tweegramBot.session` file. Now place this `tweegramBot.session` file at the root directory of this respository you have forked.
+* It is recommended to not keep the repository in public, with the `*.session`, which was created in the first step, and `*.json` file which will be created when you add users to your list.
+* Get your BEARER_TOKEN, API_KEY, API_SECRET, ACCESS_TOKEN and ACCESS_TOKEN_SECRET for twitter from [here](https://developer.twitter.com/en/portal/dashboard).
+* Set the API secrets you generated in the 2nd and 6th step. A total of 9 secret need to be created, which inclued 7 API secret, USERNAME (*twitter username of the bot*) and ENTITY(*telegram username for the account from which you want to transfer the text to twitter*). Learn how to create repository secrets [here](https://docs.github.com/en/actions/security-guides/encrypted-secrets).
+* Secrets will look like these once setup.
+
+    <img src="./docs/images/secrets.png" width="400" height="400">
+* Once the above steps are completed, this repo will run every hour, and convert all your telegram messages into tweets. 
+* *IMPORTANT*: Make sure to give `read and write permission` to github action for this repository under settings section.
+
+### Command features you can use on telegram
+```
+@add <TWITTER USERNAME> => adds the user to white list.
+@notice <YOUR MESSAGE> => these message will be considered as notice for telegram channel, and not be tweeted.
+@remove <TWITTER USERNAME> => removes the user from white list.
+```
+#### Example
+Command       | Twitter Tweet | Telegram message|
+------------- | ------------- | ---------------|
+@add [aps08__](https://twitter.com/aps08__)  | Thank you for joining us [@aps08__](https://twitter.com/aps08__).You have been added to our list with #JBDS34B34B.  | ❌
+@notice Do not copy paste.  | ❌  | ❌
+@remove aps08__ | ❌ | [aps08__](https://twitter.com/aps08__) tweeter user has been removed.
 
-twigramBot is a mini-script, which helps you to convert telegram messages to twitter tweets.
+### Default configuration and description
+You can see the Default class, which is present inside the [`src/main.py`](https://github.com/aps08/tweegramBot/blob/main/src/main.py). Now you can see what each variables mean in the below table.
 
-## Made with
-![code](https://img.shields.io/badge/Visual_Studio_Code-0078D4?style=for-the-badge&logo=visual%20studio%20code&logoColor=white)
-![Python](https://img.shields.io/badge/python-3670A0?style=for-the-badge&logo=python&logoColor=ffdd54)
-![Twitter](https://img.shields.io/badge/Twitter-1DA1F2?style=for-the-badge&logo=twitter&logoColor=white)
-![Github Action](https://img.shields.io/badge/GitHub_Actions-2088FF?style=for-the-badge&logo=github-actions&logoColor=white)
-![Telegram](https://img.shields.io/badge/Telegram-2CA5E0?style=for-the-badge&logo=telegram&logoColor=white)
 
-## How to use
-1. Get your API secrets for telegram from [here](https://my.telegram.org/apps).
-2. Get your API secrets for twitter from [here](https://developer.twitter.com/en/portal/dashboard).
-3. Fork this reposiotry, and uncomment the commented lines in [this](https://github.com/aps08/teltotwt/blob/main/.github/workfows/actions.yml) file.
-4. Create secrets for this repository. Total 8 secret key-value pair need to be created, 6 of them would be the API secrets, 1 would be telegram group/user name and 1 would be your github email. You can see the keys and instructions in [this](https://github.com/aps08/teltotwt/blob/main/src/config.py) file.
-5. Once the above steps are completed, this repo will run everyday at mid-night, and convert all your telegram messages into tweets.
+Variable       | Description |
+------------- | ------------- |
+USERNAME | username of the twitter account, taken from the environmental variable.
+FIRST_COMMENT | Default `False`, when True and if you pass a link with an image, the image will be tweeted first and the link will be tweeted in the first comment.
+COMMAND_CHECK | Default `True`, when False telegram commands will not work.
+FILE_NAME | Name of the json file, which stores the list of users. Default `member_info`. 
+PREFIX | adds the prefix to the token for easy identification for verification. Default `GTR`.
+RETWEET_TEXT | Retweet quote. We cannot create a rewteet with a quote. Default `Retweeting for better reach. \U0001F603`
+ADD_MESSAGE | Tweet notification message when a user is added to the json file. Default `Thank you for joining us @{}.You have been added to our list with #{}.` Make sure to give 2 `{}` for token and twitter username for tagging, when making changes.
+REMOVE_MESSAGE | Telegram notification when user is removed from the list. Default `{} tweeter user has been removed.` Make sure to pass `{}` in the string to add the username.
+ONLY_IMG_MESSAGE | This Message is required when you are tweeting only an image. Default `Opening \U0001F603`.
+RETWEET_MENTIONED | Default `True`, when False, the retweet functinality will not work.
+SEND_LOG_ON_ERR | Default `True`, when False you won't receive the logs on telegram when there is an error or warning.
 
-## Note
-1. *For this to work, one time manual process is required for telegram, where a session file will be generated.*
-2. *Do not keep the repository in public, with the **session** file*.
+### Bad news
+This project was in progress from past few weeks, so I am releasing it. The decision by twitter and API cost might affect the future of this project. Read [here](https://twitter.com/TwitterDev/status/1621026986784337922?t=AYvhqkC0gqApLV-Qw19hlA&s=19)
 
+<p align="center" style="text"><strong>If you liked something about this repository, do give it a 🌟. It will motivate me come up with more such project. You can reach out to me on my social media given below.</strong></p>
 
-## Where to find me
- 
-<p align="left">
+<p align="center">
  <a href="https://twitter.com/aps08__"><img src="https://img.shields.io/badge/Twitter-1DA1F2?style=for-the-badge&logo=twitter&logoColor=white"></a>
  <a href="https://medium.com/@aps08"><img src="https://img.shields.io/badge/Medium-12100E?style=for-the-badge&logo=medium&logoColor=white"></a>
  <a href="https://www.linkedin.com/in/aps08"><img src="https://img.shields.io/badge/LinkedIn-0077B5?style=for-the-badge&logo=linkedin&logoColor=white"></a>
  <a href="https://github.com/aps08"><img src="https://img.shields.io/badge/GitHub-100000?style=for-the-badge&logo=github&logoColor=white"></a>
  <a href="https://www.youtube.com/channel/UC8biJQnoqm1s2FZ8LK90baA"><img src="https://img.shields.io/badge/YouTube-FF0000?style=for-the-badge&logo=youtube&logoColor=white"></a>
  <a href="mailto:anoopprsingh@gmail.com"><img src="https://img.shields.io/badge/Gmail-D14836?style=for-the-badge&logo=gmail&logoColor=white"></a>
+ <a href="https://t.me/aps080"><img src="https://img.shields.io/badge/Telegram-2CA5E0?style=for-the-badge&logo=telegram&logoColor=white"></a>
 </p>

docs/images/banner.png

@@ -1,2 +1,3 @@
 Telethon==1.25.1
 tweepy==4.10.1
+validator_collection==1.5.0

docs/images/secrets.png

@@ -0,0 +1,3 @@
+from .receiver import receiver
+from .sender import sender
+from .store import store