{"id":15647849,"url":"https://github.com/sloria/ped","last_synced_at":"2025-04-15T01:14:20.904Z","repository":{"id":49210898,"uuid":"42016292","full_name":"sloria/ped","owner":"sloria","description":":mans_shoe: Quickly open Python modules in your text editor","archived":false,"fork":false,"pushed_at":"2025-04-09T23:38:47.000Z","size":175,"stargazers_count":44,"open_issues_count":0,"forks_count":3,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-04-15T01:14:16.106Z","etag":null,"topics":["cli","command-line","editing","python","python3"],"latest_commit_sha":null,"homepage":"https://pypi.python.org/pypi/ped","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sloria.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2015-09-06T19:35:02.000Z","updated_at":"2025-04-09T23:38:49.000Z","dependencies_parsed_at":"2024-04-02T18:25:33.550Z","dependency_job_id":"5b6a9af9-f4d9-4d44-8701-8d4245b6e5b9","html_url":"https://github.com/sloria/ped","commit_stats":{"total_commits":156,"total_committers":6,"mean_commits":26.0,"dds":"0.46153846153846156","last_synced_commit":"4c1bbe0a0a19c2f15af0428ef33913684159a709"},"previous_names":[],"tags_count":14,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sloria%2Fped","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sloria%2Fped/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sloria%2Fped/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sloria%2Fped/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sloria","download_url":"https://codeload.github.com/sloria/ped/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248986316,"owners_count":21194025,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cli","command-line","editing","python","python3"],"created_at":"2024-10-03T12:21:33.681Z","updated_at":"2025-04-15T01:14:20.885Z","avatar_url":"https://github.com/sloria.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"===\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    \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 \u003chttps://github.com/pipxproject/pipx\u003e`_:\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 \u003e /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 \u003e /usr/local/share/zsh/site-functions/_ped\n\nEditor integrations\n*******************\n\n- `vim-ped \u003chttps://github.com/sloria/vim-ped\u003e`_\n\nKudos\n*****\n\nThis was inspired by `IPython's \u003chttps://ipython.org/\u003e`_ ``%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 \u003chttps://github.com/anordin95\u003e`_.\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\u003e=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 \u003chttps://github.com/takluyver\u003e`_.\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","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsloria%2Fped","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsloria%2Fped","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsloria%2Fped/lists"}