Package: jheaps
Python-JHeapsPython bindings for theJHeaps library.The JHeaps is a free Java library that provides various heap implementations.While the original library is written in Java, this package uses anative buildprovided by
thejheaps-capiproject. The native build is in the form of a
shared library, created byGraalVM.The result is anative self-contained librarywithno dependencyon the JVM!InstallingWe automatically build 64-bit wheels for python versions 3.6, 3.7, and 3.8 on Linux,
Windows and MacOSX. They can be directly downloaded fromPyPIor using pip.
For linux we usePEP 571which means that pip version must be>= 19.0.Thus, on a recent machine, installation should be as easy as:pip install jheapsIf your pip version is older than19.0you will need to upgrade:pip install --upgrade pip
pip install jheapsIf you want to usevirtualenvorvenvmodule, you can write:python -m venv venv
source venv/bin/activate
pip install --upgrade pip
pip install jheapsInstallation on the user directory is also possible:pip install --upgrade pip
pip install --user jheapsDocumentationAutomatically generated documentation with a tutorial and examples can be found athttps://python-jheaps.readthedocs.io/. This includes full API docs, tutorials and examples.BuildingThe jheaps-capi project is included in the sources as a git submodule in foldervendor/source/jheaps-capi.
You need to either initialize the submodule by hand, or you can pass option--recurse-submoduleswhen
cloning this repository.The following pieces of software are required for the build to succeed:GraalVM 20.0 with Java 11 supportNative Image component from GraalVMMaven Java build toolGNU C compiler or clangCMakePython 3.6 and aboveSWIG 3 and aboveIf all the above are installed properly, building can be done usingpython setup.py buildFor Windows you will need Microsoft Visual C++ (MSVC) 2017 15.5.5 or later. Build the
system using the properDeveloper Command Promptfor your version ofVisual Studio. This meansx64 Native Tools Command Prompt. Use Visual Studio 2017 or later.InstallInstall usingpip install .DevelopSince the library contains parts which are written in C that need to be compiled before use, make sure you have
the necessary compilers and development headers installed. Compiled code means that additional steps are required
in order to import from the development sources. Using the following commands you can setup an in-place development
environment:python3 -m venv .venv
source .venv/bin/activate
pip install -r requirements.txtThis allows you to import the in-place build from the repository base directory. If you want it to
also be visible outside the base dir, you have to adjust thePYTHONPATHaccordingly.
Note also that the above commands callpython setup.py develop. Instead of adjusting PYTHONPATH, this installs
a .egg-link file into your site-packages as well as adjusts the easy-install.pth there, so its a more permanent
operation.TestsExecute the tests by givingpip install -r requirements/test.txt
pytestBuilding the docspip install -r requirements/doc.txt
cd docs && make htmlLicenseThis library may be used under the terms of theApache License 2.0https://www.apache.org/licenses/LICENSE-2.0Please note that this library is distributed WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.Please refer to the license for details.SPDX-License-Identifier: Apache-2.0Author(C) Copyright 2020, by Dimitrios MichailEnjoy!