| Name | proxyvars JSON |
| Version |
0.9.2
JSON |
| download |
| home_page | https://github.com/bswck/proxyvars |
| Summary | A simple and straight-forward Python module for creating context-dependent proxy objects. |
| upload_time | 2024-02-16 17:30:13 |
| maintainer | |
| docs_url | None |
| author | bswck |
| requires_python | >=3.8,<3.13 |
| license | MIT |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# proxyvars [](https://github.com/bswck/skeleton/tree/7935235)
[](https://pypi.org/project/proxyvars/)
[](https://pypi.org/project/proxyvars/)
[](https://github.com/bswck/proxyvars/actions/workflows/test.yml)
[](https://coverage-badge.samuelcolvin.workers.dev/redirect/bswck/proxyvars)
[](https://proxyvars.readthedocs.io/en/latest/?badge=latest)
[](https://github.com/bswck/proxyvars/blob/HEAD/LICENSE)
[](https://python-poetry.org/)
[](https://github.com/astral-sh/ruff)
[](https://github.com/pre-commit/pre-commit)
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
You might simply install it with pip:
```shell
pip install proxyvars
```
If you use [Poetry](https://python-poetry.org/), then run:
```shell
poetry add proxyvars
```
## For contributors
<!--
This section was generated from bswck/skeleton@7935235.
Instead of changing this particular file, you might want to alter the template:
https://github.com/bswck/skeleton/tree/7935235/project/README.md.jinja
-->
> [!Note]
> If you use Windows, it is highly recommended to complete the installation in the way presented below through [WSL2](https://learn.microsoft.com/en-us/windows/wsl/install).
1. Fork the [proxyvars repository](https://github.com/bswck/proxyvars) on GitHub.
1. [Install Poetry](https://python-poetry.org/docs/#installation).<br/>
Poetry is an amazing tool for managing dependencies & virtual environments, building packages and publishing them.
You might use [pipx](https://github.com/pypa/pipx#readme) to install it globally (recommended):
```shell
pipx install poetry
```
<sub>If you encounter any problems, refer to [the official documentation](https://python-poetry.org/docs/#installation) for the most up-to-date installation instructions.</sub>
Be sure to have Python 3.8 installed—if you use [pyenv](https://github.com/pyenv/pyenv#readme), simply run:
```shell
pyenv install 3.8
```
1. Clone your fork locally and install dependencies.
```shell
git clone https://github.com/your-username/proxyvars path/to/proxyvars
cd path/to/proxyvars
poetry env use $(cat .python-version)
poetry install
```
Next up, simply activate the virtual environment and install pre-commit hooks:
```shell
poetry shell
pre-commit install --hook-type pre-commit --hook-type pre-push
```
For more information on how to contribute, check out [CONTRIBUTING.md](https://github.com/bswck/proxyvars/blob/HEAD/CONTRIBUTING.md).<br/>
Always happy to accept contributions! ❤️
# Legal info
© Copyright by Bartosz Sławecki ([@bswck](https://github.com/bswck)).
<br />This software is licensed under the terms of [MIT License](https://github.com/bswck/proxyvars/blob/HEAD/LICENSE).
Raw data
{
"_id": null,
"home_page": "https://github.com/bswck/proxyvars",
"name": "proxyvars",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8,<3.13",
"maintainer_email": "",
"keywords": "",
"author": "bswck",
"author_email": "bswck.dev@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/ac/d3/5486efa756f01c2f91280003dd9866d3653b533380eb4a152bd53207a78f/proxyvars-0.9.2.tar.gz",
"platform": null,
"description": "\n# proxyvars [](https://github.com/bswck/skeleton/tree/7935235)\n[](https://pypi.org/project/proxyvars/)\n[](https://pypi.org/project/proxyvars/)\n\n[](https://github.com/bswck/proxyvars/actions/workflows/test.yml)\n[](https://coverage-badge.samuelcolvin.workers.dev/redirect/bswck/proxyvars)\n[](https://proxyvars.readthedocs.io/en/latest/?badge=latest)\n[](https://github.com/bswck/proxyvars/blob/HEAD/LICENSE)\n\n[](https://python-poetry.org/)\n[](https://github.com/astral-sh/ruff)\n[](https://github.com/pre-commit/pre-commit)\n\nA simple and straight-forward Python module for creating context-dependent proxy objects.\n\nAs 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).\n\n# Installation\n\n\n\nYou might simply install it with pip:\n\n```shell\npip install proxyvars\n```\n\nIf you use [Poetry](https://python-poetry.org/), then run:\n\n```shell\npoetry add proxyvars\n```\n\n## For contributors\n\n<!--\nThis section was generated from bswck/skeleton@7935235.\nInstead of changing this particular file, you might want to alter the template:\nhttps://github.com/bswck/skeleton/tree/7935235/project/README.md.jinja\n-->\n\n> [!Note]\n> If you use Windows, it is highly recommended to complete the installation in the way presented below through [WSL2](https://learn.microsoft.com/en-us/windows/wsl/install).\n\n\n\n1. Fork the [proxyvars repository](https://github.com/bswck/proxyvars) on GitHub.\n\n1. [Install Poetry](https://python-poetry.org/docs/#installation).<br/>\n Poetry is an amazing tool for managing dependencies & virtual environments, building packages and publishing them.\n You might use [pipx](https://github.com/pypa/pipx#readme) to install it globally (recommended):\n\n ```shell\n pipx install poetry\n ```\n\n <sub>If you encounter any problems, refer to [the official documentation](https://python-poetry.org/docs/#installation) for the most up-to-date installation instructions.</sub>\n\n Be sure to have Python 3.8 installed\u2014if you use [pyenv](https://github.com/pyenv/pyenv#readme), simply run:\n\n ```shell\n pyenv install 3.8\n ```\n\n1. Clone your fork locally and install dependencies.\n\n ```shell\n git clone https://github.com/your-username/proxyvars path/to/proxyvars\n cd path/to/proxyvars\n poetry env use $(cat .python-version)\n poetry install\n ```\n\n Next up, simply activate the virtual environment and install pre-commit hooks:\n\n ```shell\n poetry shell\n pre-commit install --hook-type pre-commit --hook-type pre-push\n ```\n\nFor more information on how to contribute, check out [CONTRIBUTING.md](https://github.com/bswck/proxyvars/blob/HEAD/CONTRIBUTING.md).<br/>\nAlways happy to accept contributions! \u2764\ufe0f\n\n\n# Legal info\n\u00a9 Copyright by Bartosz S\u0142awecki ([@bswck](https://github.com/bswck)).\n<br />This software is licensed under the terms of [MIT License](https://github.com/bswck/proxyvars/blob/HEAD/LICENSE).\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A simple and straight-forward Python module for creating context-dependent proxy objects.",
"version": "0.9.2",
"project_urls": {
"Coverage": "https://coverage-badge.samuelcolvin.workers.dev/redirect/bswck/proxyvars",
"Distribution": "https://pypi.org/project/proxyvars/",
"Documentation": "https://proxyvars.readthedocs.io/en/latest/",
"Homepage": "https://github.com/bswck/proxyvars",
"Issues": "https://github.com/bswck/proxyvars/issues"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f6239b8c6a6b2b5edd4cd68fd597f2b1f2af90ca24783294b674b6f3c3f35921",
"md5": "dbfd4be7d1e05dea21d3d0d1adfec0b5",
"sha256": "7e0345af984fc24f96ab3a722d423f547386ae5b2f735ff4ca7f4b5d34435b83"
},
"downloads": -1,
"filename": "proxyvars-0.9.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "dbfd4be7d1e05dea21d3d0d1adfec0b5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8,<3.13",
"size": 8281,
"upload_time": "2024-02-16T17:30:11",
"upload_time_iso_8601": "2024-02-16T17:30:11.877655Z",
"url": "https://files.pythonhosted.org/packages/f6/23/9b8c6a6b2b5edd4cd68fd597f2b1f2af90ca24783294b674b6f3c3f35921/proxyvars-0.9.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "acd35486efa756f01c2f91280003dd9866d3653b533380eb4a152bd53207a78f",
"md5": "631dee58761e67c14dda0fcf0f45666e",
"sha256": "8517e245fe6fa5266d27edc53ca14d63ba772d042a40bcd5802dd64973347aef"
},
"downloads": -1,
"filename": "proxyvars-0.9.2.tar.gz",
"has_sig": false,
"md5_digest": "631dee58761e67c14dda0fcf0f45666e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8,<3.13",
"size": 10291,
"upload_time": "2024-02-16T17:30:13",
"upload_time_iso_8601": "2024-02-16T17:30:13.083831Z",
"url": "https://files.pythonhosted.org/packages/ac/d3/5486efa756f01c2f91280003dd9866d3653b533380eb4a152bd53207a78f/proxyvars-0.9.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-16 17:30:13",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "bswck",
"github_project": "proxyvars",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "proxyvars"
}
