TgBot

Package to implement bots using the Telegram API.

• Usage example
• Installation
  • Automatic installation
  • Manual installation
  • No installation
• Documentation
• Compatibility
• Bugs and requests
• Contributing
• License
• Versioning

Usage example

Check the following example:

This bot is done using the example notebook in this project. Check out that notebook to see how the package is used. If you are only interested in sending a message to an user, you may check a simpler demo instead

Installation

Automatic installation

To install TgBot package evaluate:

Get["https://raw.githubusercontent.com/dih5/TgBot/master/BootstrapInstall.m"]

This method uses MathematicaBootstrapInstaller and will also install ProjectInstaller package if you don't have it already installed.

To load TgBot package evaluate: Needs["TgBot`"].

Manual installation

1. Download latest released TgBot.zip file.

2. Extract downloaded TgBot.zip to any directory which is on the Mathematica $Path, e.g. to install for the current user FileNameJoin[{$UserBaseDirectory,"Applications"}], for all users FileNameJoin[{$BaseDirectory,"Applications"}].

3. To load the package evaluate: Needs["TgBot`"].

No installation

To use package directly from the Web, without installation, evaluate:

Get["https://raw.githubusercontent.com/dih5/TgBot/master/TgBot/TgBot.m"]

Note that this method loads the development version. In this early stage of development the API should be considered unstable, so use at your own risk.

Documentation

The API provided by the package is only documented with usage messages at the moment. Check the first lines of As long as version < 1.0.0 documentation will not be integrated in the Mathematica Documentation Center.

Compatibility

The package is being build with Mathematica version 10.* on Windows|Linux. Some functionality is not available for earlier versions as it depends on some functions which are 10.0+. Partial support is still offered.

Bugs and requests

If you find any bugs or have a feature request you may create an issue on GitHub.

If you are building a bot with this package I'd be glad to hear what you need. I encourage you to ask for it! :)

Contributing

Feel free to fork and send pull requests, all contributions are welcome.

License

This package is released under The MIT License.

Versioning

Releases of this package will be numbered using Semantic Versioning guidelines. Note that while version < 1.0.0 the API is not considered stable. Expect changes.