| Name | ped JSON |
| Version |
3.0.0
JSON |
| download |
| home_page | |
| Summary | Quickly open Python modules in your text editor. |
| upload_time | 2024-01-18 21:04:45 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.8 |
| license | |
| keywords |
commandline
cli
open
editor
editing
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
===
ped
===
.. image:: https://badgen.net/pypi/v/ped
:alt: pypi badge
:target: https://pypi.org/project/ped/
.. image:: https://github.com/sloria/ped/actions/workflows/build-release.yml/badge.svg
:alt: build status
:target: https://github.com/sloria/ped/actions/workflows/build-release.yml
.. image:: https://badgen.net/badge/code%20style/black/000
:target: https://github.com/ambv/black
:alt: Code style: Black
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
**********
From PyPI:
::
$ pip install ped
Or, run it with `pipx <https://github.com/pipxproject/pipx>`_:
::
$ pipx run ped --help
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 vim with ped
export PED_EDITOR=vim
Opening directories
*******************
By default, ``ped`` will open ``__init__.py`` files when a package name is passed.
If you would rather open the package's directory, set the ``PED_OPEN_DIRECTORIES`` environment variable.
.. code-block:: bash
# .zshrc or .bashrc
# Open package directories instead of __init__.py
export PED_OPEN_DIRECTORIES=1
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 output the files to a given location. It determines the correct completion file from
the ``$SHELL`` environment variable.
Bash completion
---------------
To install bash completion, run::
# The path given here will depend on your OS
$ python -m ped.install_completion > /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 > /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
*********
3.0.0 (2024-01-18)
------------------
- Publish type information.
- Test against Python 3.8-3.12. Older versions of Python are no longer supported.
- *Backwards-incompatible*: Remove ``ped.__version__`` attribute.
Use ``importlib.metadata.version("ped")`` instead.
2.1.0 (2020-03-18)
------------------
- Set ``PED_OPEN_DIRECTORIES=1`` to open package directories instead of
opening ``__init__.py`` files. Thanks `Alex Nordin <https://github.com/anordin95>`_.
2.0.1 (2018-01-27)
------------------
Bug fixes:
- Properly handle imports that don't correspond to a file.
2.0.0 (2019-01-22)
------------------
- Drop support for Python 2.7 and 3.5. Only Python>=3.6 is supported.
- ``ped`` can be run its own virtual environment separate from the
user's virtual environment. Therefore, ped can be installed with
pipsi or pipx.
- ``install_completion`` script writes to ``stdout`` and detemrmines
script from ``$SHELL``.
1.6.0 (2019-01-14)
------------------
- Test against Python 3.7.
Note: This is the last version to support Python 2.
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
{
"_id": null,
"home_page": "",
"name": "ped",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "commandline,cli,open,editor,editing",
"author": "",
"author_email": "Steven Loria <sloria1@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/35/a5/74209ec54b840429700fae4002462cd71288939cf975d0cb5bac8c570558/ped-3.0.0.tar.gz",
"platform": null,
"description": "===\nped\n===\n\n.. image:: https://badgen.net/pypi/v/ped\n :alt: pypi badge\n :target: https://pypi.org/project/ped/\n\n.. image:: https://github.com/sloria/ped/actions/workflows/build-release.yml/badge.svg\n :alt: build status\n :target: https://github.com/sloria/ped/actions/workflows/build-release.yml\n\n.. image:: https://badgen.net/badge/code%20style/black/000\n :target: https://github.com/ambv/black\n :alt: Code style: Black\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\nFrom PyPI:\n\n::\n\n $ pip install ped\n\n\nOr, run it with `pipx <https://github.com/pipxproject/pipx>`_:\n\n::\n\n $ pipx run ped --help\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 vim with ped\n export PED_EDITOR=vim\n\n\nOpening directories\n*******************\n\nBy default, ``ped`` will open ``__init__.py`` files when a package name is passed.\nIf you would rather open the package's directory, set the ``PED_OPEN_DIRECTORIES`` environment variable.\n\n.. code-block:: bash\n\n # .zshrc or .bashrc\n # Open package directories instead of __init__.py\n export PED_OPEN_DIRECTORIES=1\n\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 output the files to a given location. It determines the correct completion file from\nthe ``$SHELL`` environment variable.\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 > /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 > /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\n3.0.0 (2024-01-18)\n------------------\n\n- Publish type information.\n- Test against Python 3.8-3.12. Older versions of Python are no longer supported.\n- *Backwards-incompatible*: Remove ``ped.__version__`` attribute.\n Use ``importlib.metadata.version(\"ped\")`` instead.\n\n2.1.0 (2020-03-18)\n------------------\n\n- Set ``PED_OPEN_DIRECTORIES=1`` to open package directories instead of\n opening ``__init__.py`` files. Thanks `Alex Nordin <https://github.com/anordin95>`_.\n\n2.0.1 (2018-01-27)\n------------------\n\nBug fixes:\n\n- Properly handle imports that don't correspond to a file.\n\n2.0.0 (2019-01-22)\n------------------\n\n- Drop support for Python 2.7 and 3.5. Only Python>=3.6 is supported.\n- ``ped`` can be run its own virtual environment separate from the\n user's virtual environment. Therefore, ped can be installed with\n pipsi or pipx.\n- ``install_completion`` script writes to ``stdout`` and detemrmines\n script from ``$SHELL``.\n\n1.6.0 (2019-01-14)\n------------------\n\n- Test against Python 3.7.\n\nNote: This is the last version to support Python 2.\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",
"bugtrack_url": null,
"license": "",
"summary": "Quickly open Python modules in your text editor.",
"version": "3.0.0",
"project_urls": {
"Issues": "https://github.com/sloria/ped/issues",
"Source": "https://github.com/sloria/ped/"
},
"split_keywords": [
"commandline",
"cli",
"open",
"editor",
"editing"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b7b19c2df8358962683a3f55e7e0cea65358b079a4193225cbae5d351f704c7b",
"md5": "1177ed08f791cdd1c2901ebefa333647",
"sha256": "266bfa58b1f2544a07c9cffd78ce05c2703549e31005a0b37cfd211a8675abb3"
},
"downloads": -1,
"filename": "ped-3.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1177ed08f791cdd1c2901ebefa333647",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 11350,
"upload_time": "2024-01-18T21:04:44",
"upload_time_iso_8601": "2024-01-18T21:04:44.308610Z",
"url": "https://files.pythonhosted.org/packages/b7/b1/9c2df8358962683a3f55e7e0cea65358b079a4193225cbae5d351f704c7b/ped-3.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "35a574209ec54b840429700fae4002462cd71288939cf975d0cb5bac8c570558",
"md5": "d39bc7a1d53046c77ecbae07d661b5ae",
"sha256": "a51c235fa60d601d8c9008eaec172771f2829db23854a5314c08d7fb7c86d997"
},
"downloads": -1,
"filename": "ped-3.0.0.tar.gz",
"has_sig": false,
"md5_digest": "d39bc7a1d53046c77ecbae07d661b5ae",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 13363,
"upload_time": "2024-01-18T21:04:45",
"upload_time_iso_8601": "2024-01-18T21:04:45.974412Z",
"url": "https://files.pythonhosted.org/packages/35/a5/74209ec54b840429700fae4002462cd71288939cf975d0cb5bac8c570558/ped-3.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-18 21:04:45",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "sloria",
"github_project": "ped",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "ped"
}
