vivaldy 0.1a0__tar.gz

vivaldy-0.1a0/LICENSE.md

@@ -0,0 +1,289 @@
+                      EUROPEAN UNION PUBLIC LICENCE v. 1.2
+                      EUPL © the European Union 2007, 2016
+
+This European Union Public Licence (the ‘EUPL’) applies to the Work (as defined
+below) which is provided under the terms of this Licence. Any use of the Work,
+other than as authorised under this Licence is prohibited (to the extent such
+use is covered by a right of the copyright holder of the Work).
+
+The Work is provided under the terms of this Licence when the Licensor (as
+defined below) has placed the following notice immediately following the
+copyright notice for the Work:
+
+        Licensed under the EUPL
+
+or has expressed by any other means his willingness to license under the EUPL.
+
+1. Definitions
+
+In this Licence, the following terms have the following meaning:
+
+- ‘The Licence’: this Licence.
+
+- ‘The Original Work’: the work or software distributed or communicated by the
+  Licensor under this Licence, available as Source Code and also as Executable
+  Code as the case may be.
+
+- ‘Derivative Works’: the works or software that could be created by the
+  Licensee, based upon the Original Work or modifications thereof. This Licence
+  does not define the extent of modification or dependence on the Original Work
+  required in order to classify a work as a Derivative Work; this extent is
+  determined by copyright law applicable in the country mentioned in Article 15.
+
+- ‘The Work’: the Original Work or its Derivative Works.
+
+- ‘The Source Code’: the human-readable form of the Work which is the most
+  convenient for people to study and modify.
+
+- ‘The Executable Code’: any code which has generally been compiled and which is
+  meant to be interpreted by a computer as a program.
+
+- ‘The Licensor’: the natural or legal person that distributes or communicates
+  the Work under the Licence.
+
+- ‘Contributor(s)’: any natural or legal person who modifies the Work under the
+  Licence, or otherwise contributes to the creation of a Derivative Work.
+
+- ‘The Licensee’ or ‘You’: any natural or legal person who makes any usage of
+  the Work under the terms of the Licence.
+
+- ‘Distribution’ or ‘Communication’: any act of selling, giving, lending,
+  renting, distributing, communicating, transmitting, or otherwise making
+  available, online or offline, copies of the Work or providing access to its
+  essential functionalities at the disposal of any other natural or legal
+  person.
+
+2. Scope of the rights granted by the Licence
+
+The Licensor hereby grants You a worldwide, royalty-free, non-exclusive,
+sublicensable licence to do the following, for the duration of copyright vested
+in the Original Work:
+
+- use the Work in any circumstance and for all usage,
+- reproduce the Work,
+- modify the Work, and make Derivative Works based upon the Work,
+- communicate to the public, including the right to make available or display
+  the Work or copies thereof to the public and perform publicly, as the case may
+  be, the Work,
+- distribute the Work or copies thereof,
+- lend and rent the Work or copies thereof,
+- sublicense rights in the Work or copies thereof.
+
+Those rights can be exercised on any media, supports and formats, whether now
+known or later invented, as far as the applicable law permits so.
+
+In the countries where moral rights apply, the Licensor waives his right to
+exercise his moral right to the extent allowed by law in order to make effective
+the licence of the economic rights here above listed.
+
+The Licensor grants to the Licensee royalty-free, non-exclusive usage rights to
+any patents held by the Licensor, to the extent necessary to make use of the
+rights granted on the Work under this Licence.
+
+3. Communication of the Source Code
+
+The Licensor may provide the Work either in its Source Code form, or as
+Executable Code. If the Work is provided as Executable Code, the Licensor
+provides in addition a machine-readable copy of the Source Code of the Work
+along with each copy of the Work that the Licensor distributes or indicates, in
+a notice following the copyright notice attached to the Work, a repository where
+the Source Code is easily and freely accessible for as long as the Licensor
+continues to distribute or communicate the Work.
+
+4. Limitations on copyright
+
+Nothing in this Licence is intended to deprive the Licensee of the benefits from
+any exception or limitation to the exclusive rights of the rights owners in the
+Work, of the exhaustion of those rights or of other applicable limitations
+thereto.
+
+5. Obligations of the Licensee
+
+The grant of the rights mentioned above is subject to some restrictions and
+obligations imposed on the Licensee. Those obligations are the following:
+
+Attribution right: The Licensee shall keep intact all copyright, patent or
+trademarks notices and all notices that refer to the Licence and to the
+disclaimer of warranties. The Licensee must include a copy of such notices and a
+copy of the Licence with every copy of the Work he/she distributes or
+communicates. The Licensee must cause any Derivative Work to carry prominent
+notices stating that the Work has been modified and the date of modification.
+
+Copyleft clause: If the Licensee distributes or communicates copies of the
+Original Works or Derivative Works, this Distribution or Communication will be
+done under the terms of this Licence or of a later version of this Licence
+unless the Original Work is expressly distributed only under this version of the
+Licence — for example by communicating ‘EUPL v. 1.2 only’. The Licensee
+(becoming Licensor) cannot offer or impose any additional terms or conditions on
+the Work or Derivative Work that alter or restrict the terms of the Licence.
+
+Compatibility clause: If the Licensee Distributes or Communicates Derivative
+Works or copies thereof based upon both the Work and another work licensed under
+a Compatible Licence, this Distribution or Communication can be done under the
+terms of this Compatible Licence. For the sake of this clause, ‘Compatible
+Licence’ refers to the licences listed in the appendix attached to this Licence.
+Should the Licensee's obligations under the Compatible Licence conflict with
+his/her obligations under this Licence, the obligations of the Compatible
+Licence shall prevail.
+
+Provision of Source Code: When distributing or communicating copies of the Work,
+the Licensee will provide a machine-readable copy of the Source Code or indicate
+a repository where this Source will be easily and freely available for as long
+as the Licensee continues to distribute or communicate the Work.
+
+Legal Protection: This Licence does not grant permission to use the trade names,
+trademarks, service marks, or names of the Licensor, except as required for
+reasonable and customary use in describing the origin of the Work and
+reproducing the content of the copyright notice.
+
+6. Chain of Authorship
+
+The original Licensor warrants that the copyright in the Original Work granted
+hereunder is owned by him/her or licensed to him/her and that he/she has the
+power and authority to grant the Licence.
+
+Each Contributor warrants that the copyright in the modifications he/she brings
+to the Work are owned by him/her or licensed to him/her and that he/she has the
+power and authority to grant the Licence.
+
+Each time You accept the Licence, the original Licensor and subsequent
+Contributors grant You a licence to their contributions to the Work, under the
+terms of this Licence.
+
+7. Disclaimer of Warranty
+
+The Work is a work in progress, which is continuously improved by numerous
+Contributors. It is not a finished work and may therefore contain defects or
+‘bugs’ inherent to this type of development.
+
+For the above reason, the Work is provided under the Licence on an ‘as is’ basis
+and without warranties of any kind concerning the Work, including without
+limitation merchantability, fitness for a particular purpose, absence of defects
+or errors, accuracy, non-infringement of intellectual property rights other than
+copyright as stated in Article 6 of this Licence.
+
+This disclaimer of warranty is an essential part of the Licence and a condition
+for the grant of any rights to the Work.
+
+8. Disclaimer of Liability
+
+Except in the cases of wilful misconduct or damages directly caused to natural
+persons, the Licensor will in no event be liable for any direct or indirect,
+material or moral, damages of any kind, arising out of the Licence or of the use
+of the Work, including without limitation, damages for loss of goodwill, work
+stoppage, computer failure or malfunction, loss of data or any commercial
+damage, even if the Licensor has been advised of the possibility of such damage.
+However, the Licensor will be liable under statutory product liability laws as
+far such laws apply to the Work.
+
+9. Additional agreements
+
+While distributing the Work, You may choose to conclude an additional agreement,
+defining obligations or services consistent with this Licence. However, if
+accepting obligations, You may act only on your own behalf and on your sole
+responsibility, not on behalf of the original Licensor or any other Contributor,
+and only if You agree to indemnify, defend, and hold each Contributor harmless
+for any liability incurred by, or claims asserted against such Contributor by
+the fact You have accepted any warranty or additional liability.
+
+10. Acceptance of the Licence
+
+The provisions of this Licence can be accepted by clicking on an icon ‘I agree’
+placed under the bottom of a window displaying the text of this Licence or by
+affirming consent in any other similar way, in accordance with the rules of
+applicable law. Clicking on that icon indicates your clear and irrevocable
+acceptance of this Licence and all of its terms and conditions.
+
+Similarly, you irrevocably accept this Licence and all of its terms and
+conditions by exercising any rights granted to You by Article 2 of this Licence,
+such as the use of the Work, the creation by You of a Derivative Work or the
+Distribution or Communication by You of the Work or copies thereof.
+
+11. Information to the public
+
+In case of any Distribution or Communication of the Work by means of electronic
+communication by You (for example, by offering to download the Work from a
+remote location) the distribution channel or media (for example, a website) must
+at least provide to the public the information requested by the applicable law
+regarding the Licensor, the Licence and the way it may be accessible, concluded,
+stored and reproduced by the Licensee.
+
+12. Termination of the Licence
+
+The Licence and the rights granted hereunder will terminate automatically upon
+any breach by the Licensee of the terms of the Licence.
+
+Such a termination will not terminate the licences of any person who has
+received the Work from the Licensee under the Licence, provided such persons
+remain in full compliance with the Licence.
+
+13. Miscellaneous
+
+Without prejudice of Article 9 above, the Licence represents the complete
+agreement between the Parties as to the Work.
+
+If any provision of the Licence is invalid or unenforceable under applicable
+law, this will not affect the validity or enforceability of the Licence as a
+whole. Such provision will be construed or reformed so as necessary to make it
+valid and enforceable.
+
+The European Commission may publish other linguistic versions or new versions of
+this Licence or updated versions of the Appendix, so far this is required and
+reasonable, without reducing the scope of the rights granted by the Licence. New
+versions of the Licence will be published with a unique version number.
+
+All linguistic versions of this Licence, approved by the European Commission,
+have identical value. Parties can take advantage of the linguistic version of
+their choice.
+
+14. Jurisdiction
+
+Without prejudice to specific agreement between parties,
+
+- any litigation resulting from the interpretation of this License, arising
+  between the European Union institutions, bodies, offices or agencies, as a
+  Licensor, and any Licensee, will be subject to the jurisdiction of the Court
+  of Justice of the European Union, as laid down in article 272 of the Treaty on
+  the Functioning of the European Union,
+
+- any litigation arising between other parties and resulting from the
+  interpretation of this License, will be subject to the exclusive jurisdiction
+  of the competent court where the Licensor resides or conducts its primary
+  business.
+
+15. Applicable Law
+
+Without prejudice to specific agreement between parties,
+
+- this Licence shall be governed by the law of the European Union Member State
+  where the Licensor has his seat, resides or has his registered office,
+
+- this licence shall be governed by Belgian law if the Licensor has no seat,
+  residence or registered office inside a European Union Member State.
+
+Appendix
+
+‘Compatible Licences’ according to Article 5 EUPL are:
+
+- GNU General Public License (GPL) v. 2, v. 3
+- GNU Affero General Public License (AGPL) v. 3
+- Open Software License (OSL) v. 2.1, v. 3.0
+- Eclipse Public License (EPL) v. 1.0
+- CeCILL v. 2.0, v. 2.1
+- Mozilla Public Licence (MPL) v. 2
+- GNU Lesser General Public Licence (LGPL) v. 2.1, v. 3
+- Creative Commons Attribution-ShareAlike v. 3.0 Unported (CC BY-SA 3.0) for
+  works other than software
+- European Union Public Licence (EUPL) v. 1.1, v. 1.2
+- Québec Free and Open-Source Licence — Reciprocity (LiLiQ-R) or Strong
+  Reciprocity (LiLiQ-R+).
+
+The European Commission may update this Appendix to later versions of the above
+licences without producing a new version of the EUPL, as long as they provide
+the rights granted in Article 2 of this Licence and protect the covered Source
+Code from exclusive appropriation.
+
+All other changes or additions to this Appendix require the production of a new
+EUPL version.
+
+

