Summary

Add the initial structure around rbpkg.

Review Request #7657 — Created Sept. 24, 2015 and submitted Oct. 21, 2015, 2:09 p.m.

Information

Owner

chipx86

Repository

rbpkg

Branch

master

Bugs

Depends On

Reviewers

Groups

rbpkg

People

Description

This adds the command structure for rbpkg, the new package installer for
Review Board. Right now, there aren't any commands available, but those
will come later.

rbpkg's command structure is modeled heavily off of RBTools.

Some may wonder why we're building our own installer, so I provided a
bunch of rationalization in the README.md.

Testing Done

Ran rbpkg. Got help output.

There are no commands yet, so.. we'll see how well it works in practice!

Issues

Description	From	Last Updated
Typo -- dependencies.	gmyers	Oct. 10, 2015, 12:16 a.m.
", largely because ...."	brennie	Oct. 10, 2015, 12:03 a.m.
" -- and will soon require -- "	brennie	Oct. 10, 2015, 12:03 a.m.
typo and grammar "modules, but this does not work for us for a number of reasons"	brennie	Oct. 10, 2015, 12:04 a.m.
No comma.	brennie	Oct. 10, 2015, 12:23 a.m.
"PyPI doesn't really allow this if we host all our packages there."	brennie	Oct. 10, 2015, 12:09 a.m.
"storing our packages"	brennie	Oct. 10, 2015, 12:10 a.m.
I don't think "all-too-frequently" should be hyphenated.	AD adriano	Oct. 10, 2015, 12:19 a.m.
"... from PyPI over HTTPS and ..." (or use parenthesis around "over HTTPS")	brennie	Oct. 10, 2015, 12:10 a.m.
No comma	brennie	Oct. 10, 2015, 12:11 a.m.
"It only works with our official, maintained, and signed list of packages. This way you always know you're getting our …	brennie	Oct. 10, 2015, 12:13 a.m.
s/getting/installing ?	brennie	Oct. 10, 2015, 12:13 a.m.
No comma needed.	CH chronicleyu	Oct. 10, 2015, 12:20 a.m.
" rbpkg "	brennie	Oct. 10, 2015, 12:23 a.m.
"Public" should be lowercase.	AD adriano	Oct. 10, 2015, 12:20 a.m.
add_argument	brennie	Oct. 10, 2015, 12:15 a.m.
Col: 80 E501 line too long (81 > 79 characters)	reviewbot	Oct. 10, 2015, 12:02 a.m.
"command"	brennie	Oct. 10, 2015, 12:15 a.m.
'find_packages' imported but unused	reviewbot	Oct. 10, 2015, 12:02 a.m.
'VERSION' imported but unused	reviewbot	Oct. 10, 2015, 12:03 a.m.
'is_release' imported but unused	reviewbot	Oct. 10, 2015, 12:03 a.m.
Can we also add *.swp?	david	Oct. 20, 2015, 12:59 p.m.
Typo (nam -> name)	david	Oct. 20, 2015, 12:59 p.m.

Tool: PEP8 Style Checker
Processed Files:
    rbpkg/commands/main.py
    rbpkg/__init__.py
    setup.py
    rbpkg/commands/base.py

Ignored Files:
    rbpkg/commands/__init__.py
    MANIFEST.in
    .gitignore
    .reviewboardrc
    COPYING
    AUTHORS
    README.md



Tool: Pyflakes
Processed Files:
    rbpkg/commands/main.py
    rbpkg/__init__.py
    setup.py
    rbpkg/commands/base.py

Ignored Files:
    rbpkg/commands/__init__.py
    MANIFEST.in
    .gitignore
    .reviewboardrc
    COPYING
    AUTHORS
    README.md

rbpkg/commands/base.py (Diff revision 1)
The issue has been resolved. Show all issues
```
Col: 80
 E501 line too long (81 > 79 characters)
```
setup.py (Diff revision 1)
The issue has been resolved. Show all issues
```
 'find_packages' imported but unused
```
setup.py (Diff revision 1)
The issue has been resolved. Show all issues
```
 'VERSION' imported but unused
```
setup.py (Diff revision 1)
The issue has been resolved. Show all issues
```
 'is_release' imported but unused
```

<p>Typo in your description: "modelled"</p>

README.md (Diff revision 1)
The issue has been resolved. Show all issues
```
", largely because ...."
```
README.md (Diff revision 1)
The issue has been resolved. Show all issues
```
" -- and will soon require -- "
```

README.md (Diff revision 1)

The issue has been resolved. Show all issues

typo and grammar

"modules, but this does not work for us for a number of reasons"

README.md (Diff revision 1)

The issue has been dropped. Show all issues

No comma.

chipx86

Oct. 10, 2015, 12:16 a.m.

