File: installation.rst

package info (click to toggle)
bpack 1.3.0-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 644 kB
  • sloc: python: 6,088; makefile: 75
file content (50 lines) | stat: -rw-r--r-- 844 bytes parent folder | download | duplicates (2)
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
Installation
============

Pip
---

Basic installation:

.. code-block:: shell

  $ python3 -m pip install bpack

Recommended:

.. code-block:: shell

  $ python3 -m pip install bpack[bs,np]

to install also dependencies necessary to use the :mod:`bpack.bs` backend
and (for binary structures defined up to the bit level).


Conda
-----

.. code-block:: shell

  $ conda install -c conda-forge -c avalentino bpack


Testing
-------

To run the test suite it is necessary to have pytest_ installed:

.. code-block:: shell

  $ python3 -m pytest --pyargs bpack

This only tests codec backends for which the necessary dependencies
are available.
To run a complete test please make sure to install all optional dependencies
and testing libraries:

.. code-block:: shell

  $ python3 -m pip install bpack[test]


.. _pytest: https://docs.pytest.org