github.com_openSUSE_osc/README

osc -- opensuse-commander with svn like handling


Please send patches to poeml@suse.de, or work directly on
https://forgesvn1.novell.com/svn/opensuse/trunk/buildservice/src/clientlib/python/osc/


INSTALLATION:

RPM packages are here (yum repository):
http://software.opensuse.org/download/repositories/openSUSE:Tools/

To install from svn, do
	python setup.py build
	python setup.py install
	# create a symlink 'osc' in your path pointing to osc.py.
	ln -s osc-wrapper.py /usr/bin/osc

Alternatively, you can directly use osc-wrapper.py from the source dir


The program needs the following python packages installed (that's their names
on SUSE anyway): 
	pyxml 
	python-elementtree


CONFIGURATION:

When you use it for the first time, it will ask you for your username and
password, and store it in ~/.oscrc.

If authentication data is found in .netrc, it will also be used.


USAGE EXAMPLES:

To list existing content on the server
 osc ls 				# list projects
 osc ls Apache 			# list packages in a project 
 osc ls Apache subversion 	# list files of package of a project

Check out content
 osc co Apache 			# entire project
 osc co Apache subversion	# a package
 osc co Apache subversion foo	# single file

Update a working copy
 osc up
 osc up [pac_dir]		# update a single package by its path
 osc up * 			# from within a project dir, update all packages
 osc up  			# from within a project dir, update all packages
				   AND check out all newly added packages

If an update can't be merged automatically, a file is in 'C' (conflict)
state, and conflicts are marked with special <<<<<<< and >>>>>>> lines. 
After manually resolving the problem, use
 osc resolved foo

Upload change content
 osc ci				# current dir
 osc ci <dir>
 osc ci file1 file2 ...

Show the status (which files have been changed locally)
 osc st
 osc st <directory>
 osc st file1 file2 ...

Mark files to be added or removed on the next 'checkin'
 osc add file1 file2 ...
 osc rm file1 file2 ...

Adds all new files in local copy and removes all disappeared files.
 osc addremove

Generates a diff, to view the changes
 osc diff 			# current dir
 osc diff file1 file2 ...

Shows the build results of the package
 osc results
 osc results [platform]

Shows the log file from a package (you need to be inside a package directory)
 osc log <platform> <arch>

Shows available platforms/build targets
 osc platforms

Shows the configured platforms/build targets of a project
 osc platforms <project>

Shows meta information
 osc meta Apache
 osc meta Apache subversion
 osc id username

Edit meta information
(Creates new package/project if it doesn't exist)
 osc editmeta Apache
 osc editmeta Apache subversion


HINT FOR W3M USERS

Putting the following in the file ~/.w3m/passwd will make
w3m know the credentials for the buildservice servers:

"""
host api.opensuse.org
  port 80
  realm Authentication required
  login foo
  password bar

host build.opensuse.org
  port 80
  realm openSUSE Build Service
  login foo
  password bar
"""

chmod 0600 ~/.w3m/passwd
add opensuse-commander, a python library / commandline tool 2006-04-20 16:26:50 +02:00			`osc -- opensuse-commander with svn like handling`


upate osc README 2006-04-20 16:31:24 +02:00			`Please send patches to poeml@suse.de, or work directly on`
			`https://forgesvn1.novell.com/svn/opensuse/trunk/buildservice/src/clientlib/python/osc/`
add opensuse-commander, a python library / commandline tool 2006-04-20 16:26:50 +02:00

upate osc README 2006-04-20 16:31:24 +02:00			`INSTALLATION:`
update INSTALL section 2006-05-10 16:47:27 +02:00
0.3 status: - use new file metadata which provides checksum, size and mtime - don't list unmodified files - fix some conditions where status was too stupid so far update: - much faster now, since only new or changed files are downloaded - print revision number checkout: - mark project directory as such (to be used later) diff: - faster, since 'status' is faster - work against local copy checkin: - update package metadata from specfile - fix argument handling add: - ignore .osc and other files other changes: - sanitize argument handling, so most commands can work with arbitrary files/directories as arguments (work is always done per package) - add history command (doesn't seem to be working yet) - on first usage, ask for username password on first usage, and store them in .oscrc (.netrc can still be used) 2006-05-19 22:13:29 +02:00			`RPM packages are here (yum repository):`
use redirector url 2006-05-21 13:00:42 +02:00			`http://software.opensuse.org/download/repositories/openSUSE:Tools/`
0.3 status: - use new file metadata which provides checksum, size and mtime - don't list unmodified files - fix some conditions where status was too stupid so far update: - much faster now, since only new or changed files are downloaded - print revision number checkout: - mark project directory as such (to be used later) diff: - faster, since 'status' is faster - work against local copy checkin: - update package metadata from specfile - fix argument handling add: - ignore .osc and other files other changes: - sanitize argument handling, so most commands can work with arbitrary files/directories as arguments (work is always done per package) - add history command (doesn't seem to be working yet) - on first usage, ask for username password on first usage, and store them in .oscrc (.netrc can still be used) 2006-05-19 22:13:29 +02:00
			`To install from svn, do`
