aboutsummaryrefslogtreecommitdiffhomepage
path: root/python/release/wheel/README.md
diff options
context:
space:
mode:
authorGravatar Paul Yang <TeBoring@users.noreply.github.com>2017-06-28 15:22:19 -0700
committerGravatar GitHub <noreply@github.com>2017-06-28 15:22:19 -0700
commit176bac6dac03f8dc728fd9c7a0fbc96aedfed7d1 (patch)
treede0d7b0b47ae40b86d0be74f62581fc32af63af1 /python/release/wheel/README.md
parent12acbc2678073c3439b427be0b713b97e2074bfb (diff)
Add scripts to build python wheel for linux. (#2693)
* Add scripts to build python wheel for linux. Followed PEP513. * Fix dist check for new added files. * Update README for usage example.
Diffstat (limited to 'python/release/wheel/README.md')
-rw-r--r--python/release/wheel/README.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/python/release/wheel/README.md b/python/release/wheel/README.md
new file mode 100644
index 00000000..edda2cd7
--- /dev/null
+++ b/python/release/wheel/README.md
@@ -0,0 +1,17 @@
+Description
+------------------------------
+This directory is used to build released wheels according to PEP513 and upload
+them to pypi.
+
+Usage
+------------------------------
+For example, to release 3.3.0:
+ ./protobuf_optimized_pip.sh 3.3.0 PYPI_USERNAME PYPI_PASSWORD
+
+Structure
+------------------------------
+| Source | Source |
+|--------------------------------------|---------------------------------------------------|
+| protobuf_optimized_pip.sh | Entry point. Calling Dockerfile and build_wheel_manylinux.sh |
+| Dockerfile | Build docker image according to PEP513. |
+| build_wheel_manylinux.sh | Build wheel packages in the docker container. |