Skip to content

Commit 8b9cfa8

Browse files
ArkoniakArkoniak
authored
Merge pull request #9 from Arkoniak/environmental_variables
Environmental variables support
2 parents 7b0c156 + aed8dc7 commit 8b9cfa8

File tree

8 files changed

+189
-69
lines changed

8 files changed

+189
-69
lines changed

‎Project.toml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
name = "Telegram"
22
uuid = "1da6f4ae-116c-4c38-8ee9-19974ff3601d"
33
authors = ["Andrey Oskin"]
4-
version = "1.0.0"
4+
version = "1.1.0"
55

66
[deps]
77
HTTP = "cd3eb016-35fb-5094-929b-558a96fad6f3"

‎README.md

+27-14
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
11
# Telegram
22

3-
[![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://Arkoniak.github.io/Telegram.jl/stable)
4-
[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://Arkoniak.github.io/Telegram.jl/dev)
5-
[![Build Status](https://travis-ci.com/Arkoniak/Telegram.jl.svg?branch=master)](https://travis-ci.com/Arkoniak/Telegram.jl)
6-
[![Coverage](https://codecov.io/gh/Arkoniak/Telegram.jl/branch/master/graph/badge.svg)](https://codecov.io/gh/Arkoniak/Telegram.jl)
3+
| **Documentation** | **Build Status** |
4+
|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|
5+
| [![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://Arkoniak.github.io/Telegram.jl/stable)[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://Arkoniak.github.io/Telegram.jl/dev) | [![Build](https://github.com/Arkoniak/Telegram.jl/workflows/CI/badge.svg)](https://github.com/Arkoniak/Telegram.jl/actions)[![Coverage](https://codecov.io/gh/Arkoniak/Telegram.jl/branch/master/graph/badge.svg)](https://codecov.io/gh/Arkoniak/Telegram.jl) |
76

87
Simple [Telegram Messaging](https://telegram.org/) SDK with logging and bot facilities. Package was built with first-class support of telegram as instant message backend for various notification and reporing systems. So, simpliest way to use this package is by doing something like this
98

@@ -36,7 +35,7 @@ Usage is straightforward, [Telegram Bot API methods](https://core.telegram.org/b
3635

3736
```julia
3837
julia> using Telegram, Telegram.API
39-
julia> token = "HERE SHOULD BE YOUR TOKEN"
38+
julia> token = "YOUR TELEGRAM BOT TOKEN"
4039
julia> TelegramClient(token)
4140

4241
julia> getMe()
@@ -53,13 +52,13 @@ JSON3.Object{Array{UInt8,1},SubArray{UInt64,1,Array{UInt64,1},Tuple{UnitRange{In
5352
Mainly you need to set arguments, but `chat_id` can be set directly in `TelegramClient`
5453

5554
```julia
56-
julia> token = "HERE SHOULD BE YOUR TOKEN"
57-
julia> TelegramClient(token; chat_id = "HERE SHOULD BE CHAT_ID")
55+
julia> token = "YOUR TELEGRAM BOT TOKEN"
56+
julia> TelegramClient(token; chat_id = "YOUR TELEGRAM BOT CHAT_ID")
5857

5958
julia> sendMessage(text = "Hello, world!")
6059
```
6160

62-
You can send files and other `io` objects
61+
You can send files and other `IO` objects
6362

6463
```julia
6564
julia> sendPhoto(photo = open("picture.jpg", "r"))
@@ -72,13 +71,22 @@ julia> sendDocument(document = "hello.txt" => io)
7271

7372
You can use [Telegram.jl](https://github.com/Arkoniak/Telegram.jl) together with [LoggingExtras.jl](https://github.com/oxinabox/LoggingExtras.jl) to create powerful logging with insta messaging in case of critical situations
7473

74+
Put your credentials in `.env`
75+
76+
```
77+
# .env
78+
TELEGRAM_BOT_TOKEN = <YOUR TELEGRAM BOT TOKEN>
79+
TELEGRAM_BOT_CHAT_ID = <YOUR TELEGRAM CHAT ID>
80+
```
81+
7582
```julia
7683
using Telegram
7784
using Logging, LoggingExtras
85+
using ConfigEnv
7886

79-
# considering that token and chat_id variables are set as corresponding
80-
# environment variables
81-
tg = TelegramClient(ENV["TG_TOKEN"], chat_id = ENV["TG_CHAT_ID"])
87+
dotenv() # populate ENV with the data from .env
88+
89+
tg = TelegramClient()
8290
tg_logger = TelegramLogger(tg; async = false)
8391
demux_logger = TeeLogger(
8492
MinLevelLogger(tg_logger, Logging.Error),
@@ -94,12 +102,17 @@ global_logger(demux_logger)
94102

95103
## Bots
96104

97-
You can create bot very easy with the `run_bot` command. Here is for example Echo bot
105+
You can create bot with the `run_bot` command. Here is for example Echo bot
106+
```
107+
# .env
108+
TELEGRAM_BOT_TOKEN = <YOUR TELEGRAM BOT TOKEN>
109+
```
110+
98111
```julia
99112
using Telegram, Telegram.API
113+
using ConfigEnv
100114

101-
token = ENV["TG_TOKEN"]
102-
tg = TelegramClient(token)
115+
dotenv()
103116

104117
# Echo bot
105118
run_bot() do msg

‎docs/src/index.md

+24-1
Original file line numberDiff line numberDiff line change
@@ -5,16 +5,39 @@ CurrentModule = Telegram
55
# Telegram
66
Simple [Telegram Messaging](https://telegram.org/) SDK with logging and bot facilities. Package was built with first-class support of telegram as instant message backend for various notification and reporing systems. So, simpliest way to use this package is by doing something like this
77

8+
Put your credentials in `.env` file
9+
10+
```
11+
# .env
12+
TELEGRAM_BOT_TOKEN = <YOUR TELEGRAM BOT TOKEN>
13+
TELEGRAM_BOT_CHAT_ID = <YOUR TELEGRAM CHAT ID>
14+
```
15+
816
```julia
917
using Telegram, Telegram.API
10-
tg = TelegramClient("YOUR TOKEN", chat_id = "YOUR CHAT_ID")
18+
using ConfigEnv
19+
20+
dotenv()
1121

1222
# Some lengthy calculation
1323
# ...
1424

1525
sendMessage(text = "Calculation complete, result is $result")
1626
```
1727

28+
Of course you can manually provide secrets with the `TelegramClient` constructor
29+
30+
```julia
31+
tg = TelegramClient("your token"; chat_id = "your default chat_id")
32+
sendMessage(text = "Calculation complete")
33+
```
34+
35+
or even
36+
37+
```julia
38+
sendMessage(tg; text = "Calculation complete")
39+
```
40+
1841
## Installation
1942
Package is registered so you can install it in a usual way
2043

‎docs/src/reference.md

+15
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,9 @@ getWebhookInfo
7171
* [`Telegram.setChatAdministratorCustomTitle`](@ref)
7272
* [`Telegram.setChatPermissions`](@ref)
7373
* [`Telegram.exportChatInviteLink`](@ref)
74+
* [`Telegram.createChatInviteLink`](@ref)
75+
* [`Telegram.editChatInviteLink`](@ref)
76+
* [`Telegram.revokeChatInviteLink`](@ref)
7477
* [`Telegram.setChatPhoto`](@ref)
7578
* [`Telegram.deleteChatPhoto`](@ref)
7679
* [`Telegram.setChatTitle`](@ref)
@@ -213,6 +216,18 @@ setChatPermissions
213216
exportChatInviteLink
214217
```
215218

219+
```@docs
220+
createChatInviteLink
221+
```
222+
223+
```@docs
224+
editChatInviteLink
225+
```
226+
227+
```@docs
228+
revokeChatInviteLink
229+
```
230+
216231
```@docs
217232
setChatPhoto
218233
```

‎docs/src/usage.md

+53-26
Original file line numberDiff line numberDiff line change
@@ -5,22 +5,25 @@ CurrentModule = Telegram
55

66
## Setting up telegram token and chat\_id
77

8-
In all examples of this section, it is assumed for simplicity that you set telegram token and chat\_id in `TG_TOKEN` and `TG_CHAT_ID` environment variables correspondingly. So you can run your julia session like this for example
8+
In all examples of this section, it is assumed for simplicity that you set telegram token and chat\_id in `TELEGRAM_BOT_TOKEN` and `TELEGRAM_BOT_CHAT_ID` environment variables correspondingly. Recommended way to do it, by using [ConfigEnv.jl](https://github.com/Arkoniak/ConfigEnv.jl). You should create file `.env`
99

10-
```sh
11-
sh> export TG_TOKEN=123456:ababababababbabababababbababaab
12-
sh> export TG_CHAT_ID=1234567
13-
sh> julia
1410
```
11+
# .env
12+
TELEGRAM_BOT_TOKEN = 123456:ababababababbabababababbababaab
13+
TELEGRAM_BOT_CHAT_ID = 1234567
14+
```
15+
16+
And at the beginning of the application, populate `ENV` with the `dotenv` function. `Telegram.jl` methods will use these variables automatically. Alternatively (but less secure) you can provide `token` and `chat_id` via `TelegramClient` constructor.
1517

1618
In order to get token itself, you should follow [this instruction](https://core.telegram.org/bots#3-how-do-i-create-a-bot). Just talk to `BotFather` and after few simple questions you will receive the token.
1719

1820
Easiest way to obtain chat\_id is through running simple print bot.
1921

2022
```julia
2123
using Telegram
24+
using ConfigEnv
2225

23-
tg = TelegramClient(ENV["TG_TOKEN"])
26+
dotenv()
2427

2528
run_bot() do msg
2629
println(msg)
@@ -48,37 +51,39 @@ After running this script just open chat with your newly created bot and send it
4851
}
4952
```
5053

51-
In this example, field `message.chat.id = 123456789` is necessary `chat_id` which shoud be stored in `TG_CHAT_ID` variable.
54+
In this example, field `message.chat.id = 123456789` is necessary `chat_id` which shoud be stored in `TELEGRAM_BOT_CHAT_ID` variable.
5255

5356
## Initializing `TelegramClient`
5457

55-
To initialize client you need to pass reuired token parameter.
58+
If you set `ENV` variables `TELEGRAM_BOT_TOKEN` and `TELEGRAM_BOT_CHAT_ID`, then telegram client use them to run all commands. Alternatively you can initialize client by passing required token parameter.
5659

5760
```julia
5861
using Telegram
5962

60-
tg = TelegramClient(ENV["TG_TOKEN"])
63+
tg = TelegramClient("TELEGRAM BOT TOKEN")
6164
```
6265

63-
Since [Telegram.jl](https://github.com/Arkoniak/Telegram.jl) was built with the first-class support of the Telegram as a notification system, you can pass `chat_id` variable, which will be used then in every function related to messaging
66+
Since [Telegram.jl](https://github.com/Arkoniak/Telegram.jl) was built with the first-class support of the Telegram as a notification system, you can pass `chat_id` variable, which will be used then by default in every function related to messaging
6467

6568
```julia
6669
using Telegram
6770

68-
tg = TelegramClient(ENV["TG_TOKEN"]; chat_id = ENV["TG_CHAT_ID"])
71+
tg = TelegramClient("TELEGRAM BOT TOKEN"; chat_id = "DEFAULT TELEGRAM CHAT ID")
6972

7073
Telegram.sendMessage(tg, text = "Hello world") # will send "Hello world" message
71-
# to chat defined in ENV["TG_CHAT_ID"] variable
74+
# to chat defined in `tg.chat_id`
7275
```
7376

7477
Also, by default new `TelegramClient` is used globally in all [API Reference](@ref) related functions, so you can run commands like
7578
```julia
7679
using Telegram
80+
using ConfigEnv
81+
82+
dotenv()
7783

78-
tg = TelegramClient(ENV["TG_TOKEN"]; chat_id = ENV["TG_CHAT_ID"])
7984
Telegram.sendMessage(text = "Hello world")
8085
```
81-
which will send "Hello world" message to the chat defined by `ENV["TG_CHAT_ID"]` variable with the bot defined by `ENV["TG_TOKEN"]` variable.
86+
which will send "Hello world" message to the chat defined by `ENV["TELEGRAM_BOT_CHAT_ID"]` variable with the bot defined by `ENV["TELEGRAM_BOT_TOKEN"]` variable.
8287

8388
In order to override this behaviour you can set `use_globally` argument of [`TelegramClient`](@ref) function. To set previously defined client as a global, you should use [`useglobally!`](@ref).
8489

@@ -88,18 +93,20 @@ Due to the rather large number of functions defined in [API Reference](@ref), th
8893

8994
```julia
9095
using Telegram
96+
using ConfigEnv
9197

92-
TelegramClient(ENV["TG_TOKEN"])
98+
dotenv()
9399

94100
Telegram.getMe() # returns information about bot
95101
```
96102

97103
If this is inconvenient for some reason, you can either introduce new and short constant name, like this
98104
```julia
99105
using Telegram
106+
using ConfigEnv
100107
const TG = Telegram
101108

102-
TelegramClient(ENV["TG_TOKEN"])
109+
dotenv()
103110

104111
TG.getMe()
105112
```
@@ -108,8 +115,9 @@ or you can import all telegram Bot API by `using Telegram.API`, in this scenario
108115
```julia
109116
using Telegram
110117
using Telegram.API
118+
using ConfigEnv
111119

112-
TelegramClient(ENV["TG_TOKEN"])
120+
dotenv()
113121

114122
getMe()
115123
```
@@ -122,16 +130,27 @@ If you set telegram client globally with `chat_id` as it is described in previou
122130

123131
```julia
124132
using Telegram, Telegram.API
133+
using ConfigEnv
125134

126-
TelegramClient(ENV["TG_TOKEN"], chat_id = ENV["TG_CHAT_ID"])
135+
dotenv()
127136

128137
sendMessage(text = "Hello world")
129138
```
130139

131140
Of course if you have more than one client or writing a bot which should communicate in multiple chats, you can add this parameters to function calls and they will override default values, for example
132141

142+
```
143+
# .env
144+
TG_TOKEN = 123456:asdasd
145+
TG_TOKEN2 = 546789:zxczxc
146+
TG_CHAT_ID = 1234
147+
```
148+
133149
```julia
134150
using Telegram, Telegram.API
151+
using ConfigEnv
152+
153+
dotenv()
135154

136155
tg1 = TelegramClient(ENV["TG_TOKEN"]; chat_id = ENV["TG_CHAT_ID"])
137156
tg2 = TelegramClient(ENV["TG_TOKEN2"])
@@ -145,8 +164,9 @@ In addition to text messages you can also send any sort of `IO` objects: images,
145164

146165
```julia
147166
using Telegram, Telegram.API
167+
using ConfigEnv
148168

149-
TelegramClient(ENV["TG_TOKEN"], chat_id = ENV["TG_CHAT_ID"])
169+
dotenv()
150170

151171
open("picture.jpg", "r") do io
152172
sendPhoto(photo = io)
@@ -159,8 +179,9 @@ sendPhoto(photo = open("picture.jpg", "r"))
159179
Data sending is not limited by files only, you can send memory objects as well, in this case you should give them name in the form of `Pair`
160180
```julia
161181
using Telegram, Telegram.API
182+
using ConfigEnv
162183

163-
TelegramClient(ENV["TG_TOKEN"], chat_id = ENV["TG_CHAT_ID"])
184+
dotenv()
164185

165186
io = IOBuffer()
166187
print(io, "Hello world!")
@@ -174,8 +195,11 @@ You can also use [Telegram.jl](https://github.com/Arkoniak/Telegram.jl) as a log
174195
```julia
175196
using Telegram
176197
using Logging
198+
using ConfigEnv
177199

178-
tg = TelegramClient(ENV["TG_TOKEN"], chat_id = ENV["TG_CHAT_ID"])
200+
dotenv()
201+
202+
tg = TelegramClient()
179203
tg_logger = TelegramLogger(tg; async = false)
180204

181205
with_logger(tg_logger) do
@@ -187,8 +211,11 @@ But even better it is used together with [LoggingExtras.jl](https://github.com/o
187211
```julia
188212
using Telegram
189213
using Logging, LoggingExtras
214+
using ConfigEnv
215+
216+
dotenv()
190217

191-
tg = TelegramClient(ENV["TG_TOKEN"], chat_id = ENV["TG_CHAT_ID"])
218+
tg = TelegramClient()
192219
tg_logger = TelegramLogger(tg; async = false)
193220
demux_logger = TeeLogger(
194221
MinLevelLogger(tg_logger, Logging.Error),
@@ -234,9 +261,9 @@ With the help of [`run_bot`](@ref) method it's quite simple to set up simple tel
234261

235262
```julia
236263
using Telegram, Telegram.API
264+
using ConfigEnv
237265

238-
token = ENV["TG_TOKEN"]
239-
tg = TelegramClient(token)
266+
dotenv()
240267

241268
# Echo bot
242269
run_bot() do msg
@@ -254,10 +281,10 @@ In addition to previous echo bot, this can do the following
254281

255282
```julia
256283
using Telegram, Telegram.API
284+
using ConfigEnv
257285
using Luxor
258286

259-
token = ENV["TG_TOKEN"]
260-
tg = TelegramClient(token)
287+
dotenv()
261288

262289
"""
263290
draw_turtle(angles::AbstractVector)

0 commit comments

Comments
 (0)