Giter Club home page Giter Club logo

mayflower's Introduction

mayflower

Cross the Atlantic by running Python from JavaScript.

The underlying protocol is a forked and trimmed version of JSPyBridge's pythonia package.

Alterations include:

  • Running from a browser context.
  • Communicating via a WebSocket instead of a IO stream or pipe.
  • Relies on the server being available already rather than spawned on first use.
  • Built-in and transparent support for Python's asyncio.

This package does not yet supported connections over the internet; the intended use is in suites where the same localhost is available to both the browser and Python runtime.

Usage

This tool is both a JS package and Python package. In JS environments, note that this package requires support for ES2017 and above. Transpilation, due to how it handles async / await, is not guaranteed to work.

$ poetry add git+https://github.com/thearchitector/mayflower.git
$ yarn add mayflower@[email protected]:thearchitector/mayflower.git

To start the websocket server, you can invoke mayflower as a module: python -m mayflower. Using the package in browser will automatically start the websocket client and listen.

For unified applications, like using this tool to invoke Python utilities with a Cypress suite, it's recommended to use concurrently to ensure cleanup happens if the websocket fails / disconnects:

$ yarn add concurrently
# -u is required for Python to flush logs to stdout / stderr
$ concurrently "python -um mayflower" "cypress open"

See the JSPyBridge documentation for the syntactical sugar.

License

This package is license under BSD-3-Clause.

JSPyBridge, which this package is based on, is licensed under MIT.

mayflower's People

Contributors

thearchitector avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.