ped


Nameped JSON
Version 1.5.1.post0 PyPI version JSON
download
home_pagehttps://github.com/sloria/ped
SummaryQuickly open Python modules in your text editor.
upload_time2018-01-13 02:15:47
maintainer
docs_urlNone
authorSteven Loria
requires_python
licenseMIT
keywords commandline cli open editor editing
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI
coveralls test coverage No coveralls.
            ===
ped
===

.. image:: https://img.shields.io/pypi/v/ped.svg
    :target: https://pypi.python.org/pypi/ped
    :alt: Latest version

.. image:: https://img.shields.io/travis/sloria/ped.svg
    :target: https://travis-ci.org/sloria/ped
    :alt: Travis-CI

Quickly open Python modules in your text editor.

.. code-block:: bash

    $ ped django
    $ ped django.core.urlresolvers
    $ ped django.views.generic.TemplateView

    # Partial name matching
    $ ped django.http.resp
    Editing django.http.response...
    ...Done.

    # Specify which editor to use
    $ PED_EDITOR=vim ped django.shortcuts


``ped`` will find your modules in the currently-active virtual environment.


Get it now
**********
::

    $ pip install ped


Changing the default editor
***************************

``ped`` will try to use your favorite text editor. If you want to override the editor ``ped`` uses, set the ``PED_EDITOR`` environment variable.

.. code-block:: bash

    # .zshrc or .bashrc
    # Use Sublime Text with ped
    export PED_EDITOR=subl

Tab-completion
**************

The ped package contains tab-completion scripts for bash and zsh. Place these files in your system's completion directories. The ``ped.install_completion`` module can be run as a script to copy the files.

- `bash completion <https://github.com/sloria/ped/blob/master/ped/ped_bash_completion.sh>`_
- `zsh completion <https://github.com/sloria/ped/blob/master/ped/ped_zsh_completion.zsh>`_

Bash completion
---------------

To install bash completion, run::

    # The path given here will depend on your OS
    $ python -m ped.install_completion --bash /usr/local/etc/bash_completion.d

Zsh completion
---------------

To install zsh completion, run::

    # The path given here will depend on your OS
    $ python -m ped.install_completion --zsh /usr/local/share/zsh/site-functions

Editor integrations
*******************

- `vim-ped <https://github.com/sloria/vim-ped>`_

Kudos
*****

This was inspired by `IPython's <https://ipython.org/>`_ ``%edit`` magic.


Changelog
*********

1.5.1
-----

- Minor code cleanups.
- Test against Python 2.7, 3.5, and 3.6. Support for older versions is dropped.

1.5.0
-----

- Support tab-completion in bash and zsh. Thanks `Thomas Kluyver <https://github.com/takluyver>`_.

1.4.0
-----

- Add ``--info`` argument for outputting name, file path, and line number of modules/functions/classes.
- Fix: Support line numbers in gvim.

1.3.0
-----

- If a class or function is passed, the editor will open up the file at the correct line number (for supported editors).

1.2.1
-----

- Fix for Py2 compatibility.

1.2.0
-----

- Add partial name matching.

1.1.0
-----

- Add support for editing functions and classes.

1.0.2
-----

- Fix for editing subpackages, e.g. ``ped pkg.subpkg``.



            

