misc.python.materialize

 1# Copyright Materialize, Inc. and contributors. All rights reserved.
 2#
 3# Use of this software is governed by the Business Source License
 4# included in the LICENSE file at the root of this repository.
 5#
 6# As of the Change Date specified in that file, in accordance with
 7# the Business Source License, use of this software will be governed
 8# by the Apache License, Version 2.0.
 9
10"""Package `materialize` is the top-level Python package for Materialize, Inc.
11
12While the primary product, [materialized][], is written in Rust, various demos and
13build tools are written in Python. This package enables the sharing of code
14between those scripts.
15
16Consider writing additional Python code when:
17
18  * You are writing scripts intended to be run by users of Materialize, not
19    developers, e.g. automation for a complicated demo. We can reasonably ask
20    users to install Python 3.6+. A Rust toolchain is a much bigger ask.
21
22  * You are about to write a large Bash script.
23
24  * You've already written a Bash script whose complexity and maintainability
25    has deteriorated as the script's responsibilities have grown.
26
27[materialized]: https://dev.materialize.com/api/rust/materialized/index.html
28"""
29
30import os
31from pathlib import Path
32
33MZ_ROOT = Path(os.environ["MZ_ROOT"])
34"""The absolute path to the root of the Materialize repository."""