Skip to content
This repository was archived by the owner on Dec 23, 2021. It is now read-only.

Replace simpleaudio library with playsound library and update docs #64

Merged
merged 2 commits into from
Jul 20, 2019

Conversation

jonathanwangg
Copy link
Contributor

Description:

We're replacing the simpleaudio library with the playsound library in order to remove the Visual Studio Build Tools dependency. The dependency was very large and was a hassle for users to setup our project. The corresponding documentation has been updated as well to reflect this change of libraries.

Type of change

  • New feature (non-breaking change which adds functionality)
  • This change requires a documentation update

Testing:

  • Try different paths for cpx.playfile() (e.g. in the same directory, nested in a folder)
  • Make sure the errors are getting printed properly and that the sound is playing correctly only for .wav files
  • Non-wav files should be result in an error

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • Any dependent changes have been merged and published in downstream modules

Copy link
Member

@LukeSlev LukeSlev left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM dude

Copy link
Contributor

@Christellah Christellah left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great replacement ! Thanks for the quick fix, just one suggestion

@@ -19,7 +19,7 @@ This project incorporates components from the projects listed below. The origina
12. Microsoft MakeCode (https://github.com/microsoft/pxt)
13. MakeCode for Adafruit Circuit Playground Express (https://github.com/microsoft/pxt-adafruit)
14. Python for Win32 (https://github.com/mhammond/pywin32)
15. Simple Audio (https://github.com/hamiltron/py-simple-audio)
15. playsound (https://github.com/TaylorSMarks/playsound)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would you consider writing playsound first letter with an uppercase since we've been using that for the others ? In the entire file

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I chose to use lowercase since it appears as lowercase in https://pypi.org/project/playsound/ . Do you still want me to use lowercase?

@LukeSlev
Copy link
Member

@jonathanwangg now that PR 66 has landed there are some more documentation changes needed for this PR! specifically ripping out all simpleaudio references

@jonathanwangg jonathanwangg merged commit 59ce0a9 into dev Jul 20, 2019
@jonathanwangg jonathanwangg deleted the users/t-jowang/simpleaudio-replacement branch August 7, 2019 22:53
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants