# <div align="center">backframe<br>[](https://github.com/skeleton-ci/skeleton-python/tree/0.0.2rc-215-g792492f) [](https://pypi.org/project/backframe/) [](https://pypi.org/project/backframe/)</div>
[](https://github.com/bswck/backframe/actions/workflows/test.yml)
[](https://coverage-badge.samuelcolvin.workers.dev/redirect/bswck/backframe)
[](https://backframe.readthedocs.io/en/latest/?badge=latest)
Inspect the caller.
# Installation
You might simply install it with pip:
```shell
pip install backframe
```
If you use [Poetry](https://python-poetry.org/), then you might want to run:
```shell
poetry add backframe
```
## For Contributors
[](https://python-poetry.org/)
[](https://github.com/astral-sh/ruff)
[](https://github.com/pre-commit/pre-commit)
<!--
This section was generated from skeleton-ci/skeleton-python@0.0.2rc-215-g792492f.
Instead of changing this particular file, you might want to alter the template:
https://github.com/skeleton-ci/skeleton-python/tree/0.0.2rc-215-g792492f/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 [backframe repository](https://github.com/bswck/backframe) 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/backframe path/to/backframe
cd path/to/backframe
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
```
For more information on how to contribute, check out [CONTRIBUTING.md](https://github.com/bswck/backframe/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/backframe/blob/HEAD/LICENSE).
Raw data
{
"_id": null,
"home_page": "https://github.com/bswck/backframe",
"name": "backframe",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": null,
"author": "bswck",
"author_email": "bartoszpiotrslawecki@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/a4/f7/d1cc8298742cb8e858be2525f78e4334bcb16e040016b5af8cc499648de2/backframe-0.1.2.tar.gz",
"platform": null,
"description": "# <div align=\"center\">backframe<br>[](https://github.com/skeleton-ci/skeleton-python/tree/0.0.2rc-215-g792492f) [](https://pypi.org/project/backframe/) [](https://pypi.org/project/backframe/)</div>\n\n[](https://github.com/bswck/backframe/actions/workflows/test.yml)\n[](https://coverage-badge.samuelcolvin.workers.dev/redirect/bswck/backframe)\n[](https://backframe.readthedocs.io/en/latest/?badge=latest)\n\nInspect the caller.\n\n# Installation\nYou might simply install it with pip:\n\n```shell\npip install backframe\n```\n\nIf you use [Poetry](https://python-poetry.org/), then you might want to run:\n\n```shell\npoetry add backframe\n```\n\n## For Contributors\n[](https://python-poetry.org/)\n[](https://github.com/astral-sh/ruff)\n[](https://github.com/pre-commit/pre-commit)\n<!--\nThis section was generated from skeleton-ci/skeleton-python@0.0.2rc-215-g792492f.\nInstead of changing this particular file, you might want to alter the template:\nhttps://github.com/skeleton-ci/skeleton-python/tree/0.0.2rc-215-g792492f/project/README.md.jinja\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).\n1. Fork the [backframe repository](https://github.com/bswck/backframe) 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/backframe path/to/backframe\n cd path/to/backframe\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\n ```\n\nFor more information on how to contribute, check out [CONTRIBUTING.md](https://github.com/bswck/backframe/blob/HEAD/CONTRIBUTING.md).<br/>\nAlways happy to accept contributions! \u2764\ufe0f\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/backframe/blob/HEAD/LICENSE).\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Inspect the caller.",
"version": "0.1.2",
"project_urls": {
"Coverage": "https://coverage-badge.samuelcolvin.workers.dev/redirect/bswck/backframe",
"Distribution": "https://pypi.org/project/backframe/",
"Documentation": "https://backframe.readthedocs.io/en/latest/",
"Homepage": "https://github.com/bswck/backframe",
"Issues": "https://github.com/bswck/backframe/issues"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "1c59928163491273aa4db0950028a4f7403b8172b2ad2fb43dc5e525264ddb40",
"md5": "a0d78e1f99fb3a6296252078c16fe247",
"sha256": "b9ab4469d5d9a646640a12ab0f9818d0cfd5481dac91a74e87c7a65e3fcc4d13"
},
"downloads": -1,
"filename": "backframe-0.1.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a0d78e1f99fb3a6296252078c16fe247",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 5365,
"upload_time": "2024-04-14T00:34:25",
"upload_time_iso_8601": "2024-04-14T00:34:25.056139Z",
"url": "https://files.pythonhosted.org/packages/1c/59/928163491273aa4db0950028a4f7403b8172b2ad2fb43dc5e525264ddb40/backframe-0.1.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a4f7d1cc8298742cb8e858be2525f78e4334bcb16e040016b5af8cc499648de2",
"md5": "49a2c7e450446323e13d3a3c2ffed2eb",
"sha256": "531c97446e83d0a73d80b0484bd8de0423f7862fd3564ce118adc3b6c61423c4"
},
"downloads": -1,
"filename": "backframe-0.1.2.tar.gz",
"has_sig": false,
"md5_digest": "49a2c7e450446323e13d3a3c2ffed2eb",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 6019,
"upload_time": "2024-04-14T00:34:26",
"upload_time_iso_8601": "2024-04-14T00:34:26.469226Z",
"url": "https://files.pythonhosted.org/packages/a4/f7/d1cc8298742cb8e858be2525f78e4334bcb16e040016b5af8cc499648de2/backframe-0.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-14 00:34:26",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "bswck",
"github_project": "backframe",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "backframe"
}
JSON
