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