The commands here will install aiocoap in your current environment. By default, that is your platform’s user install directory.
To keep that clean, or to use different sets or versions of libraries for different purposes, you may want to look into the venv documentation, which explains both the concept of virtual environments and how they are used on different platforms.
In most situations, it is recommended to install the latest released version of aiocoap. This is done using a simple:
$ pip3 install --upgrade "aiocoap[all]"
(In some cases, the program is called
pip3 is not available on your platform, you can manually download and
unpack the latest
.tar.gz file from the Python package index and run
$ ./setup.py install
If you want to play with aiocoap’s internals or consider contributing to the project, the suggested way of operation is getting a Git checkout of the project:
$ git clone https://github.com/chrysn/aiocoap $ cd aiocoap
You can then use the project from that location, or install it with
$ pip3 install --upgrade ".[all,docs]"
If you need to install the latest development version of aiocoap but do not plan on editing (eg. because you were asked in the course of a bug report to test something against the latest aiocoap version), you can install it directly from the web:
$ pip3 install --upgrade "git+https://github.com/chrysn/aiocoap#egg=aiocoap[all]"
-e option, that is also a viable option if you want to modify
aiocoap and pip’s choice of checkout directories is suitable for you.
When upstream libraries change, or when dependencies of used libraries are not there (eg. no C compiler, C libraries missing), the installation process can fail.
On Debian based systems, it helps to install the packages
autoconf; generally, the error output will contain
some hints as to what is missing.
As a workaround, it can be helpful to not install with all extras, but replace the
all with the extras you actually want from the list below. For example, if
you see errors from DTLSSocket, rather than installing with
can leave out the
tinydtls extra and install with
As aiocoap does not strictly depend on many of the libraries that are installed
when following the above recommendations, a setup can be stripped down by
entering any combination of the below “extras” in the place of the
the above lines, or leaving out the
[all] expression for a minimal
The extras currently supported are:
linkheader: Needed for generating and parsing files in RFC6690 link format, eg.
.well-known/corefiles. Running or interacting with a Resource Directory is impossible without this module, as are many other discovery steps that applications will want to do.
oscore: Required for the
tinydtls: Required for using CoAP over DTLS.
ws: Required for using CoAP over WebSockets.
prettyprint: Allows using the
--pretty-printoptions of aiocoap-client.
docs: Installs tools needed to build the documentation (not part of
Which libraries and versions are pulled in by this exactly is documented in the