Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/AmirAref/LinkedinBot

a telegram robot that uploads media from the Linkedin.com posts into telegram.
https://github.com/AmirAref/LinkedinBot

linkedin robot telegram

Last synced: about 2 months ago
JSON representation

a telegram robot that uploads media from the Linkedin.com posts into telegram.

Awesome Lists containing this project

README

        

# Linkedin Bot
a telegram robot that uploads media from the Linkedin.com posts into telegram.

# Installation :
this project has been dockerized and you can easily run and dploy it using docker.

so first of all, clone the repository and go to the repo directory, then do as following :

## Configuartion :
before running the robot, you must to set the environment variables in `.env` file. so to do this you copy the `.env-sample` file to `.env` and fill out with your data.
```bash
cp .env-sample .env
```

## Run (Docker) :
to run the robot using docker, just run the docker compose with following command (you must have installed the [docker](https://docs.docker.com/engine/install/)):
```bash
docker compose up --build -d
```

> [!NOTE]
the `-d` flag will run the container in deattached mode, so if you don't want this, remove it.

## Contributing

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

You can contribute in many ways:
### Report Bugs

Report bugs at [issues page][repo-url]

If you are reporting a bug, please include:
- Any details about your local setup that might be helpful in troubleshooting.
- Detailed steps to reproduce the bug.

### Fix Bugs

Look through the GitHub issues for bugs. Anything tagged with "bug" and "help wanted" is open to whoever wants to implement a fix for it.

### Implement Features
Look through the GitHub issues for features. Anything tagged with "enhancement" and "help wanted" is open to whoever wants to implement it.

### Submit Feedback
The best way to send feedback is to file an issue at [issues page][repo-url].

If you are proposing a new feature:
- Explain in detail how it would work.
- Keep the scope as narrow as possible, to make it easier to implement.
- Remember that this is a volunteer-driven project, and that contributions are welcome :)

## License

Distributed under the GPL-V3 License. See [`LICENSE`](./LICENSE) for more information.

## TODO:
- [x] use poetry
- [x] change the telegram-bot client (python-telegram-bot)
- [x] use pydantic settings (.env)
- [x] add Dockerfile
- [ ] add logs
- [ ] setup linter
- [ ] add tests
- [ ] use connection pooling

[repo-url]: https://github.com/AmirAref/LinkedinBot/issues