aboutsummaryrefslogtreecommitdiff
blob: 10869090f1a56925dd319124d67d0027680dbdd1 (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
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
|pypi| |test| |coverage| |docs|

========
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.


Contact
=======

Please create an issue in the `issue tracker`_.


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


.. _`issue tracker`: https://github.com/pkgcore/snakeoil/issues

.. |pypi| image:: https://img.shields.io/pypi/v/snakeoil.svg
    :target: https://pypi.python.org/pypi/snakeoil

.. |test| image:: https://travis-ci.org/pkgcore/snakeoil.svg?branch=master
    :target: https://travis-ci.org/pkgcore/snakeoil

.. |coverage| image:: https://coveralls.io/repos/pkgcore/snakeoil/badge.png?branch=master
    :target: https://coveralls.io/r/pkgcore/snakeoil?branch=master

.. |docs| image:: https://readthedocs.org/projects/snakeoil/badge/?version=latest
    :target: https://readthedocs.org/projects/snakeoil/?badge=latest
    :alt: Documentation Status