https://github.com/b3b/pythonhere

Interactive remote code execution app
https://github.com/b3b/pythonhere

Last synced: 3 months ago
JSON representation

Interactive remote code execution app

• Host: GitHub
• URL: https://github.com/b3b/pythonhere
• Owner: b3b
• License: mit
• Created: 2020-12-05T09:58:00.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2021-02-14T21:39:51.000Z (almost 4 years ago)
• Last Synced: 2024-09-29T13:20:41.335Z (4 months ago)
• Language: Python
• Homepage:
• Size: 397 KB
• Stars: 7
• Watchers: 3
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGELOG.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
PythonHere

==========

.. start-badges

.. image:: https://img.shields.io/pypi/status/pythonhere

    :target: https://pypi.python.org/pypi/pythonhere

    :alt: Status

.. image:: https://img.shields.io/pypi/v/pythonhere.svg

    :target: https://pypi.python.org/pypi/pythonhere

    :alt: Latest version on PyPi

.. image:: https://img.shields.io/docker/v/herethere/pythonhere?color=%23FFD43B&label=Docker%20Image

   :target: https://hub.docker.com/r/herethere/pythonhere

   :alt: Docker Image Version (latest by date)

.. image:: https://img.shields.io/pypi/pyversions/pythonhere.svg

    :target: https://pypi.python.org/pypi/pythonhere

    :alt: Supported Python versions

.. image:: https://github.com/b3b/pythonhere/workflows/ci/badge.svg?branch=master

     :target: https://github.com/b3b/pythonhere/actions?workflow=CI

     :alt: CI Status

.. image:: https://codecov.io/github/b3b/pythonhere/coverage.svg?branch=master

    :target: https://codecov.io/github/b3b/pythonhere?branch=master

    :alt: Code coverage Status

.. end-badges

*Here* is the `Kivy `_ based app to run Python code from the `Jupyter `_ magic %there.

- *Here* is a server part with the GUI interface. It could be Android, Raspberry Pi, some other remote device that being debugged.

- And *%there* is a client - Jupyter magic command to run code interactively on remote device.

This app could serve as a Python Kivy playground, for dynamic code execution from the PC.

Project documentation: https://herethere.me

.. image:: https://raw.githubusercontent.com/b3b/pythonhere/master/docs/description.png

  :alt: Project description

Install on Android

------------------

App is available on `Google Play `_.

Ready-to-use *PythonHere* APKs are available in the `Releases `_ section.

For a list of installed Python packages, see: `buildozer.spec <./buildozer.spec>`_.

Quick Start with Docker

-----------------------

Docker image is based on `Jupyter Docker Stacks `_, and includes installed *PythonHere* with usage examples.

Example command to start the Docker container::

    docker run \

           --rm \

           -p 8888:8888 \

           -v "$(pwd)/work":/home/jovyan/work \

           herethere/pythonhere:latest

Command will expose the Jupyter Notebook server on host port 8888. Jupyter logs appear in the terminal and include an URL to the notebook server: http://127.0.0.1:8888/?token=... . Visiting this URL in a browser loads the Jupyter Notebook dashboard page.

Files from the directory **work** inside container, will be available in the host directory with the same name: **work**.

Run with Docker Compose

-----------------------

Commands to run with Docker Compose, in the source directory:::

  cp docker-compose.yml.tmpl docker-compose.yml

  docker-compose up

Run locally

-----------

Commands to run locally::

   pip install pythonhere jupyter

   jupyter notebook

Build Android app

-----------------

To build with `Buildozer `_, run in the source directory::

  buildozer android debug

Related resources

-----------------

* `Kivy Remote Shell `_ : Remote SSH+Python interactive shell application

* `herethere `_ : Library for interactive code execution, based on AsyncSSH

* `AsyncSSH `_ : Asynchronous SSH for Python

* `Buildozer action `_ : GitHub action that is used to build Android APK with Buildozer