8000 update README to reflect recent changes · arthurbarros/opencv-python@7b547cb · GitHub
[go: up one dir, main page]
Skip to content

Commit 7b547cb

Browse files
skvarkskvark
committed
update README to reflect recent changes
1 parent b92dd27 commit 7b547cb

File tree

1 file changed

+37
-40
lines changed
  • README.rst

    • 1 file changed

    +37
    -40
    lines changed

    ‎README.rst

    Lines changed: 37 additions & 40 deletions
    Original file line numberDiff line numberDiff line change
    @@ -1,23 +1,15 @@
    1-
    .. image:: https://img.shields.io/appveyor/ci/skvark/opencv-python.svg?maxAge=3600&label=Windows
    1+
    .. image:: https://img.shields.io/appveyor/ci/skvark/opencv-python.svg?maxAge=3600&label=Windows
    22
    :target: https://ci.appveyor.com/project/skvark/opencv-python
    33
    :alt: AppVeyor CI test status (Windows)
    44

    5-
    .. image:: https://img.shields.io/travis/skvark/opencv-python.svg?maxAge=3600&label="Linux / OS X"
    5+
    .. image:: https://img.shields.io/travis/skvark/opencv-python.svg?maxAge=3600&label="Linux / OS X"
    66
    :target: https://travis-ci.org/skvark/opencv-python
    77
    :alt: Travis CI test status (Linux and OS X)
    88

    99
    OpenCV on wheels
    1010
    ================
    1111

    12-
    Unofficial OpenCV packages for Python.
    13-
    14-
    The aim of this repository is to provide means to package each new
    15-
    `OpenCV release <https://github.com/opencv/opencv/releases>`__ for the
    16-
    most used Python versions and platforms.
    17-
    18-
    At the same time it allows anyone to build a custom version of OpenCV
    19-
    for any Python version: just fork this repo and modify the build files
    20-
    and scripts to fit your needs.
    12+
    **Unofficial** OpenCV packages for Python.
    2113

    2214
    Installation and Usage
    2315
    ----------------------
    @@ -32,6 +24,24 @@ To import the package:
    3224

    3325
    `OpenCV documentation <http://docs.opencv.org/>`__
    3426

    27+
    IMPORTANT NOTE:
    28+
    29+
    MacOS and Linux wheels have some limitations:
    30+
    31+
    - video related functionality is not supported (not compiled with FFmpeg)
    32+
    - for example ``cv.imshow()`` will not work (not compiled with GTK+ 2.x or Carbon support)
    33+
    34+
    Documentation for opencv-python
    35+
    -------------------------------
    36+
    37+
    The aim of this repository is to provide means to package each new
    38+
    `OpenCV release <https://github.com/opencv/opencv/releases>`__ for the
    39+
    most used Python versions and platforms.
    40+
    41+
    At the same time it allows anyone to build a custom version of OpenCV
    42+
    for any Python version: just fork this repo and modify the build files
    43+
    and scripts to fit your needs.
    44+
    3545
    Build process
    3646
    -------------
    3747

    @@ -60,17 +70,17 @@ Currently the ``find_version.py`` file parses OpenCV version information
    6070
    from the OpenCV sources. OpenCV depends on numpy, so ``setup.py`` checks
    6171
    the numpy version also with the help of pip.
    6272

    63-
    The ``cv2.pyd`` file for example on Windows is normally copied to site-packages.
    64-
    To avoid polluting the root folder the ``__init__.py`` file in cv2 folder
    65-
    handles the import logic correctly by importing the actual ``.pyd`` module
    66-
    and replacing the imported cv2 package in ``sys.modudes`` with the
    73+
    The ``cv2.pyd`` file for example on Windows is normally copied to site-packages.
    74+
    To avoid polluting the root folder the ``__init__.py`` file in cv2 folder
    75+
    handles the import logic correctly by importing the actual ``.pyd`` module
    76+
    and replacing the imported cv2 package in ``sys.modudes`` with the
    6777
    cv2 module to retain backward compatibility.
    6878

    6979
    Licensing
    7080
    ---------
    7181

    7282
    Opencv-python package (scripts in this repository) is available under
    73-
    MIT license.
    83+
    MIT license.
    7484

    7585
    OpenCV itself is available under `3-clause BSD
    7686
    License <https://github.com/opencv/opencv/blob/master/LICENSE>`__
    @@ -111,34 +121,21 @@ Manylinux wheels
    111121

    112122
    Linux wheels are built using
    113123
    `manylinux <https://github.com/pypa/python-manylinux-demo>`__. These
    114-
    wheels should work out of the box for most of the distros
    115-
    (which use GNU C standard library) out there since they are built
    124+
    wheels should work out of the box for most of the distros
    125+
    (which use GNU C standard library) out there since they are built
    116126
    against an old version of glibc.
    117127

    118128
    Supported Python versions
    119129
    -------------------------
    120130

    131+
    Python 2.7 is the only supported version in 2.x series.
    132+
    Python 3.x releases follow Numpy releases, for example
    133+
    Python 3.3 is no longer supported by Numpy so the support
    134+
    for it has been dropped in ``opencv-python`` too.
    121135

    122-
    Windows:
    123-
    ~~~~~~~~
    124-
    125-
    There's a build time limitation (AppVeyor open source builds may take
    126-
    max 1 hour) which restricts the supported Python versions to two
    127-
    (note: the performance is better nowadays, for example py33 and py34
    128-
    could be added to appveyor.yml). As Python's 2.x releases are slowly
    129-
    approaching legacy state, 2.7.x releases will be the only supported Python 2
    130-
    versions on Windows. On Python 3 side, builds will be run only for the latest release.
    131-
    132-
    However, if you wan't to get some other versions, just fork this repo
    133-
    and change the dependencies.
    134-
    135-
    Linux
    136-
    ~~~~~
    137-
    138-
    Manylinux wheels are built for all the Python versions which are
    139-
    supported by the manylinux containers.
    140-
    141-
    OS X
    142-
    ~~~~
    136+
    Currently, builds for following Python versions are provided:
    143137

    144-
    Currently built for Python 2.7, 3.4 and 3.5.
    138+
    - 2.7
    139+
    - 3.4
    140+
    - 3.5
    141+
    - 3.6

    0 commit comments

    Comments
     (0)
    0