Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/bswck/backframe

Inspect the caller.
https://github.com/bswck/backframe

metaprogramming python

Last synced: 23 days ago
JSON representation

Inspect the caller.

Host: GitHub
URL: https://github.com/bswck/backframe
Owner: bswck
License: mit
Created: 2024-02-20T03:45:35.000Z (9 months ago)
Default Branch: main
Last Pushed: 2024-04-14T00:33:41.000Z (7 months ago)
Last Synced: 2024-04-14T13:12:40.492Z (7 months ago)
Topics: metaprogramming, python
Language: Python
Homepage: https://backframe.readthedocs.io
Size: 135 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        # 
backframe
[![skeleton](https://img.shields.io/badge/0.0.2rc–215–g792492f-skeleton?label=%F0%9F%92%80%20skeleton-ci/skeleton-python&labelColor=black&color=grey&link=https%3A//github.com/skeleton-ci/skeleton-python)](https://github.com/skeleton-ci/skeleton-python/tree/0.0.2rc-215-g792492f) [![Supported Python versions](https://img.shields.io/pypi/pyversions/backframe.svg?logo=python&label=Python)](https://pypi.org/project/backframe/) [![Package version](https://img.shields.io/pypi/v/backframe?label=PyPI)](https://pypi.org/project/backframe/)


[![Tests](https://github.com/bswck/backframe/actions/workflows/test.yml/badge.svg)](https://github.com/bswck/backframe/actions/workflows/test.yml)

[![Coverage](https://coverage-badge.samuelcolvin.workers.dev/bswck/backframe.svg)](https://coverage-badge.samuelcolvin.workers.dev/redirect/bswck/backframe)

[![Documentation Status](https://readthedocs.org/projects/backframe/badge/?version=latest)](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

[![Poetry](https://img.shields.io/endpoint?url=https://python-poetry.org/badge/v0.json)](https://python-poetry.org/)

[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)

[![Pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit)

> [!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).


    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

    ```

    _{If you encounter any problems, refer to [the official documentation](https://python-poetry.org/docs/#installation) for the most up-to-date installation instructions.}

    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).


Always happy to accept contributions! ❤️

# Legal Info

© Copyright by Bartosz Sławecki ([@bswck](https://github.com/bswck)).


This software is licensed under the terms of [MIT License](https://github.com/bswck/backframe/blob/HEAD/LICENSE).