File: install.rst

package info (click to toggle)
python-agate 1.6.3-2
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 1,976 kB
  • sloc: python: 9,093; makefile: 126
file content (56 lines) | stat: -rw-r--r-- 1,302 bytes parent folder | download
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
============
Installation
============

Users
-----

To use agate install it with pip::

    pip install agate

For non-English locale support, `install PyICU <https://gitlab.pyicu.org/main/pyicu#installing-pyicu>`__.

.. note::

    Need more speed? Upgrade to Python 3. It's 3-5x faster than Python 2.

    If you must use Python 2 you can you can :code:`pip install cdecimal` for a performance boost.

Developers
----------

If you are a developer that also wants to hack on agate, install it from git::

    git clone git://github.com/wireservice/agate.git
    cd agate
    mkvirtualenv agate

    # If running Python 3 (strongly recommended for development)
    pip install -r requirements-py3.txt

    # If running Python 2
    pip install -r requirements-py2.txt

    python setup.py develop

.. note::

    To run the agate tests with coverage::

        nosetests --with-coverage tests

Supported platforms
-------------------

agate supports the following versions of Python:

* Python 2.7
* Python 3.5+
* `PyPy <http://pypy.org/>`_ versions >= 4.0.0

It is tested primarily on OSX, but due to its minimal dependencies it should work perfectly on both Linux and Windows.

.. note::

    `iPython <http://ipython.org/>`_ or `Jupyter <https://jupyter.org/>`_ user? Agate works great there too.