Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added BulkVS Support #1014

Merged
merged 2 commits into from
Dec 22, 2023
Merged

Added BulkVS Support #1014

merged 2 commits into from
Dec 22, 2023

Conversation

caronc
Copy link
Owner

@caronc caronc commented Dec 16, 2023

Description:

Related issue (if applicable): #1008

Added BulkVS Support to Apprise

Account Setup

Sign up for BulkVS from here. You will be provided to create a user and password to associate with your account. This is all you need to use this through Apprise.

Syntax

Valid syntax is as follows:

  • bulkvs://{user}:{password}@{fromPhoneNo}
  • bulkvs://{user}:{password}@{fromPhoneNo}/{target}

Parameter Breakdown

Variable Required Description
user Yes The username associated with your BulkVS Account.
password Yes The password associated with your BulkVS Account.
to *No A phone number and/or group you wish to send your notification to. You can use comma's to separate multiple entries if you wish. This is an alias to targets.
from *No Specify the phone number you registered with BulkVS you wish the message to be identified as being sent from.
batch No Send multiple specified notifications in a single batch (1 upstream post to the end server). By default this is set to no.

New Service Completion Status

  • apprise/plugins/NotifyBulkVS.py
  • KEYWORDS
    • add new service into this file (alphabetically).
  • README.md
    • add entry for new service to table (as a quick reference)
  • packaging/redhat/python-apprise.spec
    • add new service into the %global common_description

Checklist

  • The code change is tested and works locally.
  • There is no commented out code in this PR.
  • No lint errors (use flake8)
  • 100% test coverage

Testing

Anyone can help test this source code as follows:

# Create a virtual environment to work in as follows:
python3 -m venv apprise

# Change into our new directory
cd apprise

# Activate our virtual environment
source bin/activate

# Install the branch
pip install git+https://github.com/caronc/apprise.git@1008-bulkvs-support

# Test out the changes with the following command:
apprise -t "Test Title" -b "Test Message" \
 "bulkvs://user:pass@fromPhoneNo/toPhoneNo"

@codecov-commenter
Copy link

codecov-commenter commented Dec 16, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (a8e24ea) 99.52% compared to head (123f10a) 99.52%.
Report is 1 commits behind head on master.

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files
@@           Coverage Diff            @@
##           master    #1014    +/-   ##
========================================
  Coverage   99.52%   99.52%            
========================================
  Files         128      130     +2     
  Lines       17126    17295   +169     
  Branches     3502     3527    +25     
========================================
+ Hits        17044    17213   +169     
  Misses         70       70            
  Partials       12       12            

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@caronc
Copy link
Owner Author

caronc commented Dec 16, 2023

@digitalcrisis: have a look at the test case here. I would love for you to test it out for me and confirm if it works. Then BulkVS can be part of the next Apprise release

@caronc caronc merged commit 34a26da into master Dec 22, 2023
12 checks passed
@caronc caronc deleted the 1008-bulkvs-support branch December 29, 2023 18:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants