Summary

Make Review Board package develop mode install wheels/npm packages.

Review Request #8494 — Created Oct. 26, 2016 and submitted Oct. 27, 2016, 5:09 p.m.

Information

Owner

chipx86

Repository

Review Board

Branch

release-3.0.x

Bugs

Depends On

~~8493~~

Commit

58a805b...

Reviewers

Groups

reviewboard

People

Description

This simplifies getting going with a Review Board source tree. Before,
Review Board would require a few steps to get set up, which included
installing running setup.py develop (and having everything in place to
compile Pillow and other modules), installing the packages in
dev-requirements.txt, and installing the required node modules. That was
a lot of steps, and caused problems for those getting started
(particularly as some complex dependencies are no longer shipped as
eggs).

Now, setup.py develop takes care of installing dependencies as wheels,
installing development packages, and installing modules from npm. It's a
far simpler process than we've had in the past.

Like in the accompanying Djblets change, the package dependencies now
live in a reviewboard.dependencies module. This will help simplify
things for us in some ways (such as with RBCommons packaging and
extension packaging).

The prepare-dev.py script has been updated to no longer install
modules itself, and to allow develop to do more work.

Testing Done

Used a new virtualenv consisting of just the Djblets source tree and
dependencies. Used a clean copy of the Review Board source tree. Ran
./setup.py develop and saw it install wheels and node modules. Ran
unit tests and they passed.

Created a new environment and installed Djblets into it. Then I set up
the Review Board tree using ./contrib/internal/prepare-dev.py and
repeated tests. Everything worked.

Issues

Description	From	Last Updated
Can you remove the django_version definition from reviewboard/__init__.py?	david	Oct. 26, 2016, 2:31 p.m.
Docstring?	david	Oct. 26, 2016, 2:36 p.m.
Docstring?	david	Oct. 26, 2016, 2:36 p.m.
Docstring?	david	Oct. 26, 2016, 2:36 p.m.
Docstring?	david	Oct. 26, 2016, 2:36 p.m.
Docstring?	david	Oct. 26, 2016, 2:36 p.m.
Docstring?	david	Oct. 26, 2016, 2:36 p.m.
Docstring?	david	Oct. 26, 2016, 2:36 p.m.
Col: 1 E402 module level import not at top of file	reviewbot	Oct. 26, 2016, 5:50 p.m.
Col: 1 E402 module level import not at top of file	reviewbot	Oct. 26, 2016, 5:50 p.m.
'reviewboard' imported but unused	reviewbot	Oct. 26, 2016, 5:50 p.m.
Why not super(...).initialize_options() ?	brennie	Oct. 26, 2016, 3:31 p.m.
"Mercurial"	brennie	Oct. 26, 2016, 3:31 p.m.
Col: 1 E402 module level import not at top of file	reviewbot	Oct. 26, 2016, 5:49 p.m.
Col: 1 E402 module level import not at top of file	reviewbot	Oct. 26, 2016, 5:49 p.m.
'reviewboard' imported but unused	reviewbot	Oct. 26, 2016, 5:49 p.m.
Col: 1 E402 module level import not at top of file	reviewbot	Oct. 26, 2016, 5:51 p.m.
'pkg_resources' imported but unused	reviewbot	Oct. 26, 2016, 5:51 p.m.
Col: 1 E402 module level import not at top of file	reviewbot	Oct. 26, 2016, 5:51 p.m.
Col: 1 E402 module level import not at top of file	reviewbot	Oct. 26, 2016, 5:51 p.m.
'reviewboard' imported but unused	reviewbot	Oct. 26, 2016, 5:51 p.m.

Tool: PEP8 Style Checker
Processed Files:
    reviewboard/dependencies.py
    setup.py
    contrib/internal/prepare-dev.py

Ignored Files:
    package.json



Tool: Pyflakes
Processed Files:
    reviewboard/dependencies.py
    setup.py
    contrib/internal/prepare-dev.py

Ignored Files:
    package.json

Depends On:: ~~8493 - Make Djblets package develop mode compatible with wheels and npm packages.~~

The issue has been resolved. Show all issues

Can you remove the django_version definition from reviewboard/__init__.py?

setup.py (Diff revision 1)
The issue has been resolved. Show all issues
```
Docstring?
```
setup.py (Diff revision 1)
The issue has been resolved. Show all issues
```
Docstring?
```
setup.py (Diff revision 1)
The issue has been resolved. Show all issues
```
Docstring?
```
setup.py (Diff revision 1)
The issue has been resolved. Show all issues
```
Docstring?
```
setup.py (Diff revision 1)
The issue has been resolved. Show all issues
```
Docstring?
```
setup.py (Diff revision 1)
The issue has been resolved. Show all issues
```
Docstring?
```
setup.py (Diff revision 1)
The issue has been resolved. Show all issues
```
Docstring?
```

Change Summary:


Added a Command suffix to the new command classes.
Added docstrings.
Removed the Django constants from reviewboard/__init__.py.
Fixed doc generation.

Commit:

61bf5c741fe7da2d1a407c43654adb6610e9e0eb

06f24fef4880982d61a9067ac7fa04fc6052306f

Diff:

Revision 2 (+225 -55)

