13
13
### main commands
14
14
15
15
Control your remote git hosting services from the ` git ` commandline. The usage is
16
- very simple. To clone a new project, out of github , just issue:
16
+ very simple. To clone a new project, out of GitHub , just issue:
17
17
18
18
% git hub clone guyzmo/git-repo
19
19
20
- But that works also with a project from gitlab, bitbucket , or your own gitlab :
20
+ But that works also with a project from GitLab, Bitbucket , or your own GitLab :
21
21
22
22
% git lab clone guyzmo/git-repo
23
23
% git bb clone guyzmo/git-repo
@@ -57,7 +57,7 @@ Also, you can open the repository's page, using the `open` command:
57
57
58
58
### Requests for merges * (aka Pull Requests aka Merge Requests)*
59
59
60
- Once you're all set with your repository, you can check requests to merge
60
+ Once you're all set with your repository, you can check requests to merge
61
61
(aka Pull Requests on github) using the ` request ` command:
62
62
63
63
% git hub request guyzmo/git-repo list
@@ -109,7 +109,7 @@ And when you're done you just get rid of it:
109
109
Successfully deleted gist!
110
110
111
111
> * Nota Bene* : Thanks to ` git ` CLI flexibility, by installing ` git-repo ` you directly
112
- > have acces to the tool using ` git-repo hub … ` or ` git repo hub … ` . For the
112
+ > have access to the tool using ` git-repo hub … ` or ` git repo hub … ` . For the
113
113
> ` git hub … ` call, you have to set up aliases, see below how to configure that.
114
114
115
115
And as a bonus, each time it's adding a new remote, it's updating the ` all ` remote,
@@ -166,7 +166,7 @@ for the service you use:
166
166
167
167
% git-repo bit clone guyzmo/git-repo
168
168
169
- Also, you can setup your own gitlab self-hosted server, using that configuration:
169
+ Also, you can setup your own GitLab self-hosted server, using that configuration:
170
170
171
171
[gitrepo "myprecious"]
172
172
type = gitlab
@@ -188,7 +188,7 @@ So you can run the tool as a git subcommand:
188
188
### Development
189
189
190
190
For development, I like to use ` buildout ` , and the repository is already configured
191
- for that. All you have to do, is install buildout, and then call it from the root of
191
+ for that. All you have to do, is install buildout, and then call it from the root of
192
192
the repository:
193
193
194
194
% pip install zc.buildout
@@ -198,6 +198,19 @@ and then you'll have the executable in `bin`:
198
198
199
199
% bin/git-repo --help
200
200
201
+ #### Verbose running
202
+
203
+ You can repeat the ` -v ` argument several times to increase the level of verbosity
204
+ of ` git-repo ` . The more arguments you give, the more details you'll have.
205
+
206
+ * ` -v ` will set the debugging level to ` DEBUG ` , giving some execution info ;
207
+ * ` -vv ` will print out all the git commands that are being executed ;
208
+ * ` -vvv ` will give more verbose insight on the git layer ;
209
+ * ` -vvvv ` will output all the HTTP exchanges with the different APIs ;
210
+ * ` -vvvvv ` will printout how were parsed the arguments.
211
+
212
+ ##### Testing
213
+
201
214
To run the tests:
202
215
203
216
% bin/py.test
@@ -208,25 +221,24 @@ You can use the following options for py.test to help you debug when tests fail:
208
221
* ` -x ` will stop upon the first failure
209
222
* ` --pdb ` will launch the debugger where an exception has been launched
210
223
211
-
212
224
The tests use recordings of exchanged HTTP data, so that we don't need real credentials
213
225
and a real connection, when testing the API on minor changes. Those recordings are
214
226
called cassettes, thanks to the [ betamax] ( https://github.com/sigmavirus24/betamax ) framework
215
227
being in use in the test suites.
216
228
217
- When running existing tests, based on the provided cassettes, you don't need any
229
+ When running existing tests, based on the provided cassettes, you don't need any
218
230
setting. Also, if you've got a configuration in ` ~/.gitconfig ` , the tests will use
219
231
them. Anyway, you can use environment variables for those settings (environment
220
232
variables will have precedence over the configuration settings):
221
233
222
234
To use your own credentials, you can setup the following environment variables:
223
235
224
- * ` GITHUB_NAMESPACE ` (which defaults to ` not_configured ` ) is the name of the account to use on github
225
- * ` GITLAB_NAMESPACE ` (which defaults to ` not_configured ` ) is the name of the account to use on gitlab
226
- * ` BITBUCKET_NAMESPACE ` (which defaults to ` not_configured ` ) is the name of the account to use on bitbucket
227
- * ` PRIVATE_KEY_GITHUB ` your private token you've setup on github for your account
228
- * ` PRIVATE_KEY_GITLAB ` your private token you've setup on gitlab for your account
229
- * ` PRIVATE_KEY_BITBUCKET ` your private token you've setup on bitbucket for your account
236
+ * ` GITHUB_NAMESPACE ` (which defaults to ` not_configured ` ) is the name of the account to use on GitHub
237
+ * ` GITLAB_NAMESPACE ` (which defaults to ` not_configured ` ) is the name of the account to use on GitLab
238
+ * ` BITBUCKET_NAMESPACE ` (which defaults to ` not_configured ` ) is the name of the account to use on Bitbucket
239
+ * ` PRIVATE_KEY_GITHUB ` your private token you've setup on GitHub for your account
240
+ * ` PRIVATE_KEY_GITLAB ` your private token you've setup on GitLab for your account
241
+ * ` PRIVATE_KEY_BITBUCKET ` your private token you've setup on Bitbucket for your account
230
242
231
243
### TODO
232
244
@@ -254,9 +266,20 @@ To use your own credentials, you can setup the following environment variables:
254
266
* [ ] do what's needed to make a nice documentation — if possible in markdown !@#$
255
267
* for more features, write an issue or, even better, a PR!
256
268
269
+ # Contributors
270
+
271
+ The project and original idea has been brought and is maintained by:
272
+
273
+ * Bernard [ @guyzmo ] ( https://github.com/guyzmo ) Pratz [ commits] ( https://github.com/guyzmo/git-repo/commits?author=guyzmo )
274
+
275
+ With code contributions coming from:
276
+
277
+ * [ @guyhughes ] ( https://github.com/guyhughes ) [ commits] ( https://github.com/guyzmo/git-repo/commits?author=guyhughes )
278
+ * [ @buaazp ] ( https://github.com/buaazp ) [ commits] ( https://github.com/guyzmo/git-repo/commits?author=buaazp )
279
+
257
280
### License
258
281
259
- Copyright ⓒ Bernard `Guyzmo` Pratz <[email protected] >
282
+ Copyright ©
260
283
261
284
This program is free software; you can redistribute it and/or
262
285
modify it under the terms of the GNU General Public License
0 commit comments