| 1 | pkgcore-0.4.* < http://www.pkgcore.org > |
|---|
| 2 | |
|---|
| 3 | |
|---|
| 4 | WHAT IS PKGCORE? |
|---|
| 5 | |
|---|
| 6 | pkgcore is a framework for package management; via the appropriate class plugins, |
|---|
| 7 | the design should allow for any underlying repository/config/format to be used; |
|---|
| 8 | slackwares tgzs being exempted due to lack of any real metadata, and |
|---|
| 9 | autopackage format being exempted due to the fact they effectively embed the |
|---|
| 10 | manager in each package (pkgcore *does* require being able to treat the pkg as |
|---|
| 11 | data, instead of autopackages method of handing resolution/all manager ops off |
|---|
| 12 | to the package script). |
|---|
| 13 | |
|---|
| 14 | |
|---|
| 15 | WHAT DOES PKGCORE REQUIRE? |
|---|
| 16 | |
|---|
| 17 | At least python verison 2.4, and snakeoil- snakeoil is a utility library with |
|---|
| 18 | misc optimizations split out of pkgcore for others to use. Available via |
|---|
| 19 | http://pkgcore.org/trac/wiki/Releases . |
|---|
| 20 | |
|---|
| 21 | |
|---|
| 22 | WHO TO CONTACT IF I FIND A BUG? |
|---|
| 23 | |
|---|
| 24 | Please submit a bug/ticket via http://www.pkgcore.org. Barring that, please at |
|---|
| 25 | least send the details to pkgcore-bugs@pkgcore.org. Please do not use |
|---|
| 26 | bugs.gentoo.org as the first step; any bugs, pkgcore devs should filter before |
|---|
| 27 | passing up at this point. |
|---|
| 28 | |
|---|
| 29 | You can also stop by at #pkgcore on irc.freenode.net. |
|---|
| 30 | |
|---|
| 31 | |
|---|
| 32 | DOCUMENTATION? |
|---|
| 33 | |
|---|
| 34 | Please take a look at either doc/ and dev-notes/ ; additionally, the code for |
|---|
| 35 | the most part has docstrings, thus pydoc is a good reference. |
|---|
| 36 | |
|---|
| 37 | doc/getting-started.rst is a good introduction if you're just getting started. |
|---|
| 38 | If you want to start hacking, take a look at dev-notes/developing.rst. |
|---|
| 39 | |
|---|
| 40 | In addition, html documentation is available at |
|---|
| 41 | http://api.pkgcore.org/pkgcore/ , as is postscript and pdf. |
|---|
| 42 | |
|---|
| 43 | |
|---|
| 44 | TOOLS? |
|---|
| 45 | |
|---|
| 46 | pclone_cache: clone a repository cache |
|---|
| 47 | |
|---|
| 48 | pebuild: low-level ebuild operations, go through phases manually |
|---|
| 49 | |
|---|
| 50 | pmaint: generic utility for repository maintenance (syncing, copying...) |
|---|
| 51 | |
|---|
| 52 | pmerge: generic utility for doing resolution, fetching, merging/unmerging, |
|---|
| 53 | etc. |
|---|
| 54 | |
|---|
| 55 | pquery: generic utility for querying info about repositories, revdeps, pkg |
|---|
| 56 | search, vdb search, etc. |
|---|
| 57 | |
|---|
| 58 | pregen: script for doing ebuild metadata regeneration; can be parallelized |
|---|
| 59 | |
|---|
| 60 | TESTS? |
|---|
| 61 | |
|---|
| 62 | A standalone test runner is integrated in setup.py; to run, just execute |
|---|
| 63 | setup.py test |
|---|
| 64 | Aside from that, our runner of choice is twisted's trial; ran via- |
|---|
| 65 | |
|---|
| 66 | trial pkgcore |
|---|
| 67 | |
|---|
| 68 | If you're doing development, trial is significantly friendlier; the standalone |
|---|
| 69 | runner is designed to be mainly used for installations of pkgcore, where |
|---|
| 70 | all tests must pass, else installation is aborted. |
|---|
| 71 | |
|---|
| 72 | |
|---|
| 73 | INSTALLING: |
|---|
| 74 | |
|---|
| 75 | To build: |
|---|
| 76 | |
|---|
| 77 | tar jxf pkgcore-0.XX.tar.bz2 |
|---|
| 78 | cd pkgcore-0.XX |
|---|
| 79 | python setup.py build |
|---|
| 80 | |
|---|
| 81 | Run tests: |
|---|
| 82 | |
|---|
| 83 | cd pkgcore-0.xx |
|---|
| 84 | python setup.py test |
|---|
| 85 | or |
|---|
| 86 | trial pkgcore |
|---|
| 87 | |
|---|
| 88 | To install: |
|---|
| 89 | |
|---|
| 90 | cd pkgcore-0.xx |
|---|
| 91 | python setup.py install |
|---|
| 92 | pplugincache |
|---|
