Summary

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

Review Request #11393 — Created Jan. 21, 2021 and discarded Jan. 22, 2021, 10:46 a.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. 22, 2021, 10:15 a.m.
Can you flesh out the testing done?	david	Jan. 22, 2021, 10:15 a.m.
There should be a blank line between these two.	david	Jan. 22, 2021, 10:17 a.m.
Typo: two spaces between "in" and "the"	david	Jan. 22, 2021, 10:17 a.m.
E126 continuation line over-indented for hanging indent	reviewbot	Jan. 22, 2021, 10:15 a.m.
We need to add global ui here to assign to the global.	david	Jan. 22, 2021, 10:17 a.m.
Please use single quotes for this string.	david	Jan. 22, 2021, 10:17 a.m.
Please add a blank line.	david	Jan. 22, 2021, 10:17 a.m.
These two strings will get concatenated, so the first one needs a space at the end.	david	Jan. 22, 2021, 10:17 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
```

Looking ok, just a few small issues and one big one (see global ui comment)

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 should be a blank line between these two.
```
contrib/internal/prepare-dev.py (Diff revision 1)
The issue has been resolved. Show all issues
```
Typo: two spaces between "in" and "the"
```

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

What does os.system do?

chipx86 Jan. 22, 2021, 10:18 a.m.

It's used to execute processes, similar to running a command in a shell. It's not always the right approach — the subprocess module is sometimes the better solution here.

contrib/internal/prepare-dev.py (Diff revision 1)
The issue has been resolved. Show all issues
```
We need to add global ui here to assign to the global.
```
contrib/internal/prepare-dev.py (Diff revision 1)
The issue has been resolved. Show all issues
```
Please use single quotes for this string.
```
contrib/internal/prepare-dev.py (Diff revision 1)
The issue has been resolved. Show all issues
```
Please add a blank line.
```

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

The issue has been resolved. Show all issues

These two strings will get concatenated, so the first one needs a space at the end.

Change Summary:


Fixed up typos in some of the new strings and in the Description.
Added a global ui and re-verified with testing.
Added missing blank lines.

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
	[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 (+139 -49)

Show changes

contrib/internal/prepare-dev.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Ship it!

```
Ship It!
```

Status:: Discarded
Change Summary:: Completed the demo for Spring 2021.1.