This is one of those cases where I'm using a comma to pause for, I guess, emphasis, like if I'm speaking out loud: "geared toward showing the latest few versions of a package... and becomes a barrier for the users we work with."

README.md (Diff revision 1)

The issue has been resolved. Show all issues

"PyPI doesn't really allow this if we host all our packages there."

README.md (Diff revision 1)
The issue has been resolved. Show all issues
```
"storing our packages"
```

README.md (Diff revision 1)

The issue has been resolved. Show all issues

"... from PyPI over HTTPS and ..." (or use parenthesis around "over HTTPS")

README.md (Diff revision 1)
The issue has been resolved. Show all issues
```
No comma
```

README.md (Diff revision 1)

The issue has been resolved. Show all issues

"It only works with our official, maintained, and signed list of packages. This way you always know you're getting our stuff."

README.md (Diff revision 1)
The issue has been resolved. Show all issues
```
s/getting/installing ?
```

README.md (Diff revision 1)

The issue has been dropped. Show all issues

" rbpkg "

chipx86

Oct. 10, 2015, 12:16 a.m.
```
I'm not sure what you're saying here.
```

adriano

Oct. 10, 2015, 12:20 a.m.

I think that Barret recommends that you surround rbpkg with backticks, so that it renders in monospaced font.

chipx86

Oct. 10, 2015, 12:21 a.m.

Ah. In this case, it's the name given to this, not the executable name. Same reason I don't put backticks around "pip" everywhere I mention it.

rbpkg/commands/base.py (Diff revision 1)
The issue has been resolved. Show all issues
```
add_argument
```
rbpkg/commands/main.py (Diff revision 1)
The issue has been resolved. Show all issues
```
"command"
```
1. chipx86
  
  Oct. 10, 2015, 12:16 a.m.
  My 'e', 'd', an 'r' keys are not reliable right now :(

README.md (Diff revision 1)
The issue has been resolved. Show all issues
```
Typo -- dependencies.
```

README.md (Diff revision 1)

Instead of "for many good reason", consider using either "for good reason" or "for many good reasons".

chipx86

Oct. 10, 2015, 12:20 a.m.

's' is part of a cluster of keys that aren't working well on my keyboard. :(

README.md (Diff revision 1)
The issue has been resolved. Show all issues
```
I don't think "all-too-frequently" should be hyphenated.
```
README.md (Diff revision 1)
The issue has been resolved. Show all issues
```
"Public" should be lowercase.
```

README.md (Diff revision 1)
The issue has been resolved. Show all issues
```
No comma needed.
```

Change Summary:


Fixed various typos and other issues in the README.
Fixed Review Bot complaints.

Diff:

Revision 2 (+604)

Show changes

	.gitignore
	.reviewboardrc
	AUTHORS
	COPYING
	MANIFEST.in
	README.md
	setup.py
	rbpkg/__init__.py
	3 more

Tool: Pyflakes
Processed Files:
    rbpkg/commands/main.py
    rbpkg/__init__.py
    setup.py
    rbpkg/commands/base.py

Ignored Files:
    rbpkg/commands/__init__.py
    MANIFEST.in
    .gitignore
    .reviewboardrc
    COPYING
    AUTHORS
    README.md



Tool: PEP8 Style Checker
Processed Files:
    rbpkg/commands/main.py
    rbpkg/__init__.py
    setup.py
    rbpkg/commands/base.py

Ignored Files:
    rbpkg/commands/__init__.py
    MANIFEST.in
    .gitignore
    .reviewboardrc
    COPYING
    AUTHORS
    README.md

Ship it!

.gitignore (Diff revision 2)
The issue has been resolved. Show all issues
```
Can we also add *.swp?
```
rbpkg/commands/main.py (Diff revision 2)
The issue has been resolved. Show all issues
```
Typo (nam -> name)
```

Change Summary:


Fixed typos.
Fixed help output.
Added .*.swp files to .gitignore.

Diff:

Revision 3 (+604)

Show changes

	.gitignore
	.reviewboardrc
	AUTHORS
	COPYING
	MANIFEST.in
	README.md
	setup.py
	rbpkg/__init__.py
	3 more

Tool: Pyflakes
Processed Files:
    rbpkg/commands/main.py
    rbpkg/__init__.py
    setup.py
    rbpkg/commands/base.py

Ignored Files:
    rbpkg/commands/__init__.py
    MANIFEST.in
    .gitignore
    .reviewboardrc
    COPYING
    AUTHORS
    README.md



Tool: PEP8 Style Checker
Processed Files:
    rbpkg/commands/main.py
    rbpkg/__init__.py
    setup.py
    rbpkg/commands/base.py

Ignored Files:
    rbpkg/commands/__init__.py
    MANIFEST.in
    .gitignore
    .reviewboardrc
    COPYING
    AUTHORS
    README.md

Ship it!

```
Ship It!
```

Status:: Completed