docs: add supported python versions

[AbdallahAlhaddad]

I was using python 3.9 in my project and was not able to install peerjs because python 3.9 is not supported for this package yet.
I think it would be useful if you add the supported python version in the readme file.
thank you for your time and effort on maintaining this project.

[commit-lint]

Contributors

AbdallahAlhaddad

Commit-Lint commands

You can trigger Commit-Lint actions by commenting on this PR:

• @Commit-Lint merge patch will merge dependabot PR on "patch" versions (X.X.Y - Y change)
• @Commit-Lint merge minor will merge dependabot PR on "minor" versions (X.Y.Y - Y change)
• @Commit-Lint merge major will merge dependabot PR on "major" versions (Y.Y.Y - Y change)
• @Commit-Lint merge disable will desactivate merge dependabot PR
• @Commit-Lint review will approve dependabot PR
• @Commit-Lint stop review will stop approve dependabot PR

[ivelin]

Hi @AbdallahAlhaddad. Can you please share the error you see. I am not sure why Python 3.9 does not work with this package. If it's something trivial, maybe we can fix it quickly.

[AbdallahAlhaddad]

Hi @ivelin
The error is showing when executing the command pip install peerjs while using python3.9.1

• The output right after pip downloaded the required packages:

Building wheels for collected packages: av, netifaces
  Building wheel for av (setup.py) ... error
  ERROR: Command errored out with exit status 1:
   command: /home/anonymous/.local/share/virtualenvs/test-_w38rAJq/bin/python -u -c 'import sys, setuptools, tokenize; sys.argv[0] = '"'"'/tmp/pip-install-thl8x_i5/av_d44f710076dd48dbb56f8bf9750ef253/setup.py'"'"'; __file__='"'"'/tmp/pip-install-thl8x_i5/av_d44f710076dd48dbb56f8bf9750ef253/setup.py'"'"';f=getattr(tokenize, '"'"'open'"'"', open)(__file__);code=f.read().replace('"'"'\r\n'"'"', '"'"'\n'"'"');f.close();exec(compile(code, __file__, '"'"'exec'"'"'))' bdist_wheel -d /tmp/pip-wheel-bbp39ko3
       cwd: /tmp/pip-install-thl8x_i5/av_d44f710076dd48dbb56f8bf9750ef253/
  Complete output (54 lines):
  running bdist_wheel
  running build
  running build_py
  creating build
  creating build/lib.linux-x86_64-3.9
  creating build/lib.linux-x86_64-3.9/av
  copying av/datasets.py -> build/lib.linux-x86_64-3.9/av
  copying av/deprecation.py -> build/lib.linux-x86_64-3.9/av
  copying av/__main__.py -> build/lib.linux-x86_64-3.9/av
  copying av/__init__.py -> build/lib.linux-x86_64-3.9/av
  creating build/lib.linux-x86_64-3.9/av/codec
  copying av/codec/__init__.py -> build/lib.linux-x86_64-3.9/av/codec
  creating build/lib.linux-x86_64-3.9/av/data
  copying av/data/__init__.py -> build/lib.linux-x86_64-3.9/av/data
  creating build/lib.linux-x86_64-3.9/av/audio
  copying av/audio/__init__.py -> build/lib.linux-x86_64-3.9/av/audio
  creating build/lib.linux-x86_64-3.9/av/filter
  copying av/filter/__init__.py -> build/lib.linux-x86_64-3.9/av/filter
  creating build/lib.linux-x86_64-3.9/av/container
  copying av/container/__init__.py -> build/lib.linux-x86_64-3.9/av/container
  creating build/lib.linux-x86_64-3.9/av/sidedata
  copying av/sidedata/__init__.py -> build/lib.linux-x86_64-3.9/av/sidedata
  creating build/lib.linux-x86_64-3.9/av/video
  copying av/video/__init__.py -> build/lib.linux-x86_64-3.9/av/video
  creating build/lib.linux-x86_64-3.9/av/subtitles
  copying av/subtitles/__init__.py -> build/lib.linux-x86_64-3.9/av/subtitles
  warning: build_py: byte-compiling is disabled, skipping.
  
  running build_ext
  running config
  PyAV: 8.0.2 (unknown commit)
  Python: 3.9.1 (default, Dec  8 2020, 02:26:20) \n[GCC 9.3.0]
  platform: Linux-5.8.0-7630-generic-x86_64-with-glibc2.31
  extension_extra:
        include_dirs: [b'include', b'/usr/include/x86_64-linux-gnu']
        libraries: [b'avformat', b'avcodec', b'avdevice', b'avutil', b'avfilter', b'swscale', b'swresample']
        library_dirs: []
        define_macros: []
        runtime_library_dirs: []
  config_macros:
        PYAV_COMMIT_STR="unknown-commit"
        PYAV_VERSION=8.0.2
        PYAV_VERSION_STR="8.0.2"
  writing build/temp.linux-x86_64-3.9/include/pyav/config.h
  running cythonize
  building 'av.descriptor' extension
  creating build/temp.linux-x86_64-3.9/src
  creating build/temp.linux-x86_64-3.9/src/av
  x86_64-linux-gnu-gcc -pthread -Wno-unused-result -Wsign-compare -DNDEBUG -g -fwrapv -O2 -Wall -g -fstack-protector-strong -Wformat -Werror=format-security -g -fstack-protector-strong -Wformat -Werror=format-security -Wdate-time -D_FORTIFY_SOURCE=2 -fPIC -I/home/anonymous/.local/share/virtualenvs/test-_w38rAJq/include -I/usr/include/python3.9 -Iinclude -I/usr/include/x86_64-linux-gnu -Ibuild/temp.linux-x86_64-3.9/include -I/home/anonymous/.local/share/virtualenvs/test-_w38rAJq/include -I/usr/include/python3.9 -Ibuild/temp.linux-x86_64-3.9/include -c src/av/descriptor.c -o build/temp.linux-x86_64-3.9/src/av/descriptor.o
  src/av/descriptor.c:61:10: fatal error: Python.h: No such file or directory
     61 | #include "Python.h"
        |          ^~~~~~~~~~
  compilation terminated.
  error: command '/usr/bin/x86_64-linux-gnu-gcc' failed with exit code 1
  ----------------------------------------
  ERROR: Failed building wheel for av
  Running setup.py clean for av
  Building wheel for netifaces (setup.py) ... error
  ERROR: Command errored out with exit status 1:
   command: /home/anonymous/.local/share/virtualenvs/test-_w38rAJq/bin/python -u -c 'import sys, setuptools, tokenize; sys.argv[0] = '"'"'/tmp/pip-install-thl8x_i5/netifaces_ca573ef64c124478ae1f6f0406ac3152/setup.py'"'"'; __file__='"'"'/tmp/pip-install-thl8x_i5/netifaces_ca573ef64c124478ae1f6f0406ac3152/setup.py'"'"';f=getattr(tokenize, '"'"'open'"'"', open)(__file__);code=f.read().replace('"'"'\r\n'"'"', '"'"'\n'"'"');f.close();exec(compile(code, __file__, '"'"'exec'"'"'))' bdist_wheel -d /tmp/pip-wheel-qzel1poy
       cwd: /tmp/pip-install-thl8x_i5/netifaces_ca573ef64c124478ae1f6f0406ac3152/
  Complete output (20 lines):
  running bdist_wheel
  running build
  running build_ext
  checking for getifaddrs...found.
  checking for getnameinfo...found.
  checking for IPv6 socket IOCTLs...not found.
  checking for optional header files...netash/ash.h netatalk/at.h netax25/ax25.h neteconet/ec.h netipx/ipx.h netpacket/packet.h netrose/rose.h linux/atm.h linux/llc.h linux/tipc.h linux/dn.h.

