https://github.com/potocpav/python-concur

Concur UI Framework for Python
https://github.com/potocpav/python-concur

Last synced: about 1 month ago
JSON representation

Concur UI Framework for Python

• Host: GitHub
• URL: https://github.com/potocpav/python-concur
• Owner: potocpav
• License: mit
• Created: 2019-10-11T05:28:27.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2020-11-04T08:37:14.000Z (over 3 years ago)
• Last Synced: 2024-05-16T11:20:17.633Z (about 2 months ago)
• Language: Python
• Size: 3.59 MB
• Stars: 47
• Watchers: 3
• Forks: 2
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Lists

• awesome-concur - python-concur - Python version. (Integrations)

README

        



  Python Concur





   



[![Build Status](https://travis-ci.com/potocpav/python-concur.svg?branch=master)](https://travis-ci.com/potocpav/python-concur)

[![PyPI version](https://badge.fury.io/py/concur.svg)](https://pypi.org/project/concur)

[![Python version](https://img.shields.io/pypi/pyversions/concur.svg)](https://pypi.org/project/concur)

* [**API Reference**](https://potocpav.github.io/python-concur-docs/master/)

* [**Documentation**](https://github.com/potocpav/python-concur-docs/)

* [Homepage](https://potocpav.github.io/python-concur-docs/homepage.html)

* [PyPI](https://pypi.org/project/concur/)

* [Changelog](https://github.com/potocpav/python-concur/tree/master/CHANGELOG.md)

Concur is a Python GUI framework based on synchronous generators.

It is a port of [Concur for Purescript](https://github.com/ajnsit/purescript-concur), implemented on top of the [Dear ImGui](https://github.com/ocornut/imgui) C++ UI library.

For introduction to core concepts, see the [documentation](file:///home/pavel/build/python-concur/docs/index.html#introduction). A more comprehensive introduction can be found in the [Documentation for the Haskell/Purescript versions](https://github.com/ajnsit/concur-documentation/blob/master/README.md). This obviously uses Haskell/Purescript syntax and semantics, but many of the concepts will apply to the Python version.

Being an abstraction over ImGui, Concur is best used for debugging, prototyping and data analysis, rather than user-facing applications. ImGui functions can be used directly for any functionality that is not wrapped by Concur. See the [PyImGui docs](https://pyimgui.readthedocs.io/en/latest/) for additional widgets, or [ImGui itself](https://github.com/ocornut/imgui) if you need to poke really deep.

## Installation

The only dependencies are a C++ compiler, [GLFW](https://github.com/glfw/glfw) and Python >= 3.6. GLFW is included in major Linux distros, and there are [pre-compiled binaries](https://www.glfw.org/download.html) for Windows and OS X.

```sh

sudo apt install libglfw3-dev # Ubuntu

sudo pacman -S glfw           # Arch

```

Concur can be installed using pip:

```sh

pip install concur

```

This command should produce a very simple GUI app:

```sh

python -c 'import concur as c; c.main(c.button("Close"))'

```

See the [introductory tutorial](https://github.com/potocpav/python-concur-docs/blob/master/Introduction.md) to get started, or use any of the [examples](https://github.com/potocpav/python-concur/tree/master/examples) as a starting point for your app.

## Development

For Concur development, clone the repo and install it using pip:

```sh

git clone https://github.com/potocpav/python-concur.git

cd python-concur

pip install -e.

examples/all.py # Run the examples to verify installation

```

To run the tests, you need PyTest and PyTest-benchmark:

```sh

pip install pytest pytest-benchmark

pytest # Run the tests

```

To build documentation, install [pdoc3](https://pdoc3.github.io/pdoc/) (`pip install pdoc3`), clone the submodules (`git submodule update --init`), and run the script `./mkdocs.sh`.