blob: c158d00147a84c1a3618a88a5fc232baa2dadf98 (
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
|
|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.
Installing
==========
Installing latest pypi release in a virtualenv::
pip install snakeoil
Installing from git in a virtualenv::
pip install https://github.com/pkgcore/snakeoil/archive/master.tar.gz
Installing from a tarball or git repo::
python setup.py install
Tests
=====
A standalone test runner is integrated in setup.py; to run, just execute::
python setup.py test
In addition, a tox config is provided so the testsuite can be run in a
virtualenv setup against all supported python versions. To run tests for all
environments just execute **tox** in the root directory of a repo or unpacked
tarball. Otherwise, for a specific python version execute something similar to
the following::
tox -e py27
Note that mock_ is required for tests if you're using python-2.7.
Contact
=======
For support and development inquiries join `#pkgcore`_ on Freenode.
For bugs and feature requests please create an issue on Github_.
.. _#pkgcore: https://webchat.freenode.net?channels=%23pkgcore&uio=d4
.. _Github: https://github.com/pkgcore/snakeoil/issues
.. _mock: https://pypi.python.org/pypi/mock
.. |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: http://snakeoil.readthedocs.org/
:alt: Documentation Status
|