Skip to content

PureMVC/puremvc-python-multicore-framework

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

33 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

PureMVC Python MultiCore Framework Python package

PureMVC is a lightweight framework for creating applications based upon the classic Model-View-Controller design meta-pattern. It supports modular programming through the use of Multiton Core actors instead of the Singletons used in the Standard Version.

Installation

pip install PureMVC

Development

Install Dependency (Editable Package)

pip install -e .

Type Checking

pip install mypy
mypy ./src

Testing

pytest test/

Build & Publish

python -m build
twine upload dist/*

Generate Documentation with Sphinx

  • Install Sphinx and theme:

    pip install sphinx sphinx_rtd_theme
  • Initialize Docs

    mkdir docs && cd docs 
    sphinx-quickstart --sep -p PureMVC -a "Saad Shams" -v "2.0" -r "2.0.0" -l "en"
  • Generate API docs and build HTML:

    cd ../ && sphinx-apidoc -o docs/source src/puremvc && cd docs && make html && cd .. && open docs/build/html/index.html
  • To update docs after code changes:

    sphinx-apidoc -o docs/source src/puremvc --force && cd docs && make html && cd .. && open docs/build/html/index.html
  • Snippet: conf.py

    import os
    import sys
    sys.path.insert(0, os.path.abspath(os.path.join(os.path.dirname(__file__), '..', '..', 'src')))
    extensions = ['sphinx.ext.autodoc']
    html_theme = 'sphinx_rtd_theme'
  • Snippet: index.rst

    13: modules
    

Status

Production - Version 2.0.2

Platforms / Technologies

Reference

License

  • PureMVC MultiCore Framework for Python - Copyright © 2025 Saad Shams

  • PureMVC - Copyright © 2025 Futurescale, Inc.

  • All rights reserved.

  • Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

    • Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
    • Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
    • Neither the name of Futurescale, Inc., PureMVC.org, nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

About

PureMVC Multicore Framework for Python

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 2

  •  
  •  

Languages