[![Testing](https://img.shields.io/github/actions/workflow/status/libranet/autoadd-bindir/testing.yaml?branch=main&longCache=true&style=flat-square&label=tests&logo=GitHub%20Actions&logoColor=fff%22)](https://github.com/libranet/autoadd-bindir/actions/workflows/testing.yaml)
[![Linting](https://img.shields.io/github/actions/workflow/status/libranet/autoadd-bindir/linting.yaml?branch=main&longCache=true&style=flat-square&label=linting&logo=GitHub%20Actions&logoColor=fff%22)](https://github.com/libranet/autoadd-bindir/actions/workflows/linting.yaml)
[![Read the Docs](https://readthedocs.org/projects/autoadd-bindir/badge/?version=latest)](https://autoadd-bindir.readthedocs.io/en/latest/)
[![Codecov](https://codecov.io/gh/libranet/autoadd-bindir/branch/main/graph/badge.svg?token=AFP6UMXEN5)](https://codecov.io/gh/libranet/autoadd-bindir)
[![PyPi Package](https://img.shields.io/pypi/v/autoadd-bindir?color=%2334D058&label=pypi%20package)](https://pypi.org/project/autoadd-bindir/)
[![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/libranet/autoadd-bindir/blob/main/docs/license.md)

https://app.codecov.io/gh/libranet/autoadd-bindir

# Autoadd-bindir

Automatically add the bin-directory of your virtualenv to the `PATH`-environment variable
via `sitecustomize`-entrypoint. You now no longer need to manually *activate* your
virtual environment for the sole purpose of adding thie bin-drectory to your `$PATH`.

## How does it work?

We register the `autoadd_bin.entrypoint()`-function to the `sitecustomize`-module that is installed by the
[sitecustomize-entrypoints](http://pypi.python.org/pypi/sitecustomize-entrypoints)-package.

The registered function will look up `sys.prefix` of your python-executable and
add the corresponding bin-directory to the `PATH`.

## Installation

Install via pip:

```bash
> bin/pip install autoadd-bindir
```

Or add to your poetry-based project:

```bash
> poetry add autoadd-bindir
```

## Validate & Usage

After installing this package there is nothing left to do explicitly.
We can validate that the plugin work correctly by starting a python-session and checking the `PATH`-environment-variable:

```bash
> bin/python
```

```python
>>> import os
>>> print(os.getenv("PATH"))
    "<path-to-your-virtualenv>/bin", ...
```

## Registered sitecustomize-entrypoint

The `autoadd_bindir`-function is registered as a `sitecustomize`-entrypoint in our pyproject.toml\_:

```toml
    [tool.poetry.plugins]
    [tool.poetry.plugins."sitecustomize"]
    autoadd_bindir = "autoadd_bindir:entrypoint"
```

Sitecustomize and all its registered entrypoints will be executed at the start of *every* python-process.
For more information, please see [sitecustomize-entrypoints](http://pypi.python.org/pypi/sitecustomize-entrypoints)

## Compatibility

[![Python Version](https://img.shields.io/pypi/pyversions/autoadd-bindir?:alt:PyPI-PythonVersion)](https://pypi.org/project/autoadd-bindir/)
[![PyPI - Implementation](https://img.shields.io/pypi/implementation/autoadd-bindir?:alt:PyPI-Implementation)](https://pypi.org/project/autoadd-bindir/)

`autoadd-bindir` works on Python 3.8+, including PyPy3. Tested until Python 3.11,

## Notable dependencies

- [sitecustomize-entrypoints](http://pypi.python.org/pypi/sitecustomize-entrypoints)