# WAN
Wait and notify conveniently
[](https://github.com/you-n-g/wan/actions/workflows/ci.yml)
[](https://github.com/you-n-g/wan/actions/workflows/commitlint.yml)
[](https://github.com/you-n-g/wan/actions/workflows/devcontainer.yml)
[](https://github.com/you-n-g/wan/actions/workflows/release.yml)
[](https://github.com/you-n-g/wan/actions/workflows/renovate.yml)
[](https://github.com/you-n-g/wan/actions/workflows/semantic-release.yml)
[](https://you-n-g.github.io/wan/reports/coverage)
[](https://github.com/you-n-g/wan/releases)
[](https://pypi.org/project/wanot/)
[](https://pypi.org/project/wanot/)
[](https://github.com/you-n-g/wan/blob/main/LICENSE)
[](https://pdm-project.org)
[](https://github.com/pre-commit/pre-commit)
[](http://mypy-lang.org/)
[](https://github.com/astral-sh/ruff)
[](https://conventionalcommits.org)
[](https://pydantic.dev)
[](https://github.com/copier-org/copier)
[](https://serious-scaffold.github.io/ss-python)
[](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/you-n-g/wan)
> [!IMPORTANT]
> _WAN_ is in the **Beta** phase.
> Changes and potential instability should be anticipated.
> Any feedback, comments, suggestions and contributions are welcome!
# Wait And Notify(WAN)
This package is under development. We will release it soon in the future.
# Installation
You can install wan with **one** of the following command
<!-- [fzf](https://github.com/junegunn/fzf) is required -->
```shell
# 1)
# pip install wan # TODO: upload this to pip source
# 2)
pip install git+https://github.com/you-n-g/wan.git@master
# 3)
python setup.py install
# 4)
python setup.py develop # It is recommended if you want to develop wan
```
## config
Please config your [notifiers](https://github.com/liiight/notifiers).
`wan` will read the setting in ` ~/.dotfiles/.notifers.yaml` as the arguments for notifiers.
Here is a config example of telegram
```yaml
provider: telegram
kwargs:
chat_id: <Your Chat id from `@myidbot` by sending `/getid`>
token: <Your token from `@BotFather` by sending `/newbot`>
```
Other configs:
```yaml
log_level: DEBUG # the default level is INFO
```
# Usage
## Use in python code
* Call the function in python code directly.
```python
<Your code which takes a lot of time>
from wan import ntf; ntf('Finished')
```
* Call the function in shell directly
```shell
> sleep 10 ; wan ntf sleep finished
```
<<<<<<< HEAD
=======
## 📜 License
MIT License, for more details, see the [LICENSE](https://github.com/you-n-g/wan/blob/main/LICENSE) file.
>>>>>>> 400ad4d (Init from serious-scaffold-python.)
Raw data
{
"_id": null,
"home_page": null,
"name": "wanot",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "copier-template, full-development-lifecycle, project-template, serious-scaffold",
"author": null,
"author_email": "Xiao Yang <afe.young@gmail.com>, zhupr <zplongr@hotmail.com>, gazh <v-gazh@hotmail.com>",
"download_url": "https://files.pythonhosted.org/packages/17/79/2c8e3556c1c99d6ffc65fbf97ce5b4bdbbc7950e6f1d28df9bfe573ecd55/wanot-0.0.3.tar.gz",
"platform": null,
"description": "# WAN\n\nWait and notify conveniently\n\n\n\n[](https://github.com/you-n-g/wan/actions/workflows/ci.yml)\n[](https://github.com/you-n-g/wan/actions/workflows/commitlint.yml)\n[](https://github.com/you-n-g/wan/actions/workflows/devcontainer.yml)\n[](https://github.com/you-n-g/wan/actions/workflows/release.yml)\n[](https://github.com/you-n-g/wan/actions/workflows/renovate.yml)\n[](https://github.com/you-n-g/wan/actions/workflows/semantic-release.yml)\n[](https://you-n-g.github.io/wan/reports/coverage)\n[](https://github.com/you-n-g/wan/releases)\n[](https://pypi.org/project/wanot/)\n[](https://pypi.org/project/wanot/)\n[](https://github.com/you-n-g/wan/blob/main/LICENSE)\n\n[](https://pdm-project.org)\n[](https://github.com/pre-commit/pre-commit)\n[](http://mypy-lang.org/)\n[](https://github.com/astral-sh/ruff)\n[](https://conventionalcommits.org)\n[](https://pydantic.dev)\n[](https://github.com/copier-org/copier)\n[](https://serious-scaffold.github.io/ss-python)\n[](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/you-n-g/wan)\n\n> [!IMPORTANT]\n> _WAN_ is in the **Beta** phase.\n> Changes and potential instability should be anticipated.\n> Any feedback, comments, suggestions and contributions are welcome!\n\n\n\n# Wait And Notify(WAN)\nThis package is under development. We will release it soon in the future.\n\n\n\n# Installation\n\nYou can install wan with **one** of the following command\n\n<!-- [fzf](https://github.com/junegunn/fzf) is required -->\n```shell\n# 1)\n# pip install wan # TODO: upload this to pip source\n# 2)\npip install git+https://github.com/you-n-g/wan.git@master\n# 3)\npython setup.py install\n# 4)\npython setup.py develop # It is recommended if you want to develop wan\n```\n\n## config\n\nPlease config your [notifiers](https://github.com/liiight/notifiers).\n`wan` will read the setting in ` ~/.dotfiles/.notifers.yaml` as the arguments for notifiers.\n\nHere is a config example of telegram\n```yaml\nprovider: telegram\nkwargs:\n chat_id: <Your Chat id from `@myidbot` by sending `/getid`>\n token: <Your token from `@BotFather` by sending `/newbot`>\n```\n\nOther configs:\n```yaml\nlog_level: DEBUG # the default level is INFO\n```\n\n\n# Usage\n\n## Use in python code\n\n* Call the function in python code directly.\n```python\n<Your code which takes a lot of time>\nfrom wan import ntf; ntf('Finished')\n```\n\n* Call the function in shell directly\n```shell\n> sleep 10 ; wan ntf sleep finished\n```\n\n<<<<<<< HEAD\n=======\n\n\n## \ud83d\udcdc License\n\nMIT License, for more details, see the [LICENSE](https://github.com/you-n-g/wan/blob/main/LICENSE) file.\n>>>>>>> 400ad4d (Init from serious-scaffold-python.)\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Wait and notify conveniently",
"version": "0.0.3",
"project_urls": {
"documentation": "https://you-n-g.github.io/wan",
"issue": "https://github.com/you-n-g/wan/issues",
"repository": "https://github.com/you-n-g/wan"
},
"split_keywords": [
"copier-template",
" full-development-lifecycle",
" project-template",
" serious-scaffold"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "7cb7385b8356bfc732f63a60af08f58469b369684c01538f19489cc532fd3d76",
"md5": "d900561b9b4968b9643f5494ec518403",
"sha256": "b60c5ca7c18a736f46bad3e41ec75dc85a740f9c03e17a20119d0b3def95cf6c"
},
"downloads": -1,
"filename": "wanot-0.0.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d900561b9b4968b9643f5494ec518403",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 9274,
"upload_time": "2024-08-16T04:24:12",
"upload_time_iso_8601": "2024-08-16T04:24:12.587669Z",
"url": "https://files.pythonhosted.org/packages/7c/b7/385b8356bfc732f63a60af08f58469b369684c01538f19489cc532fd3d76/wanot-0.0.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "17792c8e3556c1c99d6ffc65fbf97ce5b4bdbbc7950e6f1d28df9bfe573ecd55",
"md5": "88b77dec91b2ecafa35c5ef16edad978",
"sha256": "f7e250d08f2076b592cbdc0bd972bdf82abe862b391b2d5c3220f668d0adfec9"
},
"downloads": -1,
"filename": "wanot-0.0.3.tar.gz",
"has_sig": false,
"md5_digest": "88b77dec91b2ecafa35c5ef16edad978",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 257979,
"upload_time": "2024-08-16T04:24:15",
"upload_time_iso_8601": "2024-08-16T04:24:15.116389Z",
"url": "https://files.pythonhosted.org/packages/17/79/2c8e3556c1c99d6ffc65fbf97ce5b4bdbbc7950e6f1d28df9bfe573ecd55/wanot-0.0.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-16 04:24:15",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "you-n-g",
"github_project": "wan",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "wanot"
}
JSON
