Code Monkey home page Code Monkey logo

wan's Introduction

WAN

Wait and notify conveniently

CI CommitLint DevContainer Release Renovate Semantic Release Coverage Release PyPI PyPI - Python Version GitHub

pdm-managed pre-commit Checked with mypy Ruff Conventional Commits Pydantic v2 Copier Serious Scaffold Python Open in Dev Containers

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

# 1)
pip install wanot

config

Please config your notifiers. wan will read the setting in ~/.dotfiles/.notifers.yaml as the arguments for notifiers.

Here is a config example of telegram

provider: telegram
kwargs:
    chat_id: <Your Chat id from  `@myidbot` by sending `/getid`>
    token: <Your token from `@BotFather` by sending `/newbot`>

Other configs:

log_level: DEBUG  # the default level is INFO

Usage

Use in python code

  • Call the function in python code directly.
<Your code which takes a lot of time>
from wan import ntf; ntf('Finished')
  • Call the function in shell directly
> sleep 10 ; wan ntf sleep finished

๐Ÿ“œ License

MIT License, for more details, see the LICENSE file.

wan's People

Contributors

you-n-g avatar gaochaozhu avatar zprongl avatar

Stargazers

XianBW avatar Pengrong Zhu avatar  avatar  avatar

Watchers

 avatar James Cloos avatar  avatar

wan's Issues

Action Required: Fix Renovate Configuration

There is an error with this repository's Renovate configuration that needs to be fixed. As a precaution, Renovate will stop PRs until it is resolved.

Location: .renovaterc.json
Error type: Invalid JSON (parsing failed)
Message: Syntax error near ],

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.