-
Notifications
You must be signed in to change notification settings - Fork 2
/
README
87 lines (55 loc) · 1.9 KB
/
README
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
.. image:: https://travis-ci.org/mriehl/pyb_init.png?branch=master
:alt: Travis build status image
:align: left
:target: https://travis-ci.org/mriehl/pyb_init
.. image:: https://badge.fury.io/py/pyb_init.png
:target: https://badge.fury.io/py/pyb_init
:alt: Latest PyPI version
.. image:: http://www.wtfpl.net/wp-content/uploads/2012/12/wtfpl-badge-1.png
:target: http://www.wtfpl.net
:alt: Licensed under the WTFPL
What it does
============
When using the `PyBuilder <http://pybuilder.github.io>`_, every project
needs to be initialized. After checking out the project, you need to
- Create a virtual environment.
- Activate the virtual environment.
- Install the pybuilder in the virtual environment.
- Install the project dependencies in the virtual environment.
- Run pyb to build and test your project.
This program is an attempt at making these routine operations dead
simple and time-efficient. Note that virtual environments are always
created with the --clear flag, meaning you can run pyb-init to *reset*
your virtual environment, for example after changing a dependency.
Installation
============
::
sudo pip install pyb_init
Checkout from GitHub
====================
::
pyb-init github user : project
Git checkout
============
::
pyb-init git GIT_URL
SVN checkout
============
::
pyb-init svn SVN_URL
Initialization from local project
=================================
When in the project root, run
::
pyb-init local
Customization of the generated environment
==========================================
You can override the default name of the virtualenv with
::
--virtualenv-name=<name>
Also, you can include your systems's site-packages in the virtualenv (for OS-packaged bindings like YUM, etc..) with the flag
::
--system-site-packages
License
=======
pyb_init is licensed under the terms of the Do What The Fuck You Want To public license.