proxyvars

A simple and straight-forward Python module for creating context-dependent proxy objects.

As for now, the documentation is mostly in the codebase (check relevant docstrings of proxy(), const_proxy(), lookup_proxy(), proxy_field_accessor(), proxy_item_accessor() and proxy_attribute_accessor() for more information).

Installation

If you want to…

…use this tool in your project 💻

You might simply install it with pip:

pip install proxyvars

If you use Poetry, then run:

poetry add proxyvars

…contribute to proxyvars 🚀

Happy to accept contributions!

[!Note] If you use Windows, it is highly recommended to complete the installation in the way presented below through WSL2.

First, install Poetry.
Poetry is an amazing tool for managing dependencies & virtual environments, building packages and publishing them.

pipx install poetry

_{If you encounter any problems, refer to the official documentation for the most up-to-date installation instructions.}

Be sure to have Python 3.8 installed—if you use pyenv, simply run:

pyenv install 3.8

Then, run:

git clone https://github.com/bswck/proxyvars path/to/proxyvars
cd path/to/proxyvars
poetry env use $(cat .python-version)
poetry install
poetry shell
pre-commit install --hook-type pre-commit --hook-type pre-push

Legal info

© Copyright by Bartosz Sławecki (@bswck).
This software is licensed under the MIT License.