https://github.com/10sr/with-venv-el

Execute with Python Virtual Environment Activated
https://github.com/10sr/with-venv-el

Last synced: 11 months ago
JSON representation

Execute with Python Virtual Environment Activated

• Host: GitHub
• URL: https://github.com/10sr/with-venv-el
• Owner: 10sr
• License: apache-2.0
• Created: 2018-12-14T08:56:37.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2024-11-12T05:41:51.000Z (over 1 year ago)
• Last Synced: 2025-03-05T22:44:34.437Z (over 1 year ago)
• Language: Emacs Lisp
• Homepage: https://10sr.github.io/with-venv-el/
• Size: 72.3 KB
• Stars: 17
• Watchers: 4
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
[![build](https://github.com/10sr/with-venv-el/actions/workflows/build.yaml/badge.svg)](https://github.com/10sr/with-venv-el/actions/workflows/build.yaml)

[![MELPA](https://melpa.org/packages/with-venv-badge.svg)](https://melpa.org/#/with-venv)

[![MELPA Stable](https://stable.melpa.org/packages/with-venv-badge.svg)](https://stable.melpa.org/#/with-venv)

with-venv.el

============

Execute with Python virtual environment activated

Usage

-----

`with-venv` macro executes BODY with Python virtual environment activated:

``` emacs-lisp

(with-venv

  (executable-find "python"))

```

This macro searchs for suitable venv directory for current environment

automatically: by default it supports `pipenv`, `poetry`, and directories

named `".venv"` and `"venv"`.

You can modify `with-venv-find-venv-dir-functions` to add or remove

these supports.

The automatic search result will be cached as a buffer-local variable, so

`with-venv` try to find venv dir only at the first time it is used after

visiting file.

To explicitly update this cache (without re-visiting file) after you

created/changed a virtual environment, invoke `M-x with-venv-find-venv-dir`

manually.

You can also set buffer-local vairable `with-venv-venv-dir` explicitly

to specify venv directory for `with-venv` macro.

In this case, the automatic search will be totally disabled for that buffer.

If you want to always enable `with-venv` for certain functions,

`with-venv-advice-add` can be used for that purpose:

``` emacs-lisp

(with-venv-advice-add 'blacken-buffer)

```

Adviced functions are always wrapped with `with-venv` macro when called.

Call `with-venv-advice-remove` to remove these advices.

License

-------

This software is licensed under Apache License 2.0 . See `LICENSE` for details.