Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/aashutoshrathi/git-profiler-bot
Telegram bot which fetches GitHub Profiles.
https://github.com/aashutoshrathi/git-profiler-bot
github github-api telegram-bot
Last synced: about 2 months ago
JSON representation
Telegram bot which fetches GitHub Profiles.
- Host: GitHub
- URL: https://github.com/aashutoshrathi/git-profiler-bot
- Owner: aashutoshrathi
- Created: 2018-09-25T07:22:09.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-07-26T04:06:27.000Z (over 1 year ago)
- Last Synced: 2024-10-11T09:15:39.013Z (3 months ago)
- Topics: github, github-api, telegram-bot
- Language: Python
- Homepage: http://t.me/git_profile_bot
- Size: 1.45 MB
- Stars: 26
- Watchers: 3
- Forks: 6
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# git-profiler-bot
[](https://travis-ci.org/aashutoshrathi/git-profiler-bot)
This is a Telegram bot which fetches Profile summary using GitHub API.
Ported to serverless as part of #noserverNovember
## How to use 🤔
- Visit [Git Profile Bot](http://t.me/git_profile_bot)
- Start chatting.
## Usage
### What do I need 🤔
- A AWS key configured locally, see [here](https://serverless.com/framework/docs/providers/aws/guide/credentials/).
- NodeJS.
- A Telegram account.
### Installing
```sh
# Install the Serverless Framework
$ npm install serverless -g
# Install the necessary plugins
$ npm install
# Get a bot from Telegram, sending this message to @BotFather
Go to https://t.me/BotFather
$ /newbot
# Put the token received into a file called serverless.env.yml, like this
$ cat >serverless.env.yml
TELEGRAM_TOKEN:
# Change app and tenant to your ones
$ nano serverless.yml
app:
tenant:
# Export you AWS Keys to your shell
- Get some help from [here](https://serverless.com/framework/docs/providers/aws/guide/credentials/)
# Deploy it!
$ serverless deploy
# With the URL returned in the output, configure the Webhook
$ curl -X POST https://.amazonaws.com/dev/set_webhook
```
### Testing
```sh
# Create a virtual python env
$ python3 -m venv pytest-env
# Activate the virtual env
$ source pytest-env/bin/activate
# Install following modules
$ pip3 install -r requirements.txt
# Run tests
$ pytest
```
## Contributing
Feel free to raise issues and send PRs. :smile:
---
Made with ❤️ by Aashutosh Rathi