update INSTALL section 2006-05-10 16:47:27 +02:00			`python setup.py build`
			`python setup.py install`
			`# create a symlink 'osc' in your path pointing to osc.py.`
			`ln -s osc-wrapper.py /usr/bin/osc`

			`Alternatively, you can directly use osc-wrapper.py from the source dir`


			`The program needs the following python packages installed (that's their names`
			`on SUSE anyway):`
			`pyxml`
			`python-elementtree`




			`CONFIGURATION:`
add opensuse-commander, a python library / commandline tool 2006-04-20 16:26:50 +02:00
update README 2006-05-23 11:30:30 +02:00			`When you use it for the first time, it will ask you for your username and`
			`password, and store it in ~/.oscrc.`

			`If authentication data is found in .netrc, it will also be used.`
add opensuse-commander, a python library / commandline tool 2006-04-20 16:26:50 +02:00


upate osc README 2006-04-20 16:31:24 +02:00			`USAGE EXAMPLES:`
add opensuse-commander, a python library / commandline tool 2006-04-20 16:26:50 +02:00
update README 2006-05-23 11:30:30 +02:00			`To list existing content on the server`
			`osc ls # list projects`
			`osc ls Apache # list packages in a project`
			`osc ls Apache subversion # list files of package of a project`

			`Check out content`
			`osc co Apache # entire project`
			`osc co Apache subversion # a package`
			`osc co Apache subversion foo # single file`

			`Update a working copy`
			`osc up`
			`osc up [pac_dir] # update a single package by its path`
			`osc up * # from within a project dir, update all packages`
			`osc up # from within a project dir, update all packages`
			`AND check out all newly added packages`

			`If an update can't be merged automatically, a file is in 'C' (conflict)`
			`state, and conflicts are marked with special <<<<<<< and >>>>>>> lines.`
			`After manually resolving the problem, use`
			`osc resolved foo`

- add 'help' subcommand (and add help :-) - make all subcommands functions -- so they can be used from outside (they still print directly their output; they could become iterators later) - deprecate 'init' subcommand - 0.5 2006-05-23 15:48:58 +02:00			`Upload change content`
update README 2006-05-23 11:30:30 +02:00			`osc ci # current dir`
			`osc ci <dir>`
			`osc ci file1 file2 ...`

			`Show the status (which files have been changed locally)`
			`osc st`
			`osc st <directory>`
			`osc st file1 file2 ...`

			`Mark files to be added or removed on the next 'checkin'`
			`osc add file1 file2 ...`
			`osc rm file1 file2 ...`

			`Adds all new files in local copy and removes all disappeared files.`
			`osc addremove`

			`Generates a diff, to view the changes`
			`osc diff # current dir`
			`osc diff file1 file2 ...`

			`Shows the build results of the package`
			`osc results`
			`osc results [platform]`

			`Shows the log file from a package (you need to be inside a package directory)`
			`osc log <platform> <arch>`

			`Shows available platforms/build targets`
			`osc platforms`

			`Shows the configured platforms/build targets of a project`
			`osc platforms <project>`

			`Shows meta information`
			`osc meta Apache`
			`osc meta Apache subversion`
			`osc id username`
add opensuse-commander, a python library / commandline tool 2006-04-20 16:26:50 +02:00
update README 2006-05-23 17:32:55 +02:00			`Edit meta information`
			`(Creates new package/project if it doesn't exist)`
			`osc editmeta Apache`
			`osc editmeta Apache subversion`
0.3 status: - use new file metadata which provides checksum, size and mtime - don't list unmodified files - fix some conditions where status was too stupid so far update: - much faster now, since only new or changed files are downloaded - print revision number checkout: - mark project directory as such (to be used later) diff: - faster, since 'status' is faster - work against local copy checkin: - update package metadata from specfile - fix argument handling add: - ignore .osc and other files other changes: - sanitize argument handling, so most commands can work with arbitrary files/directories as arguments (work is always done per package) - add history command (doesn't seem to be working yet) - on first usage, ask for username password on first usage, and store them in .oscrc (.netrc can still be used) 2006-05-19 22:13:29 +02:00


			`HINT FOR W3M USERS`

			`Putting the following in the file ~/.w3m/passwd will make`
			`w3m know the credentials for the buildservice servers:`

			`"""`
			`host api.opensuse.org`
			`port 80`
			`realm Authentication required`
			`login foo`
			`password bar`

			`host build.opensuse.org`
			`port 80`
			`realm openSUSE Build Service`
			`login foo`
			`password bar`
			`"""`

			`chmod 0600 ~/.w3m/passwd`