OpenChemistry/avogadrolibs

Embedded Python console

Open

#581 opened on May 17, 2021

View on GitHubContributor guide
 (7 comments) (0 reactions) (0 assignees)C++ (232 forks)auto 404
enhancementhelp wantedpython

Repository metrics

Stars
 (662 stars)
PR merge metrics
 (PR metrics pending)

Description

There are two aspects of this:

  • the GUI for the console / interpreter
  • the code to run Python commands inside Avogadro

The latter looks like it already works with pybind11: https://pybind11.readthedocs.io/en/stable/advanced/embedding.html

There's also a PySide example: https://code.qt.io/cgit/pyside/pyside-setup.git/tree/examples/scriptableapplication

Finally, there's a BSD-licensed abstraction layer that allows either PyQt or PySide code: https://github.com/mottosso/Qt.py

Contributor guide

Research direction
Explore how Avogadro integrates Python via pybind11, and study the Qt GUI framework to understand widget creation. Review the provided pybind11 embedding example, PySide scriptable application, and Qt.py abstraction for architectural ideas. Identify where in the codebase a new console widget and interpreter session would fit.
Tech stack
cpppython
Domain
frontendbackenddesktop
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
4
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
3-5 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
C++PythonQtpybind11
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
30