| Name | ppslack JSON |
| Version |
3.3.0
JSON |
| download |
| home_page | |
| Summary | Tool to send Slack messages |
| upload_time | 2024-02-05 21:30:50 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.7 |
| license | GPLv3 |
| keywords |
slack
message
notification
notify
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# ppslack
Tool to send Slack messages
PyPI package: [ppslack](https://pypi.org/project/ppslack/)
Feel free to open a [GitHub issue](https://github.com/peterpakos/ppslack/issues) if you spot a problem or have an
improvement idea. I will be happy to look into it for you.
## Installation
The package is available in PyPI and can be installed using pip:
```
$ pip install --user ppslack
$ ppslack --help
```
Once installed, a command line tool `ppslack` will be available in your system's PATH.
## Configuration
By default, the tool reads its configuration from `~/.config/ppslack` file (the
location can be overridden by setting environment variable `XDG_CONFIG_HOME`).
The config file should look like this:
```
[default]
slack_key=xxx
email_domain=example.com
```
## Usage - Help
```
$ ppslack --help
usage: ppslack [--version] [--help] [--debug] [--verbose] [-f SENDER] -t RECIPIENTS [RECIPIENTS ...] [-s SUBJECT] [-S] [-H]
Tool to send Slack messages
optional arguments:
--version show program's version number and exit
--help show this help message and exit
--debug debugging mode
--verbose verbose debugging mode
-f SENDER, --from SENDER
sender
-t RECIPIENTS [RECIPIENTS ...], --to RECIPIENTS [RECIPIENTS ...]
recipient
-s SUBJECT, --subject SUBJECT
subject
-S, --slack Slack message (keeping for backward compatibility)
-H, --code send code block
```
## Usage - CLI
```
$ echo 'The king is dead, long live the king!' \
| ppslack -Hf 'Jon Snow' \
-t 'arya.stark@winterfell.com' \
-s 'Re: secret message'
```
## Usage - Python module
```
from ppslack import Slack
slack = Slack()
status = slack.send(
sender='Jon Snow',
recipients=['arya.stark@winterfell.com'],
subject='Re: secret message',
message='The king is dead, long live the king!',
code=True
)
```
Raw data
{
"_id": null,
"home_page": "",
"name": "ppslack",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "slack,message,notification,notify",
"author": "",
"author_email": "Peter Pakos <peter@pakos.uk>",
"download_url": "https://files.pythonhosted.org/packages/dc/0f/16b45e3fba5c97ed03d430dd4950a9cb287be5640e9fec0667bccc04467b/ppslack-3.3.0.tar.gz",
"platform": null,
"description": "# ppslack\nTool to send Slack messages\n\nPyPI package: [ppslack](https://pypi.org/project/ppslack/)\n\nFeel free to open a [GitHub issue](https://github.com/peterpakos/ppslack/issues) if you spot a problem or have an\nimprovement idea. I will be happy to look into it for you.\n\n## Installation\nThe package is available in PyPI and can be installed using pip:\n```\n$ pip install --user ppslack\n$ ppslack --help\n```\n\nOnce installed, a command line tool `ppslack` will be available in your system's PATH.\n\n## Configuration\nBy default, the tool reads its configuration from `~/.config/ppslack` file (the\nlocation can be overridden by setting environment variable `XDG_CONFIG_HOME`).\n\nThe config file should look like this:\n```\n[default]\nslack_key=xxx\nemail_domain=example.com\n```\n\n## Usage - Help\n```\n$ ppslack --help\nusage: ppslack [--version] [--help] [--debug] [--verbose] [-f SENDER] -t RECIPIENTS [RECIPIENTS ...] [-s SUBJECT] [-S] [-H]\n\nTool to send Slack messages\n\noptional arguments:\n --version show program's version number and exit\n --help show this help message and exit\n --debug debugging mode\n --verbose verbose debugging mode\n -f SENDER, --from SENDER\n sender\n -t RECIPIENTS [RECIPIENTS ...], --to RECIPIENTS [RECIPIENTS ...]\n recipient\n -s SUBJECT, --subject SUBJECT\n subject\n -S, --slack Slack message (keeping for backward compatibility)\n -H, --code send code block\n```\n\n## Usage - CLI\n```\n$ echo 'The king is dead, long live the king!' \\\n | ppslack -Hf 'Jon Snow' \\\n -t 'arya.stark@winterfell.com' \\\n -s 'Re: secret message'\n```\n\n## Usage - Python module\n```\nfrom ppslack import Slack\n\nslack = Slack()\n\nstatus = slack.send(\n sender='Jon Snow',\n recipients=['arya.stark@winterfell.com'],\n subject='Re: secret message',\n message='The king is dead, long live the king!',\n code=True\n)\n```\n",
"bugtrack_url": null,
"license": "GPLv3",
"summary": "Tool to send Slack messages",
"version": "3.3.0",
"project_urls": {
"GitHub": "https://github.com/peterpakos/ppslack/",
"PyPI": "https://pypi.org/project/ppslack/"
},
"split_keywords": [
"slack",
"message",
"notification",
"notify"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "1e3bcf2b2cd78686550166d4628dcd5ae353e26f37ffe7c347f8731f2fca134a",
"md5": "09709460f4bed68dea8ee7780068372c",
"sha256": "7fc7e59e2a95b0a032b970969d0726341b009553cfda4130848f6b29662af6b0"
},
"downloads": -1,
"filename": "ppslack-3.3.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "09709460f4bed68dea8ee7780068372c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 17528,
"upload_time": "2024-02-05T21:30:49",
"upload_time_iso_8601": "2024-02-05T21:30:49.841283Z",
"url": "https://files.pythonhosted.org/packages/1e/3b/cf2b2cd78686550166d4628dcd5ae353e26f37ffe7c347f8731f2fca134a/ppslack-3.3.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "dc0f16b45e3fba5c97ed03d430dd4950a9cb287be5640e9fec0667bccc04467b",
"md5": "30e7886639e619ffbf1fae3fa02e6d9e",
"sha256": "3fbf26090062c5f37400a7004110a7c72500facc9d4dd899f2cac99417b7d018"
},
"downloads": -1,
"filename": "ppslack-3.3.0.tar.gz",
"has_sig": false,
"md5_digest": "30e7886639e619ffbf1fae3fa02e6d9e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 16081,
"upload_time": "2024-02-05T21:30:50",
"upload_time_iso_8601": "2024-02-05T21:30:50.961663Z",
"url": "https://files.pythonhosted.org/packages/dc/0f/16b45e3fba5c97ed03d430dd4950a9cb287be5640e9fec0667bccc04467b/ppslack-3.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-05 21:30:50",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "peterpakos",
"github_project": "ppslack",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "ppslack"
}