Raw data

            {
    "maintainer": "", 
    "docs_url": null, 
    "requires_python": "", 
    "maintainer_email": "", 
    "cheesecake_code_kwalitee_id": null, 
    "keywords": "commandline,cli,open,editor,editing", 
    "upload_time": "2018-01-13 02:15:47", 
    "author": "Steven Loria", 
    "home_page": "https://github.com/sloria/ped", 
    "github_user": "sloria", 
    "download_url": "https://pypi.python.org/packages/9c/8e/6cacc5403d2a959c31524f673a1eb07212e6764e43000cfeb4ab06c50530/ped-1.5.1.post0.tar.gz", 
    "platform": "", 
    "version": "1.5.1.post0", 
    "cheesecake_documentation_id": null, 
    "description": "===\nped\n===\n\n.. image:: https://img.shields.io/pypi/v/ped.svg\n    :target: https://pypi.python.org/pypi/ped\n    :alt: Latest version\n\n.. image:: https://img.shields.io/travis/sloria/ped.svg\n    :target: https://travis-ci.org/sloria/ped\n    :alt: Travis-CI\n\nQuickly open Python modules in your text editor.\n\n.. code-block:: bash\n\n    $ ped django\n    $ ped django.core.urlresolvers\n    $ ped django.views.generic.TemplateView\n\n    # Partial name matching\n    $ ped django.http.resp\n    Editing django.http.response...\n    ...Done.\n\n    # Specify which editor to use\n    $ PED_EDITOR=vim ped django.shortcuts\n\n\n``ped`` will find your modules in the currently-active virtual environment.\n\n\nGet it now\n**********\n::\n\n    $ pip install ped\n\n\nChanging the default editor\n***************************\n\n``ped`` will try to use your favorite text editor. If you want to override the editor ``ped`` uses, set the ``PED_EDITOR`` environment variable.\n\n.. code-block:: bash\n\n    # .zshrc or .bashrc\n    # Use Sublime Text with ped\n    export PED_EDITOR=subl\n\nTab-completion\n**************\n\nThe ped package contains tab-completion scripts for bash and zsh. Place these files in your system's completion directories. The ``ped.install_completion`` module can be run as a script to copy the files.\n\n- `bash completion <https://github.com/sloria/ped/blob/master/ped/ped_bash_completion.sh>`_\n- `zsh completion <https://github.com/sloria/ped/blob/master/ped/ped_zsh_completion.zsh>`_\n\nBash completion\n---------------\n\nTo install bash completion, run::\n\n    # The path given here will depend on your OS\n    $ python -m ped.install_completion --bash /usr/local/etc/bash_completion.d\n\nZsh completion\n---------------\n\nTo install zsh completion, run::\n\n    # The path given here will depend on your OS\n    $ python -m ped.install_completion --zsh /usr/local/share/zsh/site-functions\n\nEditor integrations\n*******************\n\n- `vim-ped <https://github.com/sloria/vim-ped>`_\n\nKudos\n*****\n\nThis was inspired by `IPython's <https://ipython.org/>`_ ``%edit`` magic.\n\n\nChangelog\n*********\n\n1.5.1\n-----\n\n- Minor code cleanups.\n- Test against Python 2.7, 3.5, and 3.6. Support for older versions is dropped.\n\n1.5.0\n-----\n\n- Support tab-completion in bash and zsh. Thanks `Thomas Kluyver <https://github.com/takluyver>`_.\n\n1.4.0\n-----\n\n- Add ``--info`` argument for outputting name, file path, and line number of modules/functions/classes.\n- Fix: Support line numbers in gvim.\n\n1.3.0\n-----\n\n- If a class or function is passed, the editor will open up the file at the correct line number (for supported editors).\n\n1.2.1\n-----\n\n- Fix for Py2 compatibility.\n\n1.2.0\n-----\n\n- Add partial name matching.\n\n1.1.0\n-----\n\n- Add support for editing functions and classes.\n\n1.0.2\n-----\n\n- Fix for editing subpackages, e.g. ``ped pkg.subpkg``.\n\n\n", 
    "lcname": "ped", 
    "bugtrack_url": null, 
    "github": true, 
    "coveralls": false, 
    "name": "ped", 
    "license": "MIT", 
    "travis_ci": true, 
    "github_project": "ped", 
    "summary": "Quickly open Python modules in your text editor.", 
    "split_keywords": [
        "commandline", 
        "cli", 
        "open", 
        "editor", 
        "editing"
    ], 
    "author_email": "sloria1@gmail.com", 
    "urls": [
        {
            "has_sig": false, 
            "upload_time": "2018-01-13T02:15:45", 
            "comment_text": "", 
            "python_version": "py2.py3", 
            "url": "https://pypi.python.org/packages/cc/19/1b0502288ea410351fa92e5f7719e912d64f8ed77fcc1f2aaa39e9d42e23/ped-1.5.1.post0-py2.py3-none-any.whl", 
            "md5_digest": "eb957639f3c701a835c525e148002c1c", 
            "downloads": 0, 
            "filename": "ped-1.5.1.post0-py2.py3-none-any.whl", 
            "packagetype": "bdist_wheel", 
            "path": "cc/19/1b0502288ea410351fa92e5f7719e912d64f8ed77fcc1f2aaa39e9d42e23/ped-1.5.1.post0-py2.py3-none-any.whl", 
            "size": 10746
        }, 
        {
            "has_sig": false, 
            "upload_time": "2018-01-13T02:15:47", 
            "comment_text": "", 
            "python_version": "source", 
            "url": "https://pypi.python.org/packages/9c/8e/6cacc5403d2a959c31524f673a1eb07212e6764e43000cfeb4ab06c50530/ped-1.5.1.post0.tar.gz", 
            "md5_digest": "8613e3bbee7fbefe769d0ca80535f3b7", 
            "downloads": 0, 
            "filename": "ped-1.5.1.post0.tar.gz", 
            "packagetype": "sdist", 
            "path": "9c/8e/6cacc5403d2a959c31524f673a1eb07212e6764e43000cfeb4ab06c50530/ped-1.5.1.post0.tar.gz", 
            "size": 10795
        }
    ], 
    "_id": null, 
    "cheesecake_installability_id": null
}