Show changes

	package.json
	setup.py
	contrib/internal/prepare-dev.py
	docs/manual/conf.py
	docs/releasenotes/conf.py
	reviewboard/__init__.py
	reviewboard/dependencies.py

Tool: Pyflakes
Processed Files:
    reviewboard/__init__.py
    reviewboard/dependencies.py
    docs/releasenotes/conf.py
    contrib/internal/prepare-dev.py
    docs/manual/conf.py
    setup.py

Ignored Files:
    package.json



Tool: PEP8 Style Checker
Processed Files:
    reviewboard/__init__.py
    reviewboard/dependencies.py
    docs/releasenotes/conf.py
    contrib/internal/prepare-dev.py
    docs/manual/conf.py
    setup.py

Ignored Files:
    package.json

docs/manual/conf.py (Diff revision 2)
The issue has been dropped. Show all issues
```
Col: 1
 E402 module level import not at top of file
```
docs/releasenotes/conf.py (Diff revision 2)
The issue has been dropped. Show all issues
```
Col: 1
 E402 module level import not at top of file
```
reviewboard/__init__.py (Diff revision 2)
The issue has been dropped. Show all issues
```
 'reviewboard' imported but unused
```

setup.py (Diff revision 2)

The issue has been dropped. Show all issues

Why not super(...).initialize_options() ?

chipx86 Oct. 26, 2016, 3:31 p.m.

The distutils base objects don't inherit from object, so you can't use super(). It's lame.

setup.py (Diff revision 2)
The issue has been dropped. Show all issues
```
"Mercurial"
```
1. chipx86 Oct. 26, 2016, 3:31 p.m.
  I'm referencing the package name here.

Change Summary:

Added a --use-npm-cache option to enable using npm-cache. Otherwise, npm is used.

Commit:

06f24fef4880982d61a9067ac7fa04fc6052306f

56fbfc9927c021605210d04d2641639f3d93ebe3

Diff:

Revision 3 (+235 -55)

Show changes

	package.json
	setup.py
	contrib/internal/prepare-dev.py
	docs/manual/conf.py
	docs/releasenotes/conf.py
	reviewboard/__init__.py
	reviewboard/dependencies.py

Tool: Pyflakes
Processed Files:
    reviewboard/__init__.py
    reviewboard/dependencies.py
    docs/releasenotes/conf.py
    contrib/internal/prepare-dev.py
    docs/manual/conf.py
    setup.py

Ignored Files:
    package.json



Tool: PEP8 Style Checker
Processed Files:
    reviewboard/__init__.py
    reviewboard/dependencies.py
    docs/releasenotes/conf.py
    contrib/internal/prepare-dev.py
    docs/manual/conf.py
    setup.py

Ignored Files:
    package.json

docs/manual/conf.py (Diff revision 3)
The issue has been dropped. Show all issues
```
Col: 1
 E402 module level import not at top of file
```
docs/releasenotes/conf.py (Diff revision 3)
The issue has been dropped. Show all issues
```
Col: 1
 E402 module level import not at top of file
```
reviewboard/__init__.py (Diff revision 3)
The issue has been dropped. Show all issues
```
 'reviewboard' imported but unused
```

Change Summary:


Fixed static media building.
Made bdist_wheel generate static media.
Broke the Djblets version out into its own variable. This is because we modify this

  more than any other dependency, and it often leads to conflicts when merging branches

  or into RBCommons.

Commit:

56fbfc9927c021605210d04d2641639f3d93ebe3

58a805bcbd824e84928b672bcb3e96c8dff79220

Diff:

Revision 4 (+244 -57)

Show changes

	package.json
	setup.py
	contrib/internal/build-media.py
	contrib/internal/prepare-dev.py
	docs/manual/conf.py
	docs/releasenotes/conf.py
	reviewboard/__init__.py
	reviewboard/dependencies.py

Tool: Pyflakes
Processed Files:
    reviewboard/__init__.py
    reviewboard/dependencies.py
    docs/releasenotes/conf.py
    contrib/internal/build-media.py
    docs/manual/conf.py
    setup.py
    contrib/internal/prepare-dev.py

Ignored Files:
    package.json



Tool: PEP8 Style Checker
Processed Files:
    reviewboard/__init__.py
    reviewboard/dependencies.py
    docs/releasenotes/conf.py
    contrib/internal/build-media.py
    docs/manual/conf.py
    setup.py
    contrib/internal/prepare-dev.py

Ignored Files:
    package.json

contrib/internal/build-media.py (Diff revision 4)
The issue has been dropped. Show all issues
```
Col: 1
 E402 module level import not at top of file
```
contrib/internal/build-media.py (Diff revision 4)
The issue has been dropped. Show all issues
```
 'pkg_resources' imported but unused
```
docs/manual/conf.py (Diff revision 4)
The issue has been dropped. Show all issues
```
Col: 1
 E402 module level import not at top of file
```
docs/releasenotes/conf.py (Diff revision 4)
The issue has been dropped. Show all issues
```
Col: 1
 E402 module level import not at top of file
```
reviewboard/__init__.py (Diff revision 4)
The issue has been dropped. Show all issues
```
 'reviewboard' imported but unused
```

Ship it!

```
Ship It!
```

Status:: Completed
Change Summary:: Pushed to release-3.0.x (47a4997)