[ivelin]

This looks like a combination of issues between the virtual environment running python and the av library trying to compile from source, which is weird since av is available as a binary for most linux distros. Needs further investigation.

av
  x86_64-linux-gnu-gcc -pthread -Wno-unused-result -Wsign-compare -DNDEBUG -g -fwrapv -O2 -Wall -g -fstack-protector-strong -Wformat -Werror=format-security -g -fstack-protector-strong -Wformat -Werror=format-security -Wdate-time -D_FORTIFY_SOURCE=2 -fPIC -I/home/anonymous/.local/share/virtualenvs/test-_w38rAJq/include -I/usr/include/python3.9 -Iinclude -I/usr/include/x86_64-linux-gnu -Ibuild/temp.linux-x86_64-3.9/include -I/home/anonymous/.local/share/virtualenvs/test-_w38rAJq/include -I/usr/include/python3.9 -Ibuild/temp.linux-x86_64-3.9/include -c src/av/descriptor.c -o build/temp.linux-x86_64-3.9/src/av/descriptor.o
  src/av/descriptor.c:61:10: fatal error: Python.h: No such file or directory
     61 | #include "Python.h"

[ivelin]

@AbdallahAlhaddad just fyi, your observations are reproducible in CI. Issue pending.

[ivelin]

🎉 This PR is included in version 1.4.2 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