| Jon Brandvein | 9150caa | 2019-10-08 23:54:04 -0400 | [diff] [blame] | 1 | # Python Rules for Bazel |
| Matt Moore | 9160fc7 | 2017-08-11 10:06:19 -0700 | [diff] [blame] | 2 | |
| Richard Levasseur | c32d232 | 2023-08-23 08:25:12 -0700 | [diff] [blame] | 3 | [](https://buildkite.com/bazel/rules-python-python) |
| Matt Moore | 9160fc7 | 2017-08-11 10:06:19 -0700 | [diff] [blame] | 4 | |
| Matt Moore | 9160fc7 | 2017-08-11 10:06:19 -0700 | [diff] [blame] | 5 | ## Overview |
| 6 | |
| Jon Brandvein | 9150caa | 2019-10-08 23:54:04 -0400 | [diff] [blame] | 7 | This repository is the home of the core Python rules -- `py_library`, |
| Ivo List | 0d3c4f7 | 2023-01-18 23:15:52 +0000 | [diff] [blame] | 8 | `py_binary`, `py_test`, `py_proto_library`, and related symbols that provide the basis for Python |
| Chris Love | 23354a9 | 2023-07-24 10:53:53 -0600 | [diff] [blame] | 9 | support in Bazel. It also contains package installation rules for integrating with PyPI and other indices. |
| 10 | |
| Richard Levasseur | 327b4e3 | 2023-10-19 11:03:01 -0700 | [diff] [blame] | 11 | Documentation for rules_python is at <https://rules-python.readthedocs.io> and in the |
| Jon Brandvein | 9150caa | 2019-10-08 23:54:04 -0400 | [diff] [blame] | 12 | [Bazel Build Encyclopedia](https://docs.bazel.build/versions/master/be/python.html). |
| Jon Brandvein | 6c5f479 | 2019-08-02 15:19:47 -0400 | [diff] [blame] | 13 | |
| Chris Love | 23354a9 | 2023-07-24 10:53:53 -0600 | [diff] [blame] | 14 | Examples live in the [examples](examples) directory. |
| 15 | |
| Greg Roodt | 55d1042 | 2024-06-23 11:35:56 +1000 | [diff] [blame] | 16 | The core rules are stable. Their implementation is subject to Bazel's |
| Jon Brandvein | 9150caa | 2019-10-08 23:54:04 -0400 | [diff] [blame] | 17 | [backward compatibility policy](https://docs.bazel.build/versions/master/backward-compatibility.html). |
| Greg Roodt | 55d1042 | 2024-06-23 11:35:56 +1000 | [diff] [blame] | 18 | This repository aims to follow [semantic versioning](https://semver.org). |
| Matt Moore | 9160fc7 | 2017-08-11 10:06:19 -0700 | [diff] [blame] | 19 | |
| Chris Love | 23354a9 | 2023-07-24 10:53:53 -0600 | [diff] [blame] | 20 | The Bazel community maintains this repository. Neither Google nor the Bazel team provides support for the code. However, this repository is part of the test suite used to vet new Bazel releases. See [How to contribute](CONTRIBUTING.md) page for information on our development workflow. |
| Jon Brandvein | 9150caa | 2019-10-08 23:54:04 -0400 | [diff] [blame] | 21 | |
| Richard Levasseur | 327b4e3 | 2023-10-19 11:03:01 -0700 | [diff] [blame] | 22 | ## Documentation |
| 23 | |
| 24 | For detailed documentation, see <https://rules-python.readthedocs.io> |
| 25 | |
| Chris Love | 23354a9 | 2023-07-24 10:53:53 -0600 | [diff] [blame] | 26 | ## Bzlmod support |
| Chris Love | 9268d91 | 2023-05-15 16:05:53 -0600 | [diff] [blame] | 27 | |
| 28 | - Status: Beta |
| 29 | - Full Feature Parity: No |
| 30 | |
| 31 | See [Bzlmod support](BZLMOD_SUPPORT.md) for more details. |
