1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
|
%global _empty_manifest_terminate_build 0
Name: python-chime
Version: 0.7.0
Release: 1
Summary: Python sound notifications made easy.
License: MIT
URL: https://github.com/MaxHalford/chime
Source0: https://mirrors.aliyun.com/pypi/web/packages/94/bc/918e3769666d918904b70f1fbdabfc3fbc3fbe97240a2a610b98b9b3fe0e/chime-0.7.0.tar.gz
BuildArch: noarch
%description
<div align="center">
<h1>chime</h1>
<q><i>Python sound notifications made easy.</i></q>
</div>
<br>
<div align="center">
<!-- Tests -->
<a href="https://github.com/MaxHalford/chime/actions?query=workflow%3Atests">
<img src="https://github.com/MaxHalford/chime/workflows/tests/badge.svg?style=flat-square" alt="tests">
</a>
<!-- Soundboard -->
<a href="https://chime-soundboard.herokuapp.com/">
<img src="https://github.com/MaxHalford/chime/workflows/soundboard/badge.svg?style=flat-square" alt="soundboard">
</a>
<!-- PyPI -->
<a href="https://pypi.org/project/chime">
<img src="https://img.shields.io/pypi/v/chime.svg?label=release&color=blue&style=flat-square" alt="pypi">
</a>
<!-- PePy -->
<a href="https://pepy.tech/project/chime">
<img src="https://img.shields.io/badge/dynamic/json?style=flat-square&maxAge=86400&label=downloads&query=%24.total_downloads&url=https%3A%2F%2Fapi.pepy.tech%2Fapi%2Fprojects%2Fchime" alt="pepy">
</a>
<!-- License -->
<a href="https://opensource.org/licenses/MIT">
<img src="https://img.shields.io/badge/License-MIT-blue.svg?style=flat-square" alt="license">
</a>
</div>
<br>
## Table of contents
- [Table of contents](#table-of-contents)
- [Motivation](#motivation)
- [Installation](#installation)
- [Basic usage](#basic-usage)
- [Theming](#theming)
- [IPython/Jupyter magic](#ipythonjupyter-magic)
- [Exception notifications](#exception-notifications)
- [Command-line usage](#command-line-usage)
- [Platform support](#platform-support)
- [I can't hear anything 🙉](#i-cant-hear-anything-)
- [Setting a default theme](#setting-a-default-theme)
- [Command-line arguments](#command-line-arguments)
- [Adding a new theme](#adding-a-new-theme)
- [Things to do](#things-to-do)
- [Acknowledgements](#acknowledgements)
- [License](#license)
## Motivation
I made this because I wanted a simple auditory cue system to tell me when a long-running number crunching script had finished. I didn't want to have to fiddle with the command-line, and also wanted a cross-platform solution. Thus was born `chime`!
## Installation
```sh
pip install chime
```
This library has **no dependencies**. The IPython/Jupyter functionality is only imported if you've installed the `ipython` library. It should work for any Python version above or equal to 3.6.
## Basic usage
`chime` puts four functions at your disposal:
```py
>>> import chime
>>> chime.success()
>>> chime.warning()
>>> chime.error()
>>> chime.info()
```
Calling any of the above functions will play a sound. Note that the sounds are played in asynchronous processes, and are thus non-blocking. Each function should take around 2ms to execute, regardless of the sound length. You're free to use each sound notification in any way you see fit. I'm not your mama.
## Theming
The sounds that are played depend on which theme is being used.
```py
>>> chime.theme() # return the current theme
'chime'
```
Several themes are available:
```py
>>> chime.themes()
['big-sur', 'chime', 'mario', 'material', 'pokemon', 'sonic', 'zelda']
```
The theme can be changed by passing a theme name to the `theme` function:
```py
>>> chime.theme('zelda')
```
A couple of things to note:
- You can listen to the sounds interactively via [this soundboard](https://chime-soundboard.herokuapp.com/), which is made with [Streamlit](https://www.streamlit.io/).
- A random theme will be picked each time you play a sound if you set the theme to `'random'`.
## IPython/Jupyter magic
Load the extension as so:
```py
%load_ext chime
```
You can wrap a line:
```py
%chime print("I'm a line")
```
You can also wrap an entire cell:
```py
%%chime
print("I'm a cell")
```
The magic command will call `chime.success` when the line/cell finishes successfully. Otherwise, `chime.error` is called whenever an exception is raised.
## Exception notifications
If you run `chime.notify_exceptions`, then `chime.error` will be called whenever an exception is raised.
```py
chime.notify_exceptions()
raise ValueError("I'm going to make some noise")
```
## Command-line usage
You can run `chime` from the command-line:
```sh
$ chime
```
By default, this will play the success sound. You can also choose which sound to play, like so:
```sh
$ chime info
```
You can also choose which theme to use:
```sh
$ chime info --theme zelda
```
If you're using bash, then you can use `chime` to notify you when a program finishes:
```sh
$ echo "Hello world!"; chime
```
This will play the sound regardless of the fact that the first command succeeded or not. If you're running on Windows, then you can run the following equivalent:
```sh
> echo "Hello world!" & chime
```
## Platform support
Under the hood, `chime` runs a command in the shell to play a `.wav` file. The command-line program that is used depends on the [platform](https://www.wikiwand.com/en/Computing_platform) that you're using. Platform information is available in the [`sys.platform` variable](https://docs.python.org/3/library/sys.html#sys.platform) as well as the [`platform` module](https://docs.python.org/3/library/platform.html) from the standard library. Currently, the supported platforms are:
- Darwin
- Linux
- Windows
A `UserWarning` is raised if you run a `chime` sound on an unsupported platform. Feel free to get in touch or issue a pull request if you want to add support for a specific platform. Likewise, don't hesitate if you're encountering trouble with one of the above platforms. I won't bite.
## I can't hear anything 🙉
Did you check if you turned your sound on? Just kidding. 😜
This library is designed to be non-invasive. By default, sounds are played asynchronously in unchecked processes. Therefore, if something goes wrong, the process dies silently. If you can't hear anything and you think that the issue is coming from `chime`, then set the `sync` parameter when you play a sound:
```py
>>> chime.info(sync=True)
```
This will play the sound synchronously and issue a warning if something goes wrong, which should allow you to debug the issue. You can also raise an exception instead of sending a warning by setting the `raise_error` parameter:
```py
>>> chime.info(sync=True, raise_error=True)
```
Note that setting `raise_error` won't do anything if `sync` is set to `False`.
## Setting a default theme
To change the default theme a configuration file may be created in `~/.config/chime/chime.conf` on Unix or `%APPDATA%\chime\chime.ini` on Windows.
For example, to change the default theme to `'zelda'`, the configuration file would contain:
```ini
[chime]
theme = zelda
```
## Command-line arguments
Chime works by running commands in the CLI. For instance, `aplay` is used on Linux systems, while `afplay` is used on Darwin systems. Arguments can be specified by setting the `RUN_ARGS` variable. For example, here's how to select a specific sound card, assuming a Linux system using `aplay`:
```py
>>> chime.RUN_ARGS = "--device sysdefault:CARD=PCH"
```
You can also specify this as a default configuration in the configuration file:
```ini
[chime]
cli_args = '--device sysdefault:CARD=PCH'
```
At present, it isn't possible to pass CLI arguments on Windows, due to a limitation of the [`winsound`](https://docs.python.org/3/library/winsound.html) module.
## Adding a new theme
I have toyed with the idea of allowing users to add their own theme(s), but at the moment I rather keep things minimal. However, I'm happy to integrate new themes into the library. You can propose a new theme by [opening a pull request](https://github.com/MaxHalford/chime/issues/new) that adds the necessary .wav files to the [`themes` directory](https://github.com/MaxHalford/chime/tree/main/themes). A theme is made up of four files: `success.wav`, `warning.wav`, `error.wav`, and `info.wav`. That's all you need to do: the theme will picked up be automatically once the necessary files are provided.
Be creative! 👩🎨
## Things to do
- Some mechanism to automatically call `chime.warning` when a warning occurs.
- Make it work with a remote machine. For instance a Jupyter Notebook hosted on a remote machine.
- More themes!
## Acknowledgements
- Special thanks to [Michael Vlah](https://github.com/vlahm) for being a gentleman by giving up the "chime" name on PyPI.
- Thanks to u/Pajke on reddit for helping me debug Windows support.
- Thanks to [David Chen](https://github.com/dchen327) for adding Linux support by suggesting the use of [aplay](https://linux.die.net/man/1/aplay).
- Thanks to [Vincent Warmerdam](https://twitter.com/fishnets88) for suggesting a command-line interface.
- Calmcode made a [video introduction to chime](https://calmcode.io/chime/introduction.html) ❤️
- Thanks to [Paulo S. Costa](https://github.com/paw-lu) for contributing in many different ways.
- Thanks to [d34d_m8](https://github.com/d34dm8) for adding OpenBSD support.
## License
As you would probably expect, this is [MIT licensed](LICENSE).
%package -n python3-chime
Summary: Python sound notifications made easy.
Provides: python-chime
BuildRequires: python3-devel
BuildRequires: python3-setuptools
BuildRequires: python3-pip
%description -n python3-chime
<div align="center">
<h1>chime</h1>
<q><i>Python sound notifications made easy.</i></q>
</div>
<br>
<div align="center">
<!-- Tests -->
<a href="https://github.com/MaxHalford/chime/actions?query=workflow%3Atests">
<img src="https://github.com/MaxHalford/chime/workflows/tests/badge.svg?style=flat-square" alt="tests">
</a>
<!-- Soundboard -->
<a href="https://chime-soundboard.herokuapp.com/">
<img src="https://github.com/MaxHalford/chime/workflows/soundboard/badge.svg?style=flat-square" alt="soundboard">
</a>
<!-- PyPI -->
<a href="https://pypi.org/project/chime">
<img src="https://img.shields.io/pypi/v/chime.svg?label=release&color=blue&style=flat-square" alt="pypi">
</a>
<!-- PePy -->
<a href="https://pepy.tech/project/chime">
<img src="https://img.shields.io/badge/dynamic/json?style=flat-square&maxAge=86400&label=downloads&query=%24.total_downloads&url=https%3A%2F%2Fapi.pepy.tech%2Fapi%2Fprojects%2Fchime" alt="pepy">
</a>
<!-- License -->
<a href="https://opensource.org/licenses/MIT">
<img src="https://img.shields.io/badge/License-MIT-blue.svg?style=flat-square" alt="license">
</a>
</div>
<br>
## Table of contents
- [Table of contents](#table-of-contents)
- [Motivation](#motivation)
- [Installation](#installation)
- [Basic usage](#basic-usage)
- [Theming](#theming)
- [IPython/Jupyter magic](#ipythonjupyter-magic)
- [Exception notifications](#exception-notifications)
- [Command-line usage](#command-line-usage)
- [Platform support](#platform-support)
- [I can't hear anything 🙉](#i-cant-hear-anything-)
- [Setting a default theme](#setting-a-default-theme)
- [Command-line arguments](#command-line-arguments)
- [Adding a new theme](#adding-a-new-theme)
- [Things to do](#things-to-do)
- [Acknowledgements](#acknowledgements)
- [License](#license)
## Motivation
I made this because I wanted a simple auditory cue system to tell me when a long-running number crunching script had finished. I didn't want to have to fiddle with the command-line, and also wanted a cross-platform solution. Thus was born `chime`!
## Installation
```sh
pip install chime
```
This library has **no dependencies**. The IPython/Jupyter functionality is only imported if you've installed the `ipython` library. It should work for any Python version above or equal to 3.6.
## Basic usage
`chime` puts four functions at your disposal:
```py
>>> import chime
>>> chime.success()
>>> chime.warning()
>>> chime.error()
>>> chime.info()
```
Calling any of the above functions will play a sound. Note that the sounds are played in asynchronous processes, and are thus non-blocking. Each function should take around 2ms to execute, regardless of the sound length. You're free to use each sound notification in any way you see fit. I'm not your mama.
## Theming
The sounds that are played depend on which theme is being used.
```py
>>> chime.theme() # return the current theme
'chime'
```
Several themes are available:
```py
>>> chime.themes()
['big-sur', 'chime', 'mario', 'material', 'pokemon', 'sonic', 'zelda']
```
The theme can be changed by passing a theme name to the `theme` function:
```py
>>> chime.theme('zelda')
```
A couple of things to note:
- You can listen to the sounds interactively via [this soundboard](https://chime-soundboard.herokuapp.com/), which is made with [Streamlit](https://www.streamlit.io/).
- A random theme will be picked each time you play a sound if you set the theme to `'random'`.
## IPython/Jupyter magic
Load the extension as so:
```py
%load_ext chime
```
You can wrap a line:
```py
%chime print("I'm a line")
```
You can also wrap an entire cell:
```py
%%chime
print("I'm a cell")
```
The magic command will call `chime.success` when the line/cell finishes successfully. Otherwise, `chime.error` is called whenever an exception is raised.
## Exception notifications
If you run `chime.notify_exceptions`, then `chime.error` will be called whenever an exception is raised.
```py
chime.notify_exceptions()
raise ValueError("I'm going to make some noise")
```
## Command-line usage
You can run `chime` from the command-line:
```sh
$ chime
```
By default, this will play the success sound. You can also choose which sound to play, like so:
```sh
$ chime info
```
You can also choose which theme to use:
```sh
$ chime info --theme zelda
```
If you're using bash, then you can use `chime` to notify you when a program finishes:
```sh
$ echo "Hello world!"; chime
```
This will play the sound regardless of the fact that the first command succeeded or not. If you're running on Windows, then you can run the following equivalent:
```sh
> echo "Hello world!" & chime
```
## Platform support
Under the hood, `chime` runs a command in the shell to play a `.wav` file. The command-line program that is used depends on the [platform](https://www.wikiwand.com/en/Computing_platform) that you're using. Platform information is available in the [`sys.platform` variable](https://docs.python.org/3/library/sys.html#sys.platform) as well as the [`platform` module](https://docs.python.org/3/library/platform.html) from the standard library. Currently, the supported platforms are:
- Darwin
- Linux
- Windows
A `UserWarning` is raised if you run a `chime` sound on an unsupported platform. Feel free to get in touch or issue a pull request if you want to add support for a specific platform. Likewise, don't hesitate if you're encountering trouble with one of the above platforms. I won't bite.
## I can't hear anything 🙉
Did you check if you turned your sound on? Just kidding. 😜
This library is designed to be non-invasive. By default, sounds are played asynchronously in unchecked processes. Therefore, if something goes wrong, the process dies silently. If you can't hear anything and you think that the issue is coming from `chime`, then set the `sync` parameter when you play a sound:
```py
>>> chime.info(sync=True)
```
This will play the sound synchronously and issue a warning if something goes wrong, which should allow you to debug the issue. You can also raise an exception instead of sending a warning by setting the `raise_error` parameter:
```py
>>> chime.info(sync=True, raise_error=True)
```
Note that setting `raise_error` won't do anything if `sync` is set to `False`.
## Setting a default theme
To change the default theme a configuration file may be created in `~/.config/chime/chime.conf` on Unix or `%APPDATA%\chime\chime.ini` on Windows.
For example, to change the default theme to `'zelda'`, the configuration file would contain:
```ini
[chime]
theme = zelda
```
## Command-line arguments
Chime works by running commands in the CLI. For instance, `aplay` is used on Linux systems, while `afplay` is used on Darwin systems. Arguments can be specified by setting the `RUN_ARGS` variable. For example, here's how to select a specific sound card, assuming a Linux system using `aplay`:
```py
>>> chime.RUN_ARGS = "--device sysdefault:CARD=PCH"
```
You can also specify this as a default configuration in the configuration file:
```ini
[chime]
cli_args = '--device sysdefault:CARD=PCH'
```
At present, it isn't possible to pass CLI arguments on Windows, due to a limitation of the [`winsound`](https://docs.python.org/3/library/winsound.html) module.
## Adding a new theme
I have toyed with the idea of allowing users to add their own theme(s), but at the moment I rather keep things minimal. However, I'm happy to integrate new themes into the library. You can propose a new theme by [opening a pull request](https://github.com/MaxHalford/chime/issues/new) that adds the necessary .wav files to the [`themes` directory](https://github.com/MaxHalford/chime/tree/main/themes). A theme is made up of four files: `success.wav`, `warning.wav`, `error.wav`, and `info.wav`. That's all you need to do: the theme will picked up be automatically once the necessary files are provided.
Be creative! 👩🎨
## Things to do
- Some mechanism to automatically call `chime.warning` when a warning occurs.
- Make it work with a remote machine. For instance a Jupyter Notebook hosted on a remote machine.
- More themes!
## Acknowledgements
- Special thanks to [Michael Vlah](https://github.com/vlahm) for being a gentleman by giving up the "chime" name on PyPI.
- Thanks to u/Pajke on reddit for helping me debug Windows support.
- Thanks to [David Chen](https://github.com/dchen327) for adding Linux support by suggesting the use of [aplay](https://linux.die.net/man/1/aplay).
- Thanks to [Vincent Warmerdam](https://twitter.com/fishnets88) for suggesting a command-line interface.
- Calmcode made a [video introduction to chime](https://calmcode.io/chime/introduction.html) ❤️
- Thanks to [Paulo S. Costa](https://github.com/paw-lu) for contributing in many different ways.
- Thanks to [d34d_m8](https://github.com/d34dm8) for adding OpenBSD support.
## License
As you would probably expect, this is [MIT licensed](LICENSE).
%package help
Summary: Development documents and examples for chime
Provides: python3-chime-doc
%description help
<div align="center">
<h1>chime</h1>
<q><i>Python sound notifications made easy.</i></q>
</div>
<br>
<div align="center">
<!-- Tests -->
<a href="https://github.com/MaxHalford/chime/actions?query=workflow%3Atests">
<img src="https://github.com/MaxHalford/chime/workflows/tests/badge.svg?style=flat-square" alt="tests">
</a>
<!-- Soundboard -->
<a href="https://chime-soundboard.herokuapp.com/">
<img src="https://github.com/MaxHalford/chime/workflows/soundboard/badge.svg?style=flat-square" alt="soundboard">
</a>
<!-- PyPI -->
<a href="https://pypi.org/project/chime">
<img src="https://img.shields.io/pypi/v/chime.svg?label=release&color=blue&style=flat-square" alt="pypi">
</a>
<!-- PePy -->
<a href="https://pepy.tech/project/chime">
<img src="https://img.shields.io/badge/dynamic/json?style=flat-square&maxAge=86400&label=downloads&query=%24.total_downloads&url=https%3A%2F%2Fapi.pepy.tech%2Fapi%2Fprojects%2Fchime" alt="pepy">
</a>
<!-- License -->
<a href="https://opensource.org/licenses/MIT">
<img src="https://img.shields.io/badge/License-MIT-blue.svg?style=flat-square" alt="license">
</a>
</div>
<br>
## Table of contents
- [Table of contents](#table-of-contents)
- [Motivation](#motivation)
- [Installation](#installation)
- [Basic usage](#basic-usage)
- [Theming](#theming)
- [IPython/Jupyter magic](#ipythonjupyter-magic)
- [Exception notifications](#exception-notifications)
- [Command-line usage](#command-line-usage)
- [Platform support](#platform-support)
- [I can't hear anything 🙉](#i-cant-hear-anything-)
- [Setting a default theme](#setting-a-default-theme)
- [Command-line arguments](#command-line-arguments)
- [Adding a new theme](#adding-a-new-theme)
- [Things to do](#things-to-do)
- [Acknowledgements](#acknowledgements)
- [License](#license)
## Motivation
I made this because I wanted a simple auditory cue system to tell me when a long-running number crunching script had finished. I didn't want to have to fiddle with the command-line, and also wanted a cross-platform solution. Thus was born `chime`!
## Installation
```sh
pip install chime
```
This library has **no dependencies**. The IPython/Jupyter functionality is only imported if you've installed the `ipython` library. It should work for any Python version above or equal to 3.6.
## Basic usage
`chime` puts four functions at your disposal:
```py
>>> import chime
>>> chime.success()
>>> chime.warning()
>>> chime.error()
>>> chime.info()
```
Calling any of the above functions will play a sound. Note that the sounds are played in asynchronous processes, and are thus non-blocking. Each function should take around 2ms to execute, regardless of the sound length. You're free to use each sound notification in any way you see fit. I'm not your mama.
## Theming
The sounds that are played depend on which theme is being used.
```py
>>> chime.theme() # return the current theme
'chime'
```
Several themes are available:
```py
>>> chime.themes()
['big-sur', 'chime', 'mario', 'material', 'pokemon', 'sonic', 'zelda']
```
The theme can be changed by passing a theme name to the `theme` function:
```py
>>> chime.theme('zelda')
```
A couple of things to note:
- You can listen to the sounds interactively via [this soundboard](https://chime-soundboard.herokuapp.com/), which is made with [Streamlit](https://www.streamlit.io/).
- A random theme will be picked each time you play a sound if you set the theme to `'random'`.
## IPython/Jupyter magic
Load the extension as so:
```py
%load_ext chime
```
You can wrap a line:
```py
%chime print("I'm a line")
```
You can also wrap an entire cell:
```py
%%chime
print("I'm a cell")
```
The magic command will call `chime.success` when the line/cell finishes successfully. Otherwise, `chime.error` is called whenever an exception is raised.
## Exception notifications
If you run `chime.notify_exceptions`, then `chime.error` will be called whenever an exception is raised.
```py
chime.notify_exceptions()
raise ValueError("I'm going to make some noise")
```
## Command-line usage
You can run `chime` from the command-line:
```sh
$ chime
```
By default, this will play the success sound. You can also choose which sound to play, like so:
```sh
$ chime info
```
You can also choose which theme to use:
```sh
$ chime info --theme zelda
```
If you're using bash, then you can use `chime` to notify you when a program finishes:
```sh
$ echo "Hello world!"; chime
```
This will play the sound regardless of the fact that the first command succeeded or not. If you're running on Windows, then you can run the following equivalent:
```sh
> echo "Hello world!" & chime
```
## Platform support
Under the hood, `chime` runs a command in the shell to play a `.wav` file. The command-line program that is used depends on the [platform](https://www.wikiwand.com/en/Computing_platform) that you're using. Platform information is available in the [`sys.platform` variable](https://docs.python.org/3/library/sys.html#sys.platform) as well as the [`platform` module](https://docs.python.org/3/library/platform.html) from the standard library. Currently, the supported platforms are:
- Darwin
- Linux
- Windows
A `UserWarning` is raised if you run a `chime` sound on an unsupported platform. Feel free to get in touch or issue a pull request if you want to add support for a specific platform. Likewise, don't hesitate if you're encountering trouble with one of the above platforms. I won't bite.
## I can't hear anything 🙉
Did you check if you turned your sound on? Just kidding. 😜
This library is designed to be non-invasive. By default, sounds are played asynchronously in unchecked processes. Therefore, if something goes wrong, the process dies silently. If you can't hear anything and you think that the issue is coming from `chime`, then set the `sync` parameter when you play a sound:
```py
>>> chime.info(sync=True)
```
This will play the sound synchronously and issue a warning if something goes wrong, which should allow you to debug the issue. You can also raise an exception instead of sending a warning by setting the `raise_error` parameter:
```py
>>> chime.info(sync=True, raise_error=True)
```
Note that setting `raise_error` won't do anything if `sync` is set to `False`.
## Setting a default theme
To change the default theme a configuration file may be created in `~/.config/chime/chime.conf` on Unix or `%APPDATA%\chime\chime.ini` on Windows.
For example, to change the default theme to `'zelda'`, the configuration file would contain:
```ini
[chime]
theme = zelda
```
## Command-line arguments
Chime works by running commands in the CLI. For instance, `aplay` is used on Linux systems, while `afplay` is used on Darwin systems. Arguments can be specified by setting the `RUN_ARGS` variable. For example, here's how to select a specific sound card, assuming a Linux system using `aplay`:
```py
>>> chime.RUN_ARGS = "--device sysdefault:CARD=PCH"
```
You can also specify this as a default configuration in the configuration file:
```ini
[chime]
cli_args = '--device sysdefault:CARD=PCH'
```
At present, it isn't possible to pass CLI arguments on Windows, due to a limitation of the [`winsound`](https://docs.python.org/3/library/winsound.html) module.
## Adding a new theme
I have toyed with the idea of allowing users to add their own theme(s), but at the moment I rather keep things minimal. However, I'm happy to integrate new themes into the library. You can propose a new theme by [opening a pull request](https://github.com/MaxHalford/chime/issues/new) that adds the necessary .wav files to the [`themes` directory](https://github.com/MaxHalford/chime/tree/main/themes). A theme is made up of four files: `success.wav`, `warning.wav`, `error.wav`, and `info.wav`. That's all you need to do: the theme will picked up be automatically once the necessary files are provided.
Be creative! 👩🎨
## Things to do
- Some mechanism to automatically call `chime.warning` when a warning occurs.
- Make it work with a remote machine. For instance a Jupyter Notebook hosted on a remote machine.
- More themes!
## Acknowledgements
- Special thanks to [Michael Vlah](https://github.com/vlahm) for being a gentleman by giving up the "chime" name on PyPI.
- Thanks to u/Pajke on reddit for helping me debug Windows support.
- Thanks to [David Chen](https://github.com/dchen327) for adding Linux support by suggesting the use of [aplay](https://linux.die.net/man/1/aplay).
- Thanks to [Vincent Warmerdam](https://twitter.com/fishnets88) for suggesting a command-line interface.
- Calmcode made a [video introduction to chime](https://calmcode.io/chime/introduction.html) ❤️
- Thanks to [Paulo S. Costa](https://github.com/paw-lu) for contributing in many different ways.
- Thanks to [d34d_m8](https://github.com/d34dm8) for adding OpenBSD support.
## License
As you would probably expect, this is [MIT licensed](LICENSE).
%prep
%autosetup -n chime-0.7.0
%build
%py3_build
%install
%py3_install
install -d -m755 %{buildroot}/%{_pkgdocdir}
if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi
if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi
if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi
if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi
pushd %{buildroot}
if [ -d usr/lib ]; then
find usr/lib -type f -printf "\"/%h/%f\"\n" >> filelist.lst
fi
if [ -d usr/lib64 ]; then
find usr/lib64 -type f -printf "\"/%h/%f\"\n" >> filelist.lst
fi
if [ -d usr/bin ]; then
find usr/bin -type f -printf "\"/%h/%f\"\n" >> filelist.lst
fi
if [ -d usr/sbin ]; then
find usr/sbin -type f -printf "\"/%h/%f\"\n" >> filelist.lst
fi
touch doclist.lst
if [ -d usr/share/man ]; then
find usr/share/man -type f -printf "\"/%h/%f.gz\"\n" >> doclist.lst
fi
popd
mv %{buildroot}/filelist.lst .
mv %{buildroot}/doclist.lst .
%files -n python3-chime -f filelist.lst
%dir %{python3_sitelib}/*
%files help -f doclist.lst
%{_docdir}/*
%changelog
* Tue Jun 20 2023 Python_Bot <Python_Bot@openeuler.org> - 0.7.0-1
- Package Spec generated
|