Differential D234

Fix install and update docs
ClosedPublic
Actions

Authored by mkrizek on Sep 9 2014, 1:08 PM.

Details

Reviewers

tflink

Commits

rBLKR0d026f282baa: Fix install and update docs

Summary

Tried to set up a clean dev env and failed. This should fix it.

Test Plan

Set up a dev env according to the docs

Diff Detail

Repository

rBLKR blockerbugs

Lint

Lint Skipped

Unit

Unit Tests Skipped

mkrizek retitled this revision from to Fix install and update docs.Sep 9 2014, 1:08 PM

mkrizek updated this object.

mkrizek edited the test plan for this revision. (Show Details)

mkrizek added a reviewer: tflink.

Herald added a subscriber: tflink. · View Herald TranscriptSep 9 2014, 1:08 PM

my primary concern here is that we'd be making non-el6-compatible changes. while our dev envs are all fedora AFAIK, our production machines are all el6 and I sincerely doubt that we'll be seeing updates to wtf and flask-wtf in epel6.

I'd rather use requirements.txt to make sure that older versions of wtf and flask-wtf are being used. The other changes look good to me, though

This revision now requires changes to proceed.Sep 9 2014, 2:47 PM

Set wtf and flask-wtf versions to el6 versions in requirements.txt

According to my testing (doing a fresh dev env setup) it works on el6 versions.

LGTM

This revision is now accepted and ready to land.Sep 9 2014, 3:29 PM

Closed by commit rBLKR0d026f282baa (authored by @mkrizek).

Revision Contents

			Path	Packages
M			.gitignore (2 lines)
M			blockerbugs/controllers/forms.py (28 lines)
M			docs/source/development.rst (30 lines)
M			requirements.txt (7 lines)

Diff	ID	Base	Description	Created	Lint	Unit
Base			Base
Diff 1	653	584fb6d		Sep 9 2014, 1:08 PM	★	★
Diff 2	656	584fb6d	Set wtf and flask-wtf versions to el6 versions in requirements.txt	Sep 9 2014, 3:20 PM	★	★
Diff 3	658	ecb6058	Commit rBLKR0d026f282baa77082b9f156de49b93d94a973976	Sep 9 2014, 3:40 PM	★	★

Commit	Tree	Parents	Author	Summary	Date
b97c2f1e8ad6	af30f53c9808	584fb6d95ce7	Martin Krizek	Fix install and update docs (Show More…)	Sep 9 2014, 1:04 PM

Diff 658

View Options

.gitignore

