Summary

[Demo] Enhance and fix up the setup experience in prepare-dev.py.

Review Request #11951 — Created Jan. 21, 2022 and discarded March 24, 2022, 1:37 p.m.

Information

Owner

chipx86

Repository

Review Board

Branch

release-4.0.x

Bugs

Depends On

Reviewers

Groups

reviewboard

People

Description

This modernizes the way we request input and display output on
prepare-dev.py, utilizing more of rb-site's ConsoleUI. This is a
better, more consistent way of displaying information and prompting for
information.

The text has been updated to be more user-friendly, to offer
guidance for when things go wrong, and to provide next steps when the
environment is prepared.

Testing Done

Ran through prepare-dev.py with a brand-new clone and database, and also
with an existing one.

Verified dependencies were installed.

Verified each new text string was correct and free from typos.

Commits

Summary	ID
[Demo] Enhance and fix up the setup experience in prepare-dev.py. This modernizes the way we request input and display output on `prepare-dev.ppy`, utilizing more of rb-site's `ConsoleUI`. This is a better, more consistent way of displaying information and prompting for information. The text has been updated to be more user-friendly, to offer guidance for when things go wrong, and to provide next steps when the environment is prepared.	e30f2fcf4418c1fd419ba7d034fbcabb3accca92
Fixes from review feedback.	e77f748462f8a4a61f0dca6076dfd58b00a308da

Summary

[Demo] Enhance and fix up the setup experience in prepare-dev.py.

This modernizes the way we request input and display output on `prepare-dev.ppy`, utilizing more of rb-site's `ConsoleUI`. This is a better, more consistent way of displaying information and prompting for information. The text has been updated to be more user-friendly, to offer guidance for when things go wrong, and to provide next steps when the environment is prepared.

e30f2fcf4418c1fd419ba7d034fbcabb3accca92

Fixes from review feedback.

e77f748462f8a4a61f0dca6076dfd58b00a308da

Issues

Description	From	Last Updated
Typo in description: prepare-dev.ppy -> prepare-dev.py	david	Jan. 21, 2022, 10:15 a.m.
Can you flesh out the testing done?	david	Jan. 21, 2022, 10:17 a.m.
There needs to be a blank line between the description and the type.	david	Jan. 21, 2022, 10:17 a.m.
There's an extra space between "in" and "the"	david	Jan. 21, 2022, 10:17 a.m.
E126 continuation line over-indented for hanging indent	reviewbot	Jan. 21, 2022, 10:18 a.m.
If this is meant to set the global variable, you need global ui	david	Jan. 21, 2022, 10:18 a.m.
Please use single quotes instead of double.	david	Jan. 21, 2022, 10:18 a.m.
Please add a blank line between these.	david	Jan. 21, 2022, 10:18 a.m.
There's a missing space at the end of the first line.	david	Jan. 21, 2022, 10:18 a.m.

flake8 failed.

JSHint passed.

flake8

contrib/internal/prepare-dev.py (Diff revision 1)
The issue has been resolved. Show all issues
```
E126 continuation line over-indented for hanging indent
```

Looks pretty good, just a few style issues and one important global variable problem.

The issue has been resolved. Show all issues

Typo in description: prepare-dev.ppy -> prepare-dev.py

The issue has been resolved. Show all issues
```
Can you flesh out the testing done?
```
contrib/internal/prepare-dev.py (Diff revision 1)
The issue has been resolved. Show all issues
```
There needs to be a blank line between the description and the type.
```
contrib/internal/prepare-dev.py (Diff revision 1)
The issue has been resolved. Show all issues
```
There's an extra space between "in" and "the"
```

contrib/internal/prepare-dev.py (Diff revision 1)

I've never seen this before, what does os.system do?

chipx86 Jan. 21, 2022, 10:14 a.m.

It's used to execute processes. Similar to running a command in bash or any other shell. I might want to revisit this, move to subprocess.Popen.

contrib/internal/prepare-dev.py (Diff revision 1)
The issue has been resolved. Show all issues
```
If this is meant to set the global variable, you need global ui
```
contrib/internal/prepare-dev.py (Diff revision 1)
The issue has been resolved. Show all issues
```
Please use single quotes instead of double.
```
contrib/internal/prepare-dev.py (Diff revision 1)
The issue has been resolved. Show all issues
```
Please add a blank line between these.
```
contrib/internal/prepare-dev.py (Diff revision 1)
The issue has been resolved. Show all issues
```
There's a missing space at the end of the first line.
```

Change Summary:


Fixed the typo in the description.
Fleshed out the testing done.
Added missing blank lines and removed unwanted spaces.
Added the missing global.
Changed double quotes to single quotes.

Description:

		This modernizes the way we request input and display output on
~		`prepare-dev.ppy`, utilizing more of rb-site's `ConsoleUI`. This is a
	~	`prepare-dev.py`, utilizing more of rb-site's `ConsoleUI`. This is a
		better, more consistent way of displaying information and prompting for
		information.

		The text has been updated to be more user-friendly, to offer
		guidance for when things go wrong, and to provide next steps when the
		environment is prepared.

Testing Done:

~		Tested prepare-dev.py.
	~	Ran through `prepare-dev.py` with a brand-new clone and database, and also
	+	with an existing one.
	+
	+	Verified dependencies were installed.
	+
	+	Verified each new text string was correct and free from typos.

Commits:

	Summary	ID
	[Demo] Enhance and fix up the setup experience in prepare-dev.py. This modernizes the way we request input and display output on `prepare-dev.ppy`, utilizing more of rb-site's `ConsoleUI`. This is a better, more consistent way of displaying information and prompting for information. The text has been updated to be more user-friendly, to offer guidance for when things go wrong, and to provide next steps when the environment is prepared.	e30f2fcf4418c1fd419ba7d034fbcabb3accca92
	Fixes from review feedback.	e77f748462f8a4a61f0dca6076dfd58b00a308da

Diff:

Revision 2 (+16 -8)

Show changes

contrib/internal/prepare-dev.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Commits:

	Summary	ID
	Fixes from review feedback.	e77f748462f8a4a61f0dca6076dfd58b00a308da
	[Demo] Enhance and fix up the setup experience in prepare-dev.py. This modernizes the way we request input and display output on `prepare-dev.ppy`, utilizing more of rb-site's `ConsoleUI`. This is a better, more consistent way of displaying information and prompting for information. The text has been updated to be more user-friendly, to offer guidance for when things go wrong, and to provide next steps when the environment is prepared.	e30f2fcf4418c1fd419ba7d034fbcabb3accca92
	Fixes from review feedback.	e77f748462f8a4a61f0dca6076dfd58b00a308da

Diff:

Revision 3 (+139 -49)

Show changes

contrib/internal/prepare-dev.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Status:: Discarded