Metadata-Version: 2.1
Name: exp-notifier
Version: 0.0.4
Summary: Notifcation from experiments to you devices (via slack)
Home-page: https://github.com/oplatek/exp-notifier
Author: Ondrej Platek
Author-email: ondrej.platek@seznam.cz
License: Apache-2.0 License
Description: # Experiment Notifier
        
        ## Usage 
        
        ### Slack notifications
        The experiment notifier assumes that for sending messages you have `SLACK_BOT_TOKEN` either in:
        - current working directory stored in `./.slack_bot_token` file
        - or at your home dir in the file `$HOME/.slack_bot_token`
        - or in `SLACK_BOT_TOKEN` variable
        
        Note, that storing the token in a file with `600` permissions is the recommended method.
        
        #### CLI usage
        ```
        $ sleep 9999; ntf --channel exp-notifier --text "Done sleeping $? Your long running task just finished!"
        ```
        <img src="https://raw.githubusercontent.com/oplatek/exp-notifier/main/docs/slack_ntf_finished.png">
        
        #### Python usage
        ```
        from notifier.context import SlackMessage
        
        with SlackMessage(channel='exp-notifier') as sm:
          sm.write('test from python')
        ```
        
        ## Installation
        - [Setup and install the app](https://api.slack.com/start/building/bolt-python#start)
          - Set permissions/scopes to `chat:write`, `identityb:basic`,`groups:write`, `im:write`
          - Remember `SLACK_BOT_TOKEN`
        - [Setup Socket mode](https://api.slack.com/apis/connections/socket#sdks). 
          - Remember `SLACK_APP_TOKEN` 
        - Add your app `APPNAME e.g. exp-notifier`  to slack channel `#CHANNEL e.g. #exp-notifier`
        - **Install the client library and the `ntf` python script `pip install exp-notifier`**
        
        ## Development
        
        ```
        # change to git root directory of source code
        pip install -e '.[dev]'
        ```
        
        ## Features
        - [x] Sending text message to a channel under the app name.
        - [ ] Sending a text instant message (IM).
        - [ ] Attach file (log file) to a message
        - [ ] Attach a picture / sound file to be played back
        - [ ] Send a text message and mention a person
        - [ ] Block code execution, present poll to a user, continue based on the poll answer. 
        
        Pull requests are welcome!
        
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Topic :: System :: Logging
Classifier: Topic :: System :: Networking :: Monitoring
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Python: >=3.6.0
Description-Content-Type: text/markdown
