Permalink
Browse files

documentation cleanup and update

  • Loading branch information...
02strich committed Mar 26, 2012
1 parent dbe498f commit 9dc3e6d9df7a76e0707e3f457b86e8f32b201e24
Showing with 19 additions and 43 deletions.
  1. +0 −13 INSTALL
  2. +13 −0 INSTALL.rst
  3. +6 −9 README.rst
  4. +0 −21 docs/index.txt
View
13 INSTALL
@@ -1,13 +0,0 @@
-=======
-Install
-=======
-
-From the command line run ::
-
- python setup.py install
-
-or ::
-
- easy_install pyrpm
-
-You will need administration priveliges to run this commands.
View
@@ -0,0 +1,13 @@
+=======
+Install
+=======
+
+From the command line run ::
+
+ python setup.py install
+
+or ::
+
+ easy_install pyrpm-02strich
+
+You will need administration privileges to run this commands.
View
@@ -2,25 +2,22 @@
PyRPM
=====
-:author: Mário Morgado
+:authors: Stefan Richter, Mário Morgado
:license: BSD
-PyRPM is a pure python module to extract information from a RPM package.
+PyRPM is a pure python module to extract information from a RPM package and to create YUM metadata. Supports generation/editing YUM repositories.
Usage
-----
>>> from pyrpm.rpm import RPM
- >>> frpm pyrpm import rpmdefs
>>> rpm = RPM(file('package-1.0-r1.i586.rpm')
>>> rpm.binary # this means that the package is a rpm and not a src.rpm
True
- >>> rpm.name()
+ >>> rpm.header.name
'package'
- >>> rpm.package()
- 'package-1.0'
- >>> rpm[rpmdefs.RPMTAG_DESCRIPTION]
- 'package description'
- >>> rpm[rpmdefs.RPMTAG_ARCH]
+ >>> rpm.header.architecture
'i586'
+ >>> rpm.header.description
+ 'package description'
View
@@ -1,21 +0,0 @@
-=====
-PyRPM
-=====
-
-:Author: Mario Morgado
-
-.. .. contents::
-
-Introduction
-============
-
-PyRPM is a pure python, simple to use, module to read information from a RPM file.::
-
- >>> from pyrpm.rpm import RPM
- >>> rpm = RPM(file('pyrpm-0.2-noarch.rpm'))
- >>> rpm.filename()
- 'pyrpm-0.2-noarch.rpm'
- >>> rpm.name()
- 'pyrpm'
-
-

0 comments on commit 9dc3e6d

Please sign in to comment.