Metadata-Version: 2.1
Name: pyfxr
Version: 0.2.0
Summary: SFXR clone using Pygame and Cython
Home-page: https://github.com/lordmauve/pyfxr
Author: Daniel Pope
Author-email: mauve@mauveweb.co.uk
License: UNKNOWN
Description: # pyfxr
        
        Sound effects generation for Python, compatible with Pygame and Pyglet.
        
        
        ## Installation
        
        `pyfxr` is on PyPI and pre-compiled for Mac, Windows and Linux. You can install
        the library with
        
        ```
        pip install pyfxr
        ```
        
        ## Documentation
        
        [Full API documentation](https://pyfxr.readthedocs.io/)
        
        
        ## Pygame Usage
        
        ```
        # Set mixer to 44kHz mono
        pygame.mixer.pre_init(44100, channels=1)
        
        # Generate a sound
        tone = pygame.mixer.Sound(
            buffer=pyfxr.pluck(duration=1.0, pitch='A4')
        )
        
        # Play it
        tone.play()
        ```
        
        ## Usage with Pyglet
        
        ```
        # Generate a random explosion sound
        explosion = pyglet.media.StaticSource(pyfxr.explosion())
        
        # Play it
        explosion.play()
        ```
        
        ## Usage with sounddevice
        
        ```
        import sounddevice
        import pyfxr
        
        sounddevice.play(pyfxr.jump(), pyfxr.SAMPLE_RATE)
        ```
        
        ## GUI
        
        A Pygame GUI is in development, to explore the feature set and create music!
        
        To install the Pygame-based GUI along with the library, use:
        
        ```
        pip install pyfxr[gui]
        ```
        
        Then you can run the GUI by running `pyfxr`.
        
        ![Screenshot](docs/_static/keyboard.png)
        
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python :: 3
Description-Content-Type: text/markdown
Provides-Extra: gui
