mpf 0.58.0.dev1__tar.gz → 0.58.0.dev4__tar.gz

mpf-0.58.0.dev4/.github/workflows/build_wheels.yml

@@ -0,0 +1,46 @@
+name: Wheel Builder
+
+on:
+  push:
+    tags:
+      - '*'
+
+jobs:
+  build_wheels:
+    name: Push new release to PyPI
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/mpf
+    permissions:
+      id-token: write
+
+    steps:
+      - name: Checkout MPF
+        uses: actions/checkout@v6
+
+      - name: Setup python
+        uses: actions/setup-python@v6
+        with:
+          python-version: 3.13
+
+      - name: Install MPF
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y '^libxcb.*-dev' libx11-xcb-dev libjpeg-dev
+          sudo apt-get install -y qt6-base-dev
+          pip install --upgrade pip setuptools wheel build
+          pip install -e .
+
+      - name: Run tests
+        run: python -m unittest discover -s mpf/tests
+
+      - name: Build wheel
+        run: python -m build
+
+      - uses: actions/upload-artifact@v7
+        with:
+          path: ./dist/*.*
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

mpf-0.58.0.dev4/.github/workflows/prospector.yml

@@ -0,0 +1,40 @@
+name: Lint all Python files
+
+on:
+  push:
+    branches:
+      - dev
+      - 0.57.x
+      - 0.58.x
+      - 0.80.x
+      - 0.81.x
+  pull_request:
+    branches:
+      - dev
+      - 0.57.x
+      - 0.58.x
+      - 0.80.x
+      - 0.81.x
+
+jobs:
+  prospector:
+    name: Run Prospector on all Python files
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v6
+
+      - name: Setup python
+        uses: actions/setup-python@v6
+        with:
+          python-version: 3.13
+
+      - name: Install MPF
+        run: |
+          sudo apt-get install -y libjpeg-dev
+          pip install --upgrade pip setuptools wheel build prospector
+          pip install -e .
+
+      - name: Run Prospector
+        run: prospector

mpf-0.58.0.dev4/.github/workflows/run_tests.yml

@@ -0,0 +1,114 @@
+name: Test on all platforms
+
+on:
+  push:
+    branches:
+      - dev
+      - 0.57.x
+      - 0.58.x
+      - 0.80.x
+      - 0.81.x
+  pull_request:
+    branches:
+      - dev
+      - 0.57.x
+      - 0.58.x
+      - 0.80.x
+      - 0.81.x
+
+jobs:
+  tests:
+    name: Test Python ${{ matrix.python-version }} on ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+        - os: windows-latest
+          python-version: "3.10"
+        - os: windows-latest
+          python-version: 3.11
+        - os: windows-latest
+          python-version: 3.12
+        - os: windows-latest
+          python-version: 3.13
+        - os: windows-latest
+          python-version: 3.14
+        - os: ubuntu-latest
+          python-version: "3.10"
+        - os: ubuntu-latest
+          python-version: 3.11
+        - os: ubuntu-latest
+          python-version: 3.12
+        - os: ubuntu-latest
+          python-version: 3.13
+        - os: ubuntu-latest
+          python-version: 3.14
+        - os: macos-latest
+          python-version: "3.10"
+        - os: macos-latest
+          python-version: 3.11
+        - os: macos-latest
+          python-version: 3.12
+        - os: macos-latest
+          python-version: 3.13
+        - os: macos-latest
+          python-version: 3.14
+
+    steps:
+      - name: Checkout MPF
+        uses: actions/checkout@v6
+
+      - name: Setup python
+        uses: actions/setup-python@v6
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install jpeg support for pillow
+        shell: bash
+        run: |
+          if [ "${{ runner.os }}" == "Windows" ]; then
+            choco install libjpeg-turbo
+          elif [ "${{ runner.os }}" == "Linux" ]; then
+            # do nothing, Linux works without additional install
+            sudo apt-get install -y libjpeg-dev
+          else #must be mac!
+            brew install libjpeg-turbo
+          fi
+
+      - name: Install MPF
+        run: |
+          pip install --upgrade pip setuptools wheel build coveralls
+          pip install -e .
+
+      - name: Run tests
+      # Oct 15 2023, "coverage" randomly is not recognized as valid on windows
+      # even though you can see it being installed via pip (from coveralls)?!?
+        shell: bash  # Need bash on windows to use the if statement
+        run: |
+          if [ "${{ runner.os }}" == "Windows" ]; then
+            python3 -m unittest discover -s mpf/tests
+          else
+            python3 -m coverage run -m unittest discover -s mpf/tests
+          fi
+
+      - name: Upload coverage data to coveralls.io
+        if: matrix.os != 'windows-latest'
+        run: coveralls --service=github-actions
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          COVERALLS_FLAG_NAME: ${{ matrix.python-version }}-${{ matrix.os }}
+          COVERALLS_PARALLEL: true
+
+  coveralls:
+    name: Indicate completion to coveralls.io
+    needs: tests
+    runs-on: ubuntu-latest
+    container: python:3-slim
+    steps:
+    - name: Finished
+      run: |
+        pip3 install --upgrade coveralls
+        coveralls --service=github-actions --finish
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

mpf-0.58.0.dev4/PKG-INFO

@@ -0,0 +1,124 @@
+Metadata-Version: 2.4
+Name: mpf
+Version: 0.58.0.dev4
+Summary: The Mission Pinball Framework (MPF)
+Author-email: The Mission Pinball Framework Team <brian@missionpinball.org>
+License: MIT
+Project-URL: homepage, https://missionpinball.org
+Project-URL: support-forum, https://missionpinball.org/latest/community/
+Keywords: pinball
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Natural Language :: English
+Classifier: Operating System :: MacOS :: MacOS X
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Topic :: Artistic Software
+Classifier: Topic :: Games/Entertainment :: Arcade
+Requires-Python: <3.15,>=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE.md
+License-File: AUTHORS.md
+Requires-Dist: asciimatics==1.15.0
+Requires-Dist: packaging==23.2
+Requires-Dist: prompt_toolkit==3.0.43
+Requires-Dist: psutil==5.9.8
+Requires-Dist: pyserial==3.5
+Requires-Dist: pyserial-asyncio==0.6
+Requires-Dist: ruamel.yaml==0.18.6
+Requires-Dist: setuptools~=72.2.0
+Requires-Dist: sortedcontainers==2.4.0
+Requires-Dist: terminaltables==3.1.10
+Requires-Dist: Pillow>=10.4.0
+Provides-Extra: crash-reporter
+Requires-Dist: requests==2.28.2; extra == "crash-reporter"
+Provides-Extra: irc
+Requires-Dist: irc==19.0.1; extra == "irc"
+Provides-Extra: linux-i2c
+Requires-Dist: smbus2_asyncio==0.0.5; extra == "linux-i2c"
+Provides-Extra: osc
+Requires-Dist: python-osc==1.8.3; extra == "osc"
+Provides-Extra: pin2dmd
+Requires-Dist: pyusb==1.1.0; extra == "pin2dmd"
+Provides-Extra: zedmd
+Requires-Dist: numpy>=1.7.0; extra == "zedmd"
+Provides-Extra: rpi
+Requires-Dist: apigpio-mpf==0.0.4; extra == "rpi"
+Provides-Extra: uvloop
+Requires-Dist: uvloop==0.19.0; extra == "uvloop"
+Provides-Extra: vpe
+Requires-Dist: grpcio_tools==1.69.0; extra == "vpe"
+Requires-Dist: grpcio==1.69.0; extra == "vpe"
+Requires-Dist: protobuf==5.29.3; extra == "vpe"
+Provides-Extra: all
+Requires-Dist: prompt_toolkit==3.0.43; extra == "all"
+Requires-Dist: asciimatics==1.15.0; extra == "all"
+Requires-Dist: terminaltables==3.1.0; extra == "all"
+Requires-Dist: requests==2.28.2; extra == "all"
+Requires-Dist: irc==19.0.1; extra == "all"
+Requires-Dist: smbus2_asyncio==0.0.5; extra == "all"
+Requires-Dist: python-osc==1.8.3; extra == "all"
+Requires-Dist: pyusb==1.1.0; extra == "all"
+Requires-Dist: apigpio-mpf==0.0.4; extra == "all"
+Requires-Dist: grpcio_tools==1.69.0; extra == "all"
+Requires-Dist: grpcio==1.69.0; extra == "all"
+Requires-Dist: protobuf==5.29.3; extra == "all"
+Requires-Dist: uvloop==0.19.0; extra == "all"
+Dynamic: license-file
+
+Mission Pinball Framework (MPF)
+===============================
+
+<img align="center" height="146" src="https://missionpinball.org/latest/images/mpf-logo-full.png"/>
+
+<em>...Let's build a pinball machine!</em>
+
+What is Mission Pinball Framework?
+----------------------------------
+
+Mission Pinball Framework (MPF) is open source, cross-platform software for powering real pinball
+machines. MPF is a community-developed project released under the MIT license. It's supported by volunteers in their spare time.
+
+[![Coverage Status](https://coveralls.io/repos/github/missionpinball/mpf/badge.svg?branch=dev)](https://coveralls.io/github/missionpinball/mpf?branch=dev)
+[![Test Status](https://github.com/missionpinball/mpf/actions/workflows/run_tests.yml/badge.svg)](https://github.com/missionpinball/mpf/actions/workflows/run_tests.yml)
+[![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/1687/badge)](https://bestpractices.coreinfrastructure.org/projects/1687)
+
+Visit the MPF project homepage at https://missionpinball.org. Additional related projects exist as part of the MPF ecosystem, including the "MPF Monitor" which is a graphical application that lets you simulate pinball hardware, and "MPF-MC" which is a media controller which provides graphics and sounds for pinball machines.
+
+Documentation
+-------------
+
+* User Docs (installation, tutorials, & reference): https://missionpinball.org
+
+Support
+-------
+
+MPF is an open source community project which has no official support. Some MPF users participate in the MPF-Users Google group or GitHub Discussion. Links [here](https://missionpinball.org/latest/community/).
+
+Individual pinball hardware companies may provide additional support for users of their hardware, often via their own Slack, Discord, or other chat groups. If you get stuck, you can ask for help in the MPF-users group, or you reach out to your hardware provider.
+
+Maintenance, Pull Requests, & Bug Fixes
+---------------------------------------
+
+As a community project, we welcome pull requests and bug fixes. However, we do not have the resources to provide support for MPF. If you are interested in becoming a maintainer, please contact us at brian@missionpinball.org.
+
+Bugs or other issues related to MPF itself can be posted to the [MPF Discussions page on GitHub](https://missionpinball.org/latest/community/).
+
+Contributing
+------------
+
+Individual pinball hardware makers are responsible for their own platform interface maintenance and contributions.
+
+MPF is a passion project created and maintained by volunteers. If you're a Python coder, documentation writer, or pinball maker, feel free to make a change and submit a pull request. For more information about contributing see the [Contributing Code](https://missionpinball.org/latest/about/contributing_to_mpf/)
+and [Contributing Documentation](https://missionpinball.org/latest/about/help_docs/) pages.
+
+License
+-------
+
+MPF and related projects are released under the MIT License. Refer to the LICENSE file for details. Docs are released under Creative Commons CC BY 4.0.

mpf-0.58.0.dev4/README.md

@@ -0,0 +1,50 @@
+Mission Pinball Framework (MPF)
+===============================
+
+<img align="center" height="146" src="https://missionpinball.org/latest/images/mpf-logo-full.png"/>
+
+<em>...Let's build a pinball machine!</em>
+
+What is Mission Pinball Framework?
+----------------------------------
+
+Mission Pinball Framework (MPF) is open source, cross-platform software for powering real pinball
+machines. MPF is a community-developed project released under the MIT license. It's supported by volunteers in their spare time.
+
+[![Coverage Status](https://coveralls.io/repos/github/missionpinball/mpf/badge.svg?branch=dev)](https://coveralls.io/github/missionpinball/mpf?branch=dev)
+[![Test Status](https://github.com/missionpinball/mpf/actions/workflows/run_tests.yml/badge.svg)](https://github.com/missionpinball/mpf/actions/workflows/run_tests.yml)
+[![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/1687/badge)](https://bestpractices.coreinfrastructure.org/projects/1687)
+
+Visit the MPF project homepage at https://missionpinball.org. Additional related projects exist as part of the MPF ecosystem, including the "MPF Monitor" which is a graphical application that lets you simulate pinball hardware, and "MPF-MC" which is a media controller which provides graphics and sounds for pinball machines.
+
+Documentation
+-------------
+
+* User Docs (installation, tutorials, & reference): https://missionpinball.org
+
+Support
+-------
+
+MPF is an open source community project which has no official support. Some MPF users participate in the MPF-Users Google group or GitHub Discussion. Links [here](https://missionpinball.org/latest/community/).
+
+Individual pinball hardware companies may provide additional support for users of their hardware, often via their own Slack, Discord, or other chat groups. If you get stuck, you can ask for help in the MPF-users group, or you reach out to your hardware provider.
+
+Maintenance, Pull Requests, & Bug Fixes
+---------------------------------------
+
+As a community project, we welcome pull requests and bug fixes. However, we do not have the resources to provide support for MPF. If you are interested in becoming a maintainer, please contact us at brian@missionpinball.org.
+
+Bugs or other issues related to MPF itself can be posted to the [MPF Discussions page on GitHub](https://missionpinball.org/latest/community/).
+
+Contributing
+------------
+
+Individual pinball hardware makers are responsible for their own platform interface maintenance and contributions.
+
+MPF is a passion project created and maintained by volunteers. If you're a Python coder, documentation writer, or pinball maker, feel free to make a change and submit a pull request. For more information about contributing see the [Contributing Code](https://missionpinball.org/latest/about/contributing_to_mpf/)
+and [Contributing Documentation](https://missionpinball.org/latest/about/help_docs/) pages.
+
+License
+-------
+
+MPF and related projects are released under the MIT License. Refer to the LICENSE file for details. Docs are released under Creative Commons CC BY 4.0.

mpf-0.58.0.dev4/docs/dev/Send variables via self.machine.events.post.rst

@@ -0,0 +1,28 @@
+Post variables via self.machine.events.post:
+============================================
+for basic info on ``self.machine.events.post`` and how to add event_handlers check the following section
+
+http://developer.missionpinball.org/en/dev/api/self.machine.events.html?highlight=event_handler
+
+The best example here is to use the communication between MPF and MPF MC.
+MPF MC can pretty much only read variables from ``self.player`` from MPF (``self.mc.player`` in MC),  however you simply don't want
+to create extra variables in here just to make it readable readable in MC. This would result in having to much unnecessary data.
+Instead you can use ``self.machine.events.post`` just like you would write a function in python.
+
+For example we set this up in a mode code in MPF:
+
+.. code-block:: python
+
+  variable_i_want_to_send = "King of the Hill"
+  more_data_i_want_to_send = "1st"
+  self.machine.events.post('awesome_event', data1=variable_i_want_to_send, data2=more_data_i_want_to_send)
+
+It should always start with the ``event`` that you want to post. After this you can only add ``positional arguments``.
+In MC code we create a function that will be activated once the event is posted. Make sure you have added a event_handler first or else it won't work.
+
+.. code-block:: python
+
+  def awesome_event(self, data1, data2, **kwargs):
+    print("i really love the game {} I always end up {}".format(data1, data2)
+
+That is all there is to it.

mpf-0.58.0.dev4/docs/overview/installation.rst

@@ -0,0 +1,54 @@
+How MPF installs itself
+=======================
+
+This guide explains what happens when MPF is installed.
+
+MPF contains a ``setup.py`` file in the root of the MPF repository. This is the file that's called by *pip* when MPF is
+installed. (You can also install MPF without using pip by running ``python3 setup.py`` from the root folder.)
+
+Dependencies
+------------
+
+MPF requires Python 3.4 or newer. In our installation instructions, we also recommend that users install/update the
+following Python packages to their latest versions:
+
+* ``pip``
+* ``setuptools`` (for Linux & Mac)
+* ``Cython 0.24.1`` (for Linux & Mac)
+
+The additional packages for Linux & Mac are used because MPF-MC is actually compiled on built on those platforms. For
+Windows we have pre-built wheels, so compiling is not necessary.
+
+MPF has the following additional dependencies which are specified in the setup.py file and automatically installed when
+MPF is installed.
+
+* ``ruamel.yaml`` >=0.15: Used for reading & writing YAML files.
+* ``pyserial`` >= 3.5.0: Used for serial communication with several types of hardware
+* ``pyserial-asyncio`` >= 0.4: Also used for serial communication
+* ``sortedcontainers`` >= 2.3.0
+* ``asciimatics`` >= 1.12.0
+* ``terminaltables`` >= 3.1.0
+* ``psutil`` >= 5.7.3
+* ``grpcio_tools`` >= 1.34.0
+* ``grpcio`` >= 1.34.0
+* ``protobuf`` >= 3.14.0
+* ``prompt_toolkit`` >= 3.0.8
+* ``typing`` Used for type-checking & type hinting. This is built-in to Python versions above 3.5.
+
+Note that some of these dependencies will install their own dependencies.
+
+The setup.py file also specifies a `console_scripts entry point <http://python-packaging.readthedocs.io/en/latest/command-line-scripts.html#the-console-scripts-entry-point>`_
+called ``mpf``. This is what lets the user type ``mpf`` from the command environment to launch MPF.
+
+In order to build the developer documentation, you will also need:
+
+* ``sphinx``
+* ``sphinx_rtd_theme``
+* ``sphinxcontrib.napoleon``
+* ``gitpython``
+
+Building the developer documentation requires a symbolic link from ``mpf\docs\examples`` to a checkout of the ``mpf-examples`` repository.
+This is normally automatically created when the documentation is built, but under Windows 10 and higher, symlinks can only be created by
+administrators, so the process will fail. If you would prefer not to run the build as an administrator, you can create the link manually
+by running ``mklink /d examples <examples directory>`` at the command line from inside the ``docs`` directory.
+

mpf-0.58.0.dev4/docs/testing/running_mpf_tests.rst

@@ -0,0 +1,79 @@
+How to run MPF unittests
+========================
+
+Once MPF is installed, you can run some automated tests to make sure that
+everything is working. To do this, open a command prompt, and then type the
+following command and then press <enter>:
+
+::
+
+  python3 -m unittest discover mpf/tests
+
+When you do this, you should see a bunch of dots on the screen (one for each
+test that's run), and then when it's done, you should see a message showing
+how many tests were run and that they were successful. The whole process should
+take less a minute or so.
+
+Note that ``mpf-mc`` must be installed as well as ``mpf`` for all tests to run.
+If it isn't, some tests will fail with the error "start took more than 20s", because
+MPF waited endlessly for the nonexistent media controller to be available.
+
+(If you see any messages about some tests taking more than 0.5s, that's ok.)
+
+The important thing is that when the tests are done, you should have a message
+like this:
+
+::
+
+   Ran 587 tests in 27.121s
+
+   OK
+
+   C:\>
+
+Note that the number of tests is changing all the time, so it probably won't
+be exactly 587. And also the time they took to run will be different depending
+on how fast your computer is.
+
+These tests are the actual tests that the developers of MPF use to test MPF
+itself. We wrote all these tests to make sure that updates and changes we add
+to MPF don't break things. :) So if these tests pass, you know your MPF
+installation is solid.
+
+Remember though that MPF is actually two separate parts, the MPF game engine and
+the MPF media controller. The command you run just tested the game engine, so
+now let's test the media controller. To do this, run the following command
+(basically the same thing as last time but with an "mc" added to the end, like
+this):
+
+::
+
+  python3 -m unittest discover mpfmc/tests
+
+(Note that ``mpfmc`` does not have a dash in it, like it did when you installed
+it via *pip*.)
+
+When you run the MPF-MC tests, you should see a graphical window pop up on the
+screen, and many of the tests will put graphics and words in that window. Also,
+some of the tests include audio, so if your speakers are on you should hear some
+sounds at some point.
+
+These tests take significantly longer (maybe 8x) than the MPF tests, but when they're done, that
+graphical window should close, and you'll see all the dots in your command
+window and a note that all the tests were successful.
+
+Notes about the MPF-MC tests:
+
+ * These tests create a window on the screen and then just re-use the same
+   window for all tests (to save time). So don't worry if it looks like the
+   window content is scaled weird or blurry or doesn't fill the entire window.
+
+ * Many of these tests are used to test internal workings of
+   the media controller itself, so there will be lots of time when the pop up
+   window is blank or appears frozen since the tests are testing non-visual
+   things.
+
+ * The animation and transition tests include testing functionality to stop,
+   restart, pause, and skip frames. So if things look "jerky" in the tests,
+   don't worry, that doesn't mean your computer is slow, it's just how the
+   tests work! :)

mpf-0.58.0.dev4/mpf/_version.py

@@ -0,0 +1,50 @@
+"""Holds various Version strings of MPF.
+
+This modules holds the MPF version strings, including the version of BCP it
+needs and the config file version it needs.
+
+It's used internally for all sorts of things, from printing the output of the
+`mpf --version` command, to making sure any processes connected via BCP are
+the proper versions, to automatically triggering new builds and deployments to
+PyPI.
+
+"""
+
+__version__ = '0.58.0.dev4'  # Also consider whether MPF-MC pyproject.toml should be updated
+'''The full version of MPF.'''
+
+__short_version__ = '0.58'
+'''The major.minor version of MPF.'''
+
+__bcp_version__ = '1.1'
+'''The version of BCP this build of MPF uses.'''
+
+__config_version__ = '6'
+'''The config file version this build of MPF uses.'''
+
+__show_version__ = '6'
+'''The show format version this build of MPF uses.'''
+
+# pylint: disable-msg=invalid-name
+version = "Mission Pinball Framework v{}".format(__version__)
+'''A friendly version string for this build of MPF.'''
+# TODO change back before mainlining
+
+# pylint: disable-msg=invalid-name
+extended_version = "Mission Pinball Framework v{}, Config version:{}, Show version: {}, " \
+                   "BCP version:{}".format(__version__, __config_version__,
+                                           __show_version__, __bcp_version__)
+'''An extended version string that includes the MPF version, show version,
+and BCP versions used in this build of MPF.'''
+
+log_url = "https://missionpinball.org/latest/logs"
+# TODO make dynamic "https://docs.missionpinball.org/en/dev/logs/{}.html"
+
+__api__ = ['version',
+           '__short_version__',
+           '__bcp_version__',
+           '__config_version__',
+           '__show_version__',
+           'version',
+           'extended_version',
+           'log_url']