Mercurial > repos > guerler > springsuite
comparison planemo/lib/python3.7/site-packages/bleach/_vendor/README.rst @ 0:d30785e31577 draft
"planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1"
| author | guerler |
|---|---|
| date | Fri, 31 Jul 2020 00:18:57 -0400 |
| parents | |
| children |
comparison
equal
deleted
inserted
replaced
| -1:000000000000 | 0:d30785e31577 |
|---|---|
| 1 ======================= | |
| 2 Vendored library policy | |
| 3 ======================= | |
| 4 | |
| 5 To simplify Bleach development, we're now vendoring certain libraries that | |
| 6 we use. | |
| 7 | |
| 8 Vendored libraries must follow these rules: | |
| 9 | |
| 10 1. Vendored libraries must be pure Python--no compiling. | |
| 11 2. Source code for the libary is included in this directory. | |
| 12 3. License must be included in this repo and in the Bleach distribution. | |
| 13 4. Requirements of the library become requirements of Bleach. | |
| 14 5. No modifications to the library may be made. | |
| 15 | |
| 16 | |
| 17 Adding/Updating a vendored library | |
| 18 ================================== | |
| 19 | |
| 20 Way to vendor a library or update a version: | |
| 21 | |
| 22 1. Update ``vendor.txt`` with the library, version, and hash. You can use | |
| 23 `hashin <https://pypi.org/project/hashin/>`_. | |
| 24 2. Remove all old files and directories of the old version. | |
| 25 3. Run ``pip_install_vendor.sh`` and check everything it produced in including | |
| 26 the ``.dist-info`` directory and contents. | |
| 27 | |
| 28 | |
| 29 Reviewing a change involving a vendored library | |
| 30 =============================================== | |
| 31 | |
| 32 Way to verify a vendored library addition/update: | |
| 33 | |
| 34 1. Pull down the branch. | |
| 35 2. Delete all the old files and directories of the old version. | |
| 36 3. Run ``pip_install_vendor.sh``. | |
| 37 4. Run ``git diff`` and verify there are no changes. |