File: installing.rst

package info (click to toggle)
python-mido 1.3.3-0.2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 920 kB
  • sloc: python: 4,006; makefile: 127; sh: 4
file content (57 lines) | stat: -rw-r--r-- 1,401 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
51
52
53
54
55
56
57
.. SPDX-FileCopyrightText: 2013 Ole Martin Bjorndalen <ombdalen@gmail.com>
.. SPDX-FileCopyrightText: 2023 Raphaƫl Doursenaud <rdoursenaud@gmail.com>
..
.. SPDX-License-Identifier: CC-BY-4.0

Installing
==========


Requirements
------------

Mido requires :term:`Python` version 3.7 or higher.

A few dependencies are also required in order to allow Mido to introspect its
own version:

* `packaging`
* `importlib_metadata` for :term:`Python` < 3.8

.. note::

    Dependency management is handled automatically when installing using the
    recommended methods. No need to bother installing these manually.


Optional
--------

Dependencies for the loaded on-demand :term:`port` :term:`backend(s)` are
optional unless you want to use the :term:`ports` feature.

See :doc:`backends/index` for help choosing a :term:`backend`.


Installation
------------

The recommended installation method is to use :term:`pip` to retrieve the
package from :term:`PyPi`.

.. note::

    Consider using a *virtual environment* to isolate your installation from
    your current environment.

This ensures that you always get the latest released stable version::

    python3 -m pip install mido

Or, alternatively, if you want to use :term:`ports` with the default
:term:`backend`::

    python3 -m pip install mido[ports-rtmidi]

See :doc:`backends/index` for installation instructions for other
:term:`backends`.