Skip to main content

Make macros easily with macropython

Project description

# macropython

class RecordMacro

    args:
        _filename : ``str`` - the file to output to.
        _startup_delay : ``float`` - the delay before recording inputs
        _enable_output : ``bool`` - should print debug info

    methods:

        logic() - the function for saving macro data
            ~ note: this method should not be used manually, it is used my the class itself

        start(startup_delay : ``float``) - use this method is called to start recording input
        args:
            startup_delay : ``float`` - this args is optional, dont pass anything to skip
        ~ note: after the recording is started, use the ESC or Escape key to stop recording

class PlayMacro

    args:

        _filename : ``str`` - the file to load the macro from
        _startup_delay : ``float`` - the delay before recording inputs
        _enable_output : ``bool`` - should print debug info

    methods:

        start(startup_delay : ``float``) - use this function to play the macro
        args:
            startup_delay : ``float`` - this args is optional, dont pass anything to skip
        ~ note: after the recording is started, close the python program to quit playing

class HotKeyMacro

    args:

        _data_ : ``list`` - this is a ``list`` of ``dict``
            info:

                the ``dict``s inside the ``list`` are structured as shown below
                {
                    'trigger' : ``str`` - the key that starts the macro

                    'file' : ``str`` - the location of the macro

                    'repeat' : ``bool`` - repeat the macro forever until the trigger is released
                        ~ note: if set to False, the macro will only once when the trigger is pressed

                    'delay' : ``float`` - time to wait before repeating the macro again
                        ~ note: will only wait if repeat is set to True
                }


        _startup_delay : ``float`` - the delay before recording inputs
        _enable_output : ``bool`` - should print debug info

    methods:
    
        start(startup_delay : ``float``) - use this function to start the hot key macros
        args:
            startup_delay : ``float`` - this args is optional, dont pass anything to skip
        logic() - the function for triggering macros
            ~ note: this method should not be used manually, it is used my the class itself
        _stop_all_threads() - this is to stop all macros
            ~ note: this method should not be used manually, it is used my the class itself
        _play_thread(index : ``int``) - this function is used for each macro 
            ~ note: this method should not be used manually, it is used my the class itself

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

macropython-0.0.1.0.tar.gz (7.4 kB view hashes)

Uploaded Source

Built Distribution

macropython-0.0.1.0-py3-none-any.whl (10.6 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page