Windows setup issues

[ghost]

This looks like a really useful tool, but the setup leaves a LOT to be desired.
Unlike most VS Code Extensions, where clicking the "Install" button is all that is required, this tool requires SIGNIFICANT knowledge of Python and your operating system, in my case, Windows.

The first thing that happened upon installation is the loss of all my custom Workspace Settings, and it is now reporting "Unknown configuration setting". Strike 1.

I found the code extensions folder for this extension under "dkupco.viewx-0.2.1" by looking at the timestamp. Not exactly intuitive, but I found it.

Unfortunately, not knowing anything about Python, I found the Windows 10 installations instructions inscrutable, for example:
.\viewX_setup.ps1 -path "some\parent\folder" -name "env_name" [-reqFile "path\to\requirements\file"]
i.e. some\parent\folder. parent to what?
i.e. path\to\requirements\file. what requirements?
I was unable to complete this step. Strike 2.

Further on... the Python-specific instructions: I have no idea how to do any of this. I have to ask myself "how many days I want to devote to reading blogs to figure this out?" For me its under an hour. Strike 3. I'm out.

I note that as of this submission there are only 255 downloads of this extension, IMHO an astonishingly low number given the tool's capabilities. I would guess that the lack of adoption is due to the setup instructions. If you're a Python developer, you might have a good shot of getting the extension to work. If you have no Python experience, good luck.

I can't use this tool in its current incarnation. This is the most complicated so called "Quick Start" I have ever encountered. IMHO Quick Start should be 1 line: "Click the Install button." Please consider making the installation 1 click. I would really like to use this tool.

[danielkupco]

Hi @TimMackey,

First of all, many thanks for your remarks! This is exactly what is needed for ideas to grow and improve. Please bear in mind that this extension is made initially as a school project and not production ready, but I hope we will make it actually usable soon.

I will try to help you by walking through your remarks quickly now but I will definitely try to adopt all your suggestions in order to improve this extension.

Strike 1)
For the loss of all your custom Workspace Settings I really apologize but this did not happen to me while I tested it. Some crucial changes are made in this version for it to become cross-platform. I will try to reproduce and fix it in hope that this does not occur again.
And "dkupco.viewx-0.2.1" is just the naming convention how extensions are named when they are published, "publisherName.extensionName-version".

Strike 2)
This is not actually a Python but a Powershell script. I will try to make it easier and more clear in the future, but for now all that is needed to be passed as arguments are:

• path of some folder existing on your disk. It will be used as a parent folder for Python virtual environment.
• name of the folder. It will be created inside the previous folder and Python virtual environment will be created inside it.

Requirements are not needed if the script is run from "setup_scripts" folder. They are [optional] in that case.

Strike 3)
This extension is just an optional development tool for building DSLs in textx which is built in Python so setting up a Python environment is necessary. But, besides the previous step, nothing more is needed for you to start using the extension.

I will really try to make the setup more understandable and done in 1 click. Also, the documentation is planned to be created so all unnecessary setup steps that are stated here can be moved there and leave here the "Quick Start" really simple and easy.

Please feel free to give more suggestions, remarks, and contributions which are very welcome. As soon as I find some time I will try to make this extension's setup steps more readable and doable.

[ghost]

It's now December 2018 and 8 months have passed since your post. The tool is still unusable. If you are unable to automate the installation, please consider making the instructions "idiot-proof" for a non-python developer in the Windows environment.
Thank you.

[danielkupco]

Hi @TimMackey,

I am sorry I did not have time to dedicate to this project in past time but I plan to do so in the months to come.

I will try to make the installation steps as simple as it can be, however, you must at least install Python on your machine. It is mandatory since this extension is meant to be used for DSL development using textX, which is a Python-based DSL framework, after all. Besides that, all you have to do in order to complete the installation is to install the extension and run the Powershell setup script, which does not really require any Python knowledge.

I do really hope that I will have some more time to invest in this project so we can address all issues that make using this extension still a bit complicated.

Thank you for understanding.