aboutsummaryrefslogtreecommitdiff
path: root/README
blob: e15c7e92cc47fe922a71ffb207d8333f518153a5 (plain)
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
WHAT IS SNAKEOIL?

  snakeoil is a python library that implements optimized versions of common
  python functionality. Some classes and functions have cpython equivalents,
  but they all have native python implementations too.


WHO TO CONTACT IF I FIND A BUG?

  Please submit a bug/ticket via https://github.com/pkgcore/snakeoil/issues .


TESTS?

  A standalone test runner is integrated in setup.py; to run, just execute
  setup.py test
  Aside from that, our runner of choice is twisteds trial; ran via-

  trial snakeoil

  if you're doing development, trial is significantly friendlier; the
  standalone runner is designed to be used mainly for installations of
  snakeoil, where all tests must pass, else installation is aborted.


INSTALLING:

  pretty simple-

    tar jxf snakeoil-0.XX.tar.bz2
    cd snakeoil-0.XX
    python setup.py build

  if after running tests,

    cd snakeoil-0.xx
    python setup.py test

  finally, installing-

    cd snakeoil-0.xx
    python setup.py install