1	*.pyc	1	*.pyc
2	*.pyo	2	*.pyo
3	*.swp	3	*.swp
4	env_blockerbugs/*	4	env_blockerbugs/*
5	__pycache__	5	__pycache__
6	*.ropeproject/	6	*.ropeproject/
7	conf/settings.py	7	conf/settings.py
8	.sass-cache/	8	.sass-cache/
9	.idea	9	.idea
		10	docs/_build/*
		11	blockerbugs_db.sqlite

View Options

blockerbugs/controllers/forms.py

Show All 15 Lines
16	# You should have received a copy of the GNU General Public License along	16	# You should have received a copy of the GNU General Public License along
17	# with this program; if not, write to the Free Software Foundation, Inc.,	17	# with this program; if not, write to the Free Software Foundation, Inc.,
18	# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.	18	# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
19	#	19	#
20	# Authors:	20	# Authors:
21	# Tim Flink <tflink@redhat.com>	21	# Tim Flink <tflink@redhat.com>
22		22
23		23
24	from flask.ext.wtf import Form, ValidationError, Required, Optional, Email	24	from flask.ext.wtf import Form
25	from flask.ext.wtf import TextField, SelectField, BooleanField, IntegerField	25	from wtforms import TextField, SelectField, BooleanField, IntegerField
26	from flask.ext.wtf import SelectMultipleField, TextAreaField, PasswordField	26	from wtforms import TextAreaField, PasswordField, ValidationError
27	from wtforms.validators import URL	27	from wtforms.validators import Required, Optional, Email
28
29
30	class MilestoneForm(Form):
31	release = SelectField(u'Release', [Required()], coerce=int)
32	version = TextField(u'Version', [Required()])
33	name = TextField(u'Name', [Required()])
34	blocker_tracker = IntegerField(u'Blocker Bug Tracker', [Required()])
35	fe_tracker = IntegerField(u'FE Bug Tracker', [Required()])
36	succeeds = SelectField(u'Succeeds', [Optional()], coerce=int)
37	active = BooleanField(u'Active')
38
39
40	class SpinForm(Form):
41	milestone = SelectField(u'Milestone', [Required()], coerce=int)
42	succeeds = SelectField(u'Succeeds', [Optional()], coerce=int)
43	name = TextField(u'Name', [Required()])
44	spin_type = TextField(u'Type', [Required()])
45	updates = SelectMultipleField(u'Updates', coerce=int)
46	state = SelectField(u'State')
47	url = TextField(u'URL', [URL()])
48		28
49		29
50	def one_proposal(form, field):	30	def one_proposal(form, field):
51	if not (form.freeze_exception.data or form.blocker.data):	31	if not (form.freeze_exception.data or form.blocker.data):
52	raise ValidationError('You must propose the bug as either a blocker or a freeze exception')	32	raise ValidationError('You must propose the bug as either a blocker or a freeze exception')
53		33
54		34
55	class BugProposeForm(Form):	35	class BugProposeForm(Form):
Show All 12 Lines

View Options

docs/source/development.rst

Show All 12 Lines
13		13
14	The instructions here will use virtualenv so that there are no potential	14	The instructions here will use virtualenv so that there are no potential
15	conflicts with system libs. At a bare minimum, you will need:	15	conflicts with system libs. At a bare minimum, you will need:
16		16
17	* python-virtualenv	17	* python-virtualenv
18		18
19	* libcurl-devel	19	* libcurl-devel
20		20
		21	* koji
		22
		23	* rpm-python
		24
		25	* pyOpenSSL
		26
21	If you plan on developing against a database other than sqlite, you will need	27	If you plan on developing against a database other than sqlite, you will need
22	to have that installed and configured, similarly to the production install	28	to have that installed and configured, similarly to the production install
23	documentation NEED LINK TO PRODUCTION DOCS HERE	29	documentation NEED LINK TO PRODUCTION DOCS HERE
24		30
25	Create a Virtualenv	31	Create a Virtualenv
26	===================	32	===================
27		33
28	Create a new virtualenv in the base of the source tree::	34	Create a new virtualenv in the base of the source tree::
29		35
30	virtualenv --distribute env_blockerbugs	36	virtualenv --distribute env_blockerbugs
31		37	pushd env_blockerbugs/lib/python2.7/site-packages
		38	ln -s /usr/lib/python2.7/site-packages/koji
		39	ln -s /usr/lib64/python2.7/site-packages/rpm
		40	ln -s /usr/lib64/python2.7/site-packages/OpenSSL
		41	popd
32		42
33	In order to install python packages into the virtualenv or use the packages	43	In order to install python packages into the virtualenv or use the packages
34	inside the virtualenv, it must be activated::	44	inside the virtualenv, it must be activated::
35		45
36	source env_blockerbugs/bin/activate	46	source env_blockerbugs/bin/activate
37		47
38	Install dependencies into the Virtualenv	48	Install dependencies into the Virtualenv
39	****************************************	49	========================================
40		50
41	To get all of the python packages into the virtualenv, use pip inside the	51	To get all of the python packages into the virtualenv, use pip inside the
42	virtualenv (ie. activate the virtualenv first)::	52	virtualenv (ie. activate the virtualenv first)::
43		53
44	pip install kitchen paver babel	54	pip install kitchen paver babel python-fedora
45	pip install python-fedora
46	pip install -r requirements.txt	55	pip install -r requirements.txt
47		56
48	python-fedora will throw some errors about permissions, but that is expected and
49	doesn't affect it's operation. However, it is important to install separately as
50	the errors will stop the installation of other deps in the requirements file.
51
52	Configuring dev environment	57	Configuring dev environment
53	===========================	58	===========================
54		59
55	To generate an initial config for a sqlite database, use the following command::	60	To generate an initial config for a sqlite database, use the following command::
56		61
57	python run_cli.py generate_config -d 'sqlite:////path/to/code/blockerbugs_db.sqlite'	62	python run_cli.py generate_config -d 'sqlite:////path/to/code/blockerbugs_db.sqlite'
58		63
59	The configuration file will be generated in the conf/ directory. While you would	64	The configuration file will be generated in the conf/ directory. While you would
60	copy this config file to /etc/blockerbugs in a production system, for a development	65	copy this config file to /etc/blockerbugs in a production system, for a development
61	installation, just leave it in the conf/ directory.	66	installation, just leave it in the conf/ directory.
62		67
63	The config generated by run_cli.py is very basic and may require tweaking to get	68	The config generated by run_cli.py is very basic and may require tweaking to get
64	the environment that you're looking for.	69	the environment that you're looking for.
65		70
66	''LINK TO CONFIGURATION OPTIONS''	71	''LINK TO CONFIGURATION OPTIONS''
67		72
68	Initializing the Environment (Lazy Method)	73	Initializing the Environment (Lazy Method)
69	------------------------------------------	74	------------------------------------------
70		75
71	The quick and easy way to initialize the environment with default settings for	76	The quick and easy way to initialize the environment with default settings for
72	a recent Fedora release is to run::	77	a recent Fedora release is to run::
73		78
74	./init_db.sh	79	bash init_db.sh
75		80
76	This shell script will initialize the configured database, set up a release and	81	This shell script will initialize the configured database, set up a release and
77	several milestones. The script is kept up to date for current Fedora releases	82	several milestones. The script is kept up to date for current Fedora releases
78	so that you don't need to memorize the relevant blocker and Freeze Exception	83	so that you don't need to memorize the relevant blocker and Freeze Exception
79	tracker bugs.	84	tracker bugs.
80		85
81	Initializing the Environment (Detailed Method)	86	Initializing the Environment (Detailed Method)
82	----------------------------------------------	87	----------------------------------------------
83		88
84	Most configuration post-installation is done using the cli. However, when working	89	Most configuration post-installation is done using the cli. However, when working
85	in a development environment, that cli isn't directly available and we need to	90	in a development environment, that cli isn't directly available and we need to
86	use the run_cli.py helper script which exposes the same commands.	91	use the run_cli.py helper script which exposes the same commands.
87		92
88	Once the config file has been generated, the database needs to be initialized::	93	Once the config file has been generated, the database needs to be initialized::
89		94
90	python run_cli.py init_db	95	python run_cli.py init_db
91		96
92	There are some internal variables in the db which are wise to set before attempting	97	There are some internal variables in the db which are wise to set before attempting
93	to run a sync. These are easily set using the run_cli.py script::	98	to run a sync. These are easily set using the run_cli.py script::
94		99
95	python run_cli.py add_release -r 19	100	python run_cli.py add_release -r 21
96	python run_cli.py add_milestone -r 19 -m alpha -b 834084 -a 834085	101
		102	python run_cli.py add_milestone -r 21 -m alpha -b 1043119 -a 1043122
		103	python run_cli.py add_milestone -r 21 -m beta -b 1043124 -a 1043127
		104	python run_cli.py add_milestone -r 21 -m final -b 1043129 -a 1043131
97		105
98	This will add a F19 release and an alpha phase using 834084 and 834085 as	106	This will add a F19 release and an alpha phase using 834084 and 834085 as
99	blocker and FE tracking bugs, respectively.	107	blocker and FE tracking bugs, respectively.
100		108
101	Running Sync Against Bugzilla and Bodhi	109	Running Sync Against Bugzilla and Bodhi
102	=======================================	110	=======================================
103		111
104	To do an initial sync, simply run the following command::	112	To do an initial sync, simply run the following command::
Show All 20 Lines

View Options

requirements.txt

1	Flask==0.9	1	Flask==0.9
2	Flask-SQLAlchemy==0.16	2	Flask-SQLAlchemy==0.16
3	Flask-WTF>=0.8	3	Flask-WTF==0.8
4	Jinja2==2.6	4	Jinja2==2.6
5	SQLAlchemy==0.7.8	5	SQLAlchemy==0.7.8
6	WTAlchemy==0.1b3	6	WTAlchemy==0.1b3
7	WTForms>=1.0.1	7	WTForms==1.0.2
8	Werkzeug==0.8.3	8	Werkzeug==0.8.3
9	bunch==1.0.1	9	bunch==1.0.1
10	distribute==0.6.24	10	distribute==0.6.24
11	mock>=0.8.0	11	mock>=0.8.0
12	py==1.4.9	12	py==1.4.9
13	pytest==2.2.4	13	pytest==2.2.4
14	pytest-cov==1.6	14	pytest-cov==1.6
15	python-bugzilla>=1.1.0	15	python-bugzilla>=1.1.0
16	wsgiref==0.1.2	16	wsgiref==0.1.2
17	kitchen==1.1.1	17	kitchen==1.1.1
18	python-fedora>=0.3.33	18	python-fedora>=0.3.33
19	pycurl==7.19.0	19	pycurl==7.19.0
20	Flask-FAS>=0.1.0	20	Flask-FAS>=0.1.0
21	dingus==0.3.4	21	dingus==0.3.4
22	alembic==0.5.0	22	alembic==0.5.0
23	flask-admin==1.0.5	23	flask-admin==1.0.5
24	iso8601==0.1.4	24	iso8601==0.1.4
25	Flask-Assets==0.8	25	Flask-Assets==0.8
26	cssmin==0.1.4	26	cssmin==0.1.4
		27	python-openid==2.2.5
		28	python-openid-cla==1.0
		29	python-openid-teams==1.0

Fix install and update docsClosedPublicActions

Details

Diff Detail

Revision Contents

Diff 658

.gitignore

blockerbugs/controllers/forms.py

docs/source/development.rst

requirements.txt

Fix install and update docs
ClosedPublic
Actions