Skip to content

Commit

Permalink
added phone number formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
dozy-programmer authored Dec 14, 2022
1 parent 972a101 commit 11625b8
Showing 1 changed file with 25 additions and 14 deletions.
39 changes: 25 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,46 +41,57 @@ from notify_mi import notify
```python
# send only a text message
# include phone_number and phone_provider (see providers list below)
# phone number: "(619) 123-4567", "619-123-4567", or "6191234567" (all acceptable)
notify.send_message("Hello World!",
("gmail", "password"),
phone_number = "your_number",
phone_provider= "your_phone_provider")
("gmail", "password"),
phone_number = "your_number",
phone_provider= "your_phone_provider")
```

###### Text + Email
```python
# send text message + email
# include phone_number, phone_provider (see providers list below), and receiver email
# phone number: "(619) 123-4567", "619-123-4567", or "6191234567" (all acceptable)
notify.send_message("Hello World!",
("gmail", "password"),
phone_number = "your_number",
phone_provider= "your_phone_provider",
send_to = "email@gmail.com")
("gmail", "password"),
phone_number = "your_number",
phone_provider= "your_phone_provider",
send_to = "email@gmail.com")
```

###### Email Only
```python
# send only email
# include receiver email
notify.send_message("Hello World!",
("gmail", "password"),
send_to = "email@gmail.com")
("gmail", "password"),
send_to = "email@gmail.com")
```

###### Optional Parameters
###### Other Parameters
```python
# add a subject line to the message
notify.send_message(subject = "EMERGENCY",
message = "No sweets detected in fridge!")
message = "No sweets detected in fridge!")

# add a file attachment (69 file types supported)
notify.send_message(subject = "I found it",
message = "My dream car",
file_attachment = "/path/car.png")
message = "My dream car",
file_attachment = "/path/car.png")

# run without blocking main thread
notify.send_message("Hello World!",
threaded = True)
threaded = True)

# you can re-order any of the parameters
notify.send_message(threaded = True,
file_attachment = "/path/to/file"
phone_number = "your_number",
phone_provider = "your_phone_provider",
send_to = "email@gmail.com",
sender_credentials = ("gmail", "password"),
message = "No sweets detected in fridge!")
```

###### List of Phone Providers
Expand Down

0 comments on commit 11625b8

Please sign in to comment.