always-cautious/ortools-clone
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Fixup README.md

Browse Source
This commit is contained in:
Corentin Le Molgat
2020-11-18 18:18:43 +01:00
parent 4cd85e08c4
commit 7dc7ce13af
2 changed files with 103 additions and 64 deletions
Download Patch File Download Diff File Expand all files Collapse all files

67
ortools/python/README.md
View File

@@ -1,43 +1,54 @@
# Introduction
This is the documentation page for the Python 3.6+ wrapper of OR-Tools.
This project aim to explain how you build a Python native wheel package using [`setup.py`](https://packaging.python.org/tutorials/packaging-projects/).
This project aim to explain how you build a Python native wheel package using
[`setup.py`](https://packaging.python.org/tutorials/packaging-projects/).
## Table of Content
* [Requirement](#requirement)
* [Directory Layout](#directory-layout)
* [Build Process](#build-process)
* [Local Package](#local-package)
* [Building a native Package](#building-local-native-package)
* [Building a native Package](#building-local-native-package)
* [Appendices](#appendices)
* [Ressources](#ressources)
* [Misc](#misc)
# Requirement
## Requirement
You'll need "Python >= 3.6" and few python modules ("wheel" and "absl-py").
# Directory Layout
* [setup.py.in](setup.py.in) `Setup.py` template to build the python native project.
## Directory Layout
* [setup.py.in](setup.py.in) `Setup.py` template to build the python native
project.
## Build Process
# Build Process
To Create a native dependent package which will contains two parts:
- A bunch of native libraries for the supported platform targeted.
- The Python code depending on it.
* A bunch of native libraries for the supported platform targeted.
* The Python code depending on it.
[`platform` names](https://github.com/java-native-access/jna/blob/cc1acdac02e4d0dda93ba01bbe3a3435b8933dab/test/com/sun/jna/PlatformTest.java#L31-L100) come from the JNA project (Java Native Access) which will be use to find at runtime on which platform the code is currently running.
[`platform` names](https://github.com/java-native-access/jna/blob/cc1acdac02e4d0dda93ba01bbe3a3435b8933dab/test/com/sun/jna/PlatformTest.java#L31-L100)
come from the JNA project (Java Native Access) which will be use to find at
runtime on which platform the code is currently running.
## Local Package
The pipeline for `linux-x86-64` should be as follow:
note: The pipeline will be similar for other architectures, don't hesitate to look at the CI log!
![Local Pipeline](doc/local_pipeline.svg)
### Local Package
The pipeline for `linux-x86-64` should be as follow: \
note: The pipeline will be similar for other architectures, don't hesitate to
look at the CI log! ![Local Pipeline](doc/local_pipeline.svg)
![Legend](doc/legend.svg)
### Building local native Package
Thus we have the C++ shared library `libortools.so` and the SWIG generated Python wrappers e.g. `pywrapsat.py` in the same package.
#### Building local native Package
Thus we have the C++ shared library `libortools.so` and the SWIG generated
Python wrappers e.g. `pywrapsat.py` in the same package.
Here some dev-note concerning this `setup.py`.
- This package is a native package containing native libraries.
* This package is a native package containing native libraries.
Then you can generate the package and install it locally using:
```bash
@@ -45,7 +56,8 @@ python3 setup.py bdist_wheel
python3 -m pip install --user --find-links=dist ortools
```
If everything good the package (located in `<buildir>/python/dist`) should have this layout:
If everything good the package (located in `<buildir>/python/dist`) should have
this layout:
```
{...}/dist/ortools-8.0.9999-cp38-cp38-<platform>.whl:
\- ortools
@@ -60,22 +72,25 @@ If everything good the package (located in `<buildir>/python/dist`) should have
\- __init__.py
\- pywrap....py
\- _pywrap....so
...
...
```
note: `<platform>` could be `manylinux2010_x86_64`, `macosx_10_9_x86_64` or `win-amd64`.
tips: since wheel package are just zip archive you can use `unzip -l <package>.whl` to study their layout.
tips: since wheel package are just zip archive you can use `unzip -l <package>.whl`
to study their layout.
## Appendices
# Appendices
Few links on the subject...
## Ressources
### Ressources
- [Packaging Python Project](https://packaging.python.org/tutorials/packaging-projects/)
- [PEP 513 -- A Platform Tag for Portable Linux Built Distributions](https://www.python.org/dev/peps/pep-0513/)
- [PEP 571 -- The manylinux2010 Platform Tag](https://www.python.org/dev/peps/pep-0571/)
* [Packaging Python Project](https://packaging.python.org/tutorials/packaging-projects/)
* [PEP 513 -- A Platform Tag for Portable Linux Built Distributions](https://www.python.org/dev/peps/pep-0513/)
* [PEP 571 -- The manylinux2010 Platform Tag](https://www.python.org/dev/peps/pep-0571/)
## Misc
# Misc
Image has been generated using [plantuml](http://plantuml.com/):
```bash
plantuml -Tsvg doc/{file}.dot