vivaldy-0.1a0/PKG-INFO

@@ -0,0 +1,146 @@
+Metadata-Version: 2.4
+Name: vivaldy
+Version: 0.1a0
+Summary: Add music on hold to your Python code
+Author-email: Yann <phd@yannziegler.com>
+License-Expression: EUPL-1.2
+Project-URL: Homepage, https://github.com/yannziegler/vivaldy
+Project-URL: Issues, https://github.com/yannziegler/vivaldy/issues
+Keywords: music on hold,Vivaldi,musique d'attente
+Classifier: Development Status :: 3 - Alpha
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE.md
+Requires-Dist: audioop-lts>=0.2.2
+Requires-Dist: ffmpeg-python>=0.2.0
+Requires-Dist: playsound3>=3.3.0
+Requires-Dist: pydub>=0.25.1
+Requires-Dist: pytubefix>=10.3.6
+Dynamic: license-file
+
+# Vivaldy
+
+🎼 Your obligatory Python addition dedicated to the tastefully improvement of
+your waiting experience while running long and/or slow scripts.
+
+Keywords: music on hold, musique d'attente, ASSEDIC, Vivaldi
+
+🎹 Developed and maintained by Yann,
+inspired by an original idea from Jeanne and Thomas.
+
+> 🎧 **Stay tuned!** Vivaldy is being actively developed; new features may be
+added any time.
+
+## Description
+
+Vivaldy is to your Python code what Vivaldi is to your phone calls to public
+administration and other serious organisations. It is a natural and unmissable
+addition to any Python code that requires a long waiting time when running.
+
+It is _scientifically proven™_
+([Hul _et al._ 1997](https://doi.org/10.1016/S0022-4359%2897%2990016-6))
+that waiting music has a positive impact on the user experience.
+
+Be careful, however, as the valence of your selected waiting music may
+influenced the perceived waiting time: it has been established that "perceived
+duration was longest for subjects exposed to positively valenced (major key)
+music, and shortest for negatively valenced (atonal) music"
+[Kellaris & Kent (1992)](https://doi.org/10.1016/S1057-7408%2808%2980060-5).
+
+Short historical background (en français):
+<https://www.rtbf.be/article/mozart-et-vivaldi-les-stars-de-la-musique-d-attente-telephonique-11284821>
+
+## Installation
+
+If needed, create a dedicated environment:
+
+```
+conda create -n vivaldy
+```
+
+Alternatively, for testing purpose, you may want to clone an existing
+environment:
+
+```
+conda create -n myenv_with_vivaldy --clone myenv
+```
+
+Activate the environment you just created, or another existing environment of
+your choice:
+
+```
+conda activate MY_ENV_FOR_VIVALDY
+```
+
+Then, from within `vivaldy` base folder:
+
+```
+conda install -c conda-forge --yes --file requirements.txt
+pip install -r pip_requirements.txt
+pip install .
+```
+
+Ensure everything is working properly by trying to import and run `vivaldy`:
+
+```python
+import vivaldy
+music = vivaldy.MusicOnHold().start()
+music.stop()
+```
+
+You shouldn't get any error running this short script.
+
+## Documentation
+
+More coming sooner or later. For now, it is as simple as it can get:
+
+```python
+## Vivaldy toy example
+import vivaldy
+import time # only for testing
+
+# Let's start waiting!
+music = vivaldy.MusicOnHold()
+music.start()
+# ...or simply vivaldy.MusicOnHold().start() with no handler
+
+for i in range(10):
+    print(f"Processing {i+1:d}/10...")
+    # Some very important processing...
+    time.sleep(5)
+
+# And now we are done
+music.done() # This line is not required
+
+# Use music.wait() to wait till the end of the music
+# (not recommended due to potential productivity loss)
+```
+
+## Known major or minor bugs
+
+No tonal bugs in there.
+
+## Future
+
+- Restart music while needed
+- Periodic announcements about estimated waiting time
+- Integrate with `tqdm`
+
+## Tools used
+
+- Coding: Emacs with Spacemacs config
+- Python packages: see (pip_)requirements.txt
+
+## Licence
+
+This software is licensed under the [EUPL](LICENSE.md).
+
+## Acknowledgements
+
+Many thanks to all the current and future beta-testers!
+
+To Vivaldi and Mozart as well, and of course to
+[Alfred Levy](https://en.wikipedia.org/wiki/Music_on_hold).
+

vivaldy-0.1a0/README.md

@@ -0,0 +1,124 @@
+# Vivaldy
+
+🎼 Your obligatory Python addition dedicated to the tastefully improvement of
+your waiting experience while running long and/or slow scripts.
+
+Keywords: music on hold, musique d'attente, ASSEDIC, Vivaldi
+
+🎹 Developed and maintained by Yann,
+inspired by an original idea from Jeanne and Thomas.
+
+> 🎧 **Stay tuned!** Vivaldy is being actively developed; new features may be
+added any time.
+
+## Description
+
+Vivaldy is to your Python code what Vivaldi is to your phone calls to public
+administration and other serious organisations. It is a natural and unmissable
+addition to any Python code that requires a long waiting time when running.
+
+It is _scientifically proven™_
+([Hul _et al._ 1997](https://doi.org/10.1016/S0022-4359%2897%2990016-6))
+that waiting music has a positive impact on the user experience.
+
+Be careful, however, as the valence of your selected waiting music may
+influenced the perceived waiting time: it has been established that "perceived
+duration was longest for subjects exposed to positively valenced (major key)
+music, and shortest for negatively valenced (atonal) music"
+[Kellaris & Kent (1992)](https://doi.org/10.1016/S1057-7408%2808%2980060-5).
+
+Short historical background (en français):
+<https://www.rtbf.be/article/mozart-et-vivaldi-les-stars-de-la-musique-d-attente-telephonique-11284821>
+
+## Installation
+
+If needed, create a dedicated environment:
+
+```
+conda create -n vivaldy
+```
+
+Alternatively, for testing purpose, you may want to clone an existing
+environment:
+
+```
+conda create -n myenv_with_vivaldy --clone myenv
+```
+
+Activate the environment you just created, or another existing environment of
+your choice:
+
+```
+conda activate MY_ENV_FOR_VIVALDY
+```
+
+Then, from within `vivaldy` base folder:
+
+```
+conda install -c conda-forge --yes --file requirements.txt
+pip install -r pip_requirements.txt
+pip install .
+```
+
+Ensure everything is working properly by trying to import and run `vivaldy`:
+
+```python
+import vivaldy
+music = vivaldy.MusicOnHold().start()
+music.stop()
+```
+
+You shouldn't get any error running this short script.
+
+## Documentation
+
+More coming sooner or later. For now, it is as simple as it can get:
+
+```python
+## Vivaldy toy example
+import vivaldy
+import time # only for testing
+
+# Let's start waiting!
+music = vivaldy.MusicOnHold()
+music.start()
+# ...or simply vivaldy.MusicOnHold().start() with no handler
+
+for i in range(10):
+    print(f"Processing {i+1:d}/10...")
+    # Some very important processing...
+    time.sleep(5)
+
+# And now we are done
+music.done() # This line is not required
+
+# Use music.wait() to wait till the end of the music
+# (not recommended due to potential productivity loss)
+```
+
+## Known major or minor bugs
+
+No tonal bugs in there.
+
+## Future
+
+- Restart music while needed
+- Periodic announcements about estimated waiting time
+- Integrate with `tqdm`
+
+## Tools used
+
+- Coding: Emacs with Spacemacs config
+- Python packages: see (pip_)requirements.txt
+
+## Licence
+
+This software is licensed under the [EUPL](LICENSE.md).
+
+## Acknowledgements
+
+Many thanks to all the current and future beta-testers!
+
+To Vivaldi and Mozart as well, and of course to
+[Alfred Levy](https://en.wikipedia.org/wiki/Music_on_hold).
+

vivaldy-0.1a0/pyproject.toml

@@ -0,0 +1,32 @@
+[build-system]
+requires = ["setuptools >= 77.0.3"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "vivaldy"
+version = "0.1-alpha"
+authors = [
+  { name="Yann", email="phd@yannziegler.com" },
+]
+description = "Add music on hold to your Python code"
+keywords = ["music on hold", "Vivaldi", "musique d'attente"]
+readme = "README.md"
+requires-python = ">=3.9"
+dependencies = [
+  "audioop-lts>=0.2.2",
+  "ffmpeg-python>=0.2.0",
+  "playsound3>=3.3.0",
+  "pydub>=0.25.1",
+  "pytubefix>=10.3.6",
+]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Programming Language :: Python :: 3",
+    "Operating System :: OS Independent",
+]
+license = "EUPL-1.2"
+license-files = ["LICEN[CS]E*"]
+
+[project.urls]
+Homepage = "https://github.com/yannziegler/vivaldy"
+Issues = "https://github.com/yannziegler/vivaldy/issues"

vivaldy-0.1a0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

vivaldy-0.1a0/vivaldy/__init__.py

@@ -0,0 +1,10 @@
+__license__ = "EUPL-1.2"
+__version__ = "0.1-alpha"
+__author__ = "Yann"
+__date__ = "2026-01-21"
+
+from vivaldy.vivaldy import (
+    MusicOnHold
+)
+
+__all__ = ['MusicOnHold']

vivaldy-0.1a0/vivaldy/main.py

@@ -0,0 +1,30 @@
+import time
+import vivaldy
+
+def main():
+
+    # audio = pydub.AudioSegment.from_wav('audio.wav')
+    # play(audio)
+
+    # async def play(audio, sample_rate=44100):
+    #     await loop.run_in_executor(None, sounddevice.play, audio, sample_rate)
+
+    # loop = asyncio.get_event_loop()
+    # loop.run_until_complete(play(audio, sample_rate=sample_rate))
+
+    ## Toy example for vivaldy
+
+    # Let's start waiting!
+    music = MusicOnHold()
+    music.start()
+
+    for i in range(10):
+        print(f"Processing {i+1:d}/10...")
+        time.sleep(5)
+
+    # And now we are done
+    music.done()
+
+
+if __name__ == '__main__':
+    main()

vivaldy-0.1a0/vivaldy/vivaldy.py

@@ -0,0 +1,91 @@
+#!/usr/bin/env python
+
+import os
+
+import ffmpeg
+import pydub
+import pytubefix
+from playsound3 import playsound
+
+# import asyncio
+# from pydub.playback import play
+# import sounddevice
+
+YT_DEFAULT_URL = 'https://www.youtube.com/watch?v=l-dYNttdgl0'
+
+HOLD_MESSAGE = "Please wait, your processing is going to start..."
+
+class MusicOnHold():
+
+    def __init__(self,
+                 src=YT_DEFAULT_URL,
+                 dest='vivaldy.wav',
+                 hold_message=HOLD_MESSAGE,
+                 start=False):
+        self.audio_source = src
+        self.audio_filepath = dest
+        self.audio_format = 'wav'
+        # self.ready = False
+
+        self.hold_message = hold_message
+        if self.hold_message:
+            print(self.hold_message)
+
+        if 'watch?v=' in self.audio_source:
+            self.youtube = pytubefix.YouTube(self.audio_source)
+            try:
+                self.download_audio()
+            except URLError:
+                # raise ValueError("Please provide a valid URL for music source")
+                # Temporary fallback solution
+                self.audio_source = 'vivaldy.wav'
+                self.audio_filepath = self.audio_source
+        else:
+            if not os.path.isfile(self.audio_source):
+                raise ValueError("Please provide a valid filepath for music source")
+
+        # Note: self-control is important while waiting
+        self.control = None
+
+    def download_audio(self):
+        # Get the URL of the video stream
+        stream_url = self.youtube.streams[0].url
+
+        # Probe the audio streams
+        probe = ffmpeg.probe(stream_url)
+        audio_streams = next((stream for stream in probe['streams'] \
+                              if stream['codec_type'] == 'audio'), None)
+        self.sample_rate = int(audio_streams['sample_rate'])
+
+        # Read audio into memory buffer.
+        # Get the audio using stdout pipe of ffmpeg sub-process.
+        # The audio is transcoded to PCM codec in WAC container.
+        # Select WAV output format, and pcm_s16le auidio codec. My add ar=sample_rate
+        self.audio_buffer, err = ffmpeg.input(stream_url) \
+                                       .output("pipe:",
+                                               format=self.audio_format,
+                                               acodec='pcm_s16le',
+                                               ar=self.sample_rate,
+                                               loglevel='quiet') \
+                                       .run(capture_stdout=True)
+
+        self.write_audio()
+
+    def write_audio(self):
+        # Write the audio buffer to file
+        with open(self.audio_filepath, 'wb') as f:
+            f.write(self.audio_buffer)
+
+    def start(self):
+        self.control = playsound(self.audio_filepath, block=False)
+
+    def stop(self):
+        if self.control is not None:
+            self.control.stop()
+
+    def done(self):
+        self.stop()
+
+    def wait(self):
+        if self.control.is_alive():
+            self.control.wait()

vivaldy-0.1a0/vivaldy.egg-info/PKG-INFO

@@ -0,0 +1,146 @@
+Metadata-Version: 2.4
+Name: vivaldy
+Version: 0.1a0
+Summary: Add music on hold to your Python code
+Author-email: Yann <phd@yannziegler.com>
+License-Expression: EUPL-1.2
+Project-URL: Homepage, https://github.com/yannziegler/vivaldy
+Project-URL: Issues, https://github.com/yannziegler/vivaldy/issues
+Keywords: music on hold,Vivaldi,musique d'attente
+Classifier: Development Status :: 3 - Alpha
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE.md
+Requires-Dist: audioop-lts>=0.2.2
+Requires-Dist: ffmpeg-python>=0.2.0
+Requires-Dist: playsound3>=3.3.0
+Requires-Dist: pydub>=0.25.1
+Requires-Dist: pytubefix>=10.3.6
+Dynamic: license-file
+
+# Vivaldy
+
+🎼 Your obligatory Python addition dedicated to the tastefully improvement of
+your waiting experience while running long and/or slow scripts.
+
+Keywords: music on hold, musique d'attente, ASSEDIC, Vivaldi
+
+🎹 Developed and maintained by Yann,
+inspired by an original idea from Jeanne and Thomas.
+
+> 🎧 **Stay tuned!** Vivaldy is being actively developed; new features may be
+added any time.
+
+## Description
+
+Vivaldy is to your Python code what Vivaldi is to your phone calls to public
+administration and other serious organisations. It is a natural and unmissable
+addition to any Python code that requires a long waiting time when running.
+
+It is _scientifically proven™_
+([Hul _et al._ 1997](https://doi.org/10.1016/S0022-4359%2897%2990016-6))
+that waiting music has a positive impact on the user experience.
+
+Be careful, however, as the valence of your selected waiting music may
+influenced the perceived waiting time: it has been established that "perceived
+duration was longest for subjects exposed to positively valenced (major key)
+music, and shortest for negatively valenced (atonal) music"
+[Kellaris & Kent (1992)](https://doi.org/10.1016/S1057-7408%2808%2980060-5).
+
+Short historical background (en français):
+<https://www.rtbf.be/article/mozart-et-vivaldi-les-stars-de-la-musique-d-attente-telephonique-11284821>
+
+## Installation
+
+If needed, create a dedicated environment:
+
+```
+conda create -n vivaldy
+```
+
+Alternatively, for testing purpose, you may want to clone an existing
+environment:
+
+```
+conda create -n myenv_with_vivaldy --clone myenv
+```
+
+Activate the environment you just created, or another existing environment of
+your choice:
+
+```
+conda activate MY_ENV_FOR_VIVALDY
+```
+
+Then, from within `vivaldy` base folder:
+
+```
+conda install -c conda-forge --yes --file requirements.txt
+pip install -r pip_requirements.txt
+pip install .
+```
+
+Ensure everything is working properly by trying to import and run `vivaldy`:
+
+```python
+import vivaldy
+music = vivaldy.MusicOnHold().start()
+music.stop()
+```
+
+You shouldn't get any error running this short script.
+
+## Documentation
+
+More coming sooner or later. For now, it is as simple as it can get:
+
+```python
+## Vivaldy toy example
+import vivaldy
+import time # only for testing
+
+# Let's start waiting!
+music = vivaldy.MusicOnHold()
+music.start()
+# ...or simply vivaldy.MusicOnHold().start() with no handler
+
+for i in range(10):
+    print(f"Processing {i+1:d}/10...")
+    # Some very important processing...
+    time.sleep(5)
+
+# And now we are done
+music.done() # This line is not required
+
+# Use music.wait() to wait till the end of the music
+# (not recommended due to potential productivity loss)
+```
+
+## Known major or minor bugs
+
+No tonal bugs in there.
+
+## Future
+
+- Restart music while needed
+- Periodic announcements about estimated waiting time
+- Integrate with `tqdm`
+
+## Tools used
+
+- Coding: Emacs with Spacemacs config
+- Python packages: see (pip_)requirements.txt
+
+## Licence
+
+This software is licensed under the [EUPL](LICENSE.md).
+
+## Acknowledgements
+
+Many thanks to all the current and future beta-testers!
+
+To Vivaldi and Mozart as well, and of course to
+[Alfred Levy](https://en.wikipedia.org/wiki/Music_on_hold).
+

vivaldy-0.1a0/vivaldy.egg-info/SOURCES.txt

@@ -0,0 +1,11 @@
+LICENSE.md
+README.md
+pyproject.toml
+vivaldy/__init__.py
+vivaldy/main.py
+vivaldy/vivaldy.py
+vivaldy.egg-info/PKG-INFO
+vivaldy.egg-info/SOURCES.txt
+vivaldy.egg-info/dependency_links.txt
+vivaldy.egg-info/requires.txt
+vivaldy.egg-info/top_level.txt

vivaldy-0.1a0/vivaldy.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

vivaldy-0.1a0/vivaldy.egg-info/requires.txt

@@ -0,0 +1,5 @@
+audioop-lts>=0.2.2
+ffmpeg-python>=0.2.0
+playsound3>=3.3.0
+pydub>=0.25.1
+pytubefix>=10.3.6

vivaldy-0.1a0/vivaldy.egg-info/top_level.txt

@@ -0,0 +1 @@
+vivaldy