xref: /aosp_15_r20/external/bazelbuild-rules_python/README.md (revision 60517a1edbc8ecf509223e9af94a7adec7d736b8)
1# Python Rules for Bazel
2
3[![Build status](https://badge.buildkite.com/0bcfe58b6f5741aacb09b12485969ba7a1205955a45b53e854.svg?branch=main)](https://buildkite.com/bazel/rules-python-python)
4
5## Overview
6
7This repository is the home of the core Python rules -- `py_library`,
8`py_binary`, `py_test`, `py_proto_library`, and related symbols that provide the basis for Python
9support in Bazel. It also contains package installation rules for integrating with PyPI and other indices.
10
11Documentation for rules_python is at <https://rules-python.readthedocs.io> and in the
12[Bazel Build Encyclopedia](https://docs.bazel.build/versions/master/be/python.html).
13
14Examples live in the [examples](examples) directory.
15
16The core rules are stable. Their implementation is subject to Bazel's
17[backward compatibility policy](https://docs.bazel.build/versions/master/backward-compatibility.html).
18This repository aims to follow [semantic versioning](https://semver.org).
19
20The 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.
21
22## Documentation
23
24For detailed documentation, see <https://rules-python.readthedocs.io>
25
26## Bzlmod support
27
28- Status: Beta
29- Full Feature Parity: No
30
31See [Bzlmod support](BZLMOD_SUPPORT.md) for more details.
32