Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature: create demo installer to setup workspace automatically #31

Open
achille-martin opened this issue Jan 20, 2024 · 4 comments
Open
Labels
Priority: Low Issue can be addressed if possible Target: PyQt-CroM The target of the issue is PyQt-CroM Type: Feature Issue related to the addition of a new feature

Comments

@achille-martin
Copy link
Owner

Currently, the "Getting Started" section details every step to setup the workspace for the demo app, but it might take too long for people to experiment with the demo.

The idea is to speed up the on-boarding process with a script that would setup the whole workspace automatically.

The script could include setup of:

  • Virtual Machine Linux & Ubuntu 22
  • Setup of python and pip3
  • Download of main repo
  • Setup of external dependencies
  • Run of Linux demo app
  • Build of Android app
  • Run of Android app
@achille-martin
Copy link
Owner Author

achille-martin commented Mar 4, 2024

According to comments from users:

  • The feature of setting things up simply would be very appreciated (especially as a "quick start" option)
  • It is easy to miss the python virtual env (which needs to be sourced at each session)

Implementation translation:

  • Add a "quick start" option where the user can set the whole machine at the click of a button (rather than go through a long README)
  • For the automation, start by breaking down the steps and then address each entity depending on the host (if relevant)
  • Create sessions on the machine to use PyQt-CroM straight away (no python venv invocation for instance)

@achille-martin achille-martin added Priority: Low Issue can be addressed if possible Target: PyQt-CroM The target of the issue is PyQt-CroM Type: Feature Issue related to the addition of a new feature labels May 22, 2024
@achille-martin
Copy link
Owner Author

achille-martin commented Jun 3, 2024

New idea from me (as an alternative setup for advanced users?):

  • Create a docker image on Ubuntu that contains all required dependencies and then users can start and stop a container easily with no installation step almost. They can then add new dependencies to the docker and save it (needs to be added to the SOP)
  • Extend the docker image to be run on Windows (for practicality of more beginner users): https://ubuntu.com/tutorials/windows-ubuntu-hyperv-containers#1-overview

@achille-martin
Copy link
Owner Author

As an even simpler alternative for beginner users:

  • Create a script for VirtualBox that would setup the virtual machine with one click (including all basic Ubuntu dependencies) -> starting from Windows, or skip the step if already in Ubuntu (but might need a VM still to get the exact environment)
  • Create a bash script that would install all the required dependencies where they are expected to be
    This would ensure the same consistent setup for everyone. People can then tweak the script to adjust to their needs.

@achille-martin
Copy link
Owner Author

There is a need to identify installation and running requirements depending on users:

User v / Phase > Installation Running Experiments
Beginner Simple, guided, from Windows Simple, guided, prepared examples NA
Intermediate Simple, from Win or Ubuntu Simple, running custom examples Limited
Advanced Any method, efficient Any example and custom script Versatile tool

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Priority: Low Issue can be addressed if possible Target: PyQt-CroM The target of the issue is PyQt-CroM Type: Feature Issue related to the addition of a new feature
Projects
None yet
Development

No branches or pull requests

1 participant