Companion is a software that tracks Telegram channels, automatically translates their content (currently into Hebrew), and posts it on a dedicated channel. It features a duplicate scanner to avoid reposting messages and periodically reviews old messages to maintain content uniqueness. Future enhancements include filtering non-informative messages (like ads, propaganda, etc.), tagging messages with relevant labels for subscriber-filtered viewing, and scalability to support multiple languages and channels.
TBD
While Companion is currently tailored for specific use, it has potential applications for users interested in content aggregation and automated translation. For example, it could be adapted for tracking and translating news sources, educational material, or any other content distributed through Telegram channels.
To contribute to Companion, please follow these guidelines:
- Bug Reports: If you find a bug or an issue, please create a 'Bug' label issue with a clear description of the problem and steps to reproduce it. If it is urgent, please tag priority as 'High'.
- Feature Requests: For proposing new features or enhancements, use the 'Feature' label and provide a detailed description of your proposed feature.
- Fork the repository and create your branch from
devel. - Use clear and concise commit messages.
- Make sure your code lints and adheres to the existing code style.
- Update the README.md with details of changes, if applicable.
- Open a Pull Request with the following structure:
- Start the branch name with the label name (e.g.,
bug/fix-duplicate-scanner,feature/add-content-filtering). - Include a comprehensive description of the changes and their impact.
- Reference any related issues or feature requests.
- Start the branch name with the label name (e.g.,
- Documentation: Improvements or additions to documentation should use the 'Documentation' label. This includes updates to README, doc, or inline code comments.
- Refactoring: For code refactoring, use the 'Refactoring' label. Ensure that refactoring does not change the external behavior of the code. start the branch name with the label name (e.g.,
refactoring/fix-duplicate-scanner).
TBD
- ✔️Real-time Tracking: Monitors specified Telegram channels continuously.
- ✔️ Auto Translation: Translates content into Hebrew and posts it on a dedicated channel.
- ✔️Duplicate Scanning: Ensures no duplicate messages are sent; periodically checks and removes duplicates.
- Content Filtering (Planned): To filter out non-informative messages.
- Message Tagging (Planned): For categorizing content, allowing users to choose their interest-specific feeds.
- Scalability (Future Goal): Aiming for a generic build to easily launch channels in other languages.
TBD
Developed by Ofir @eDeveloperOZ. Special thanks to all contributors and supporters.
- Development: Ongoing development and feature enhancement.
- Deployment: Actively deployed and operational.
TBD