https://github.com/jerluc/qdpy

A quickly distributed IPython environment
https://github.com/jerluc/qdpy

Last synced: 24 days ago
JSON representation

A quickly distributed IPython environment

• Host: GitHub
• URL: https://github.com/jerluc/qdpy
• Owner: jerluc
• License: apache-2.0
• Created: 2016-03-04T17:01:11.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2016-03-15T18:39:18.000Z (almost 9 years ago)
• Last Synced: 2024-11-05T20:41:19.072Z (2 months ago)
• Language: Python
• Homepage:
• Size: 16.6 KB
• Stars: 0
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
qdpy

====

.. image:: https://api.travis-ci.org/jerluc/qdpy.svg?branch=master

    :alt: Build Status

    :target: https://travis-ci.org/jerluc/qdpy

.. image:: https://readthedocs.org/projects/qdpy/badge/?version=latest

    :alt: Documentation Status

    :target: https://readthedocs.org/projects/qdpy/?badge=latest

`qdpy `_ is a quickly distributed IPython environment

Quick links

-----------

* `Documentation `_

* `Source `_

Installation

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

qdpy requires `IPython `_ to be installed. If you don't already have IPython

installed, your life condition is probably going to dramatically improve after you `download and

install it `_ :)

.. parsed-literal::

    git clone [email protected]:jerluc/qdpy.git

    cd qdpy

    pip install .

Usage

-----

Once installed, qdpy must be loaded into your IPython shell using the ``%load_ext`` magic:

.. parsed-literal::

    In[1]: %load_ext qdpy

If you'd like to auto-load qdpy anytime you open an IPython shell, add the following to your

IPython config file (usually this is located in `~/.ipython/profile_default/ipython_config.py`):

.. parsed-literal::

    c = get_config()

    # ...

    c.InteractiveShellApp.extensions = [

        'qdpy'

    ]

Once qdpy is loaded, you may join or leave collaboration groups using the ``%join_group `` or

``%leave_group `` magics

The qdpy source code is `hosted on GitHub `_.