├── .circleci
└── config.yml
├── .gitignore
├── 0-base
├── Dockerfile
├── Tiltfile
├── app.py
├── kubernetes.yaml
├── requirements.txt
├── static
│ └── pets.png
└── templates
│ └── index.html
├── 1-measured
├── Dockerfile
├── Tiltfile
├── app.py
├── kubernetes.yaml
├── now.py
├── requirements.txt
├── static
│ └── pets.png
└── templates
│ └── index.html
├── 2-optimize-dockerfile
├── Dockerfile
├── Tiltfile
├── app.py
├── kubernetes.yaml
├── now.py
├── requirements.txt
├── static
│ └── pets.png
└── templates
│ └── index.html
├── 3-recommended
├── Dockerfile
├── Tiltfile
├── app.py
├── kubernetes.yaml
├── now.py
├── requirements.txt
├── static
│ └── pets.png
└── templates
│ └── index.html
├── LICENSE
├── NOTICE
├── README.md
├── debugger-examples
├── README.md
├── remote-pdb
│ ├── Dockerfile
│ ├── README.md
│ ├── Tiltfile
│ ├── app.py
│ ├── kubernetes.yaml
│ ├── requirements.txt
│ ├── static
│ │ └── pets.png
│ └── templates
│ │ └── index.html
└── web-pdb
│ ├── Dockerfile
│ ├── README.md
│ ├── Tiltfile
│ ├── app.py
│ ├── kubernetes.yaml
│ ├── requirements.txt
│ ├── static
│ └── pets.png
│ └── templates
│ └── index.html
└── test
├── test.ps1
└── test.sh
/.circleci/config.yml:
--------------------------------------------------------------------------------
1 | version: 2.1
2 | jobs:
3 | build:
4 | docker:
5 | - image: docker/tilt:latest
6 |
7 | steps:
8 | - checkout
9 | - setup_remote_docker
10 | - run: apt update && apt install -y python3
11 | - run: ctlptl create cluster kind --registry=ctlptl-registry && test/test.sh
12 |
--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | start-time.txt
2 | __py-cache__
3 | *.pyc
--------------------------------------------------------------------------------
/0-base/Dockerfile:
--------------------------------------------------------------------------------
1 | FROM python:3-alpine
2 |
3 | WORKDIR /app
4 |
5 | ADD . .
6 |
7 | RUN pip install -r requirements.txt
8 |
9 | ENTRYPOINT ["python", "/app/app.py"]
10 |
--------------------------------------------------------------------------------
/0-base/Tiltfile:
--------------------------------------------------------------------------------
1 | # -*- mode: Python -*-
2 |
3 | docker_build('example-python-image', '.')
4 | k8s_yaml('kubernetes.yaml')
5 | k8s_resource('example-python', port_forwards=8000)
6 |
--------------------------------------------------------------------------------
/0-base/app.py:
--------------------------------------------------------------------------------
1 | from flask import Flask, render_template
2 | app = Flask(__name__)
3 |
4 |
5 | @app.route("/")
6 | def serve():
7 | return render_template("index.html")
8 |
9 |
10 | if __name__ == "__main__":
11 | app.run(port=8000)
12 |
--------------------------------------------------------------------------------
/0-base/kubernetes.yaml:
--------------------------------------------------------------------------------
1 | apiVersion: apps/v1
2 | kind: Deployment
3 | metadata:
4 | name: example-python
5 | labels:
6 | app: example-python
7 | spec:
8 | selector:
9 | matchLabels:
10 | app: example-python
11 | template:
12 | metadata:
13 | labels:
14 | app: example-python
15 | spec:
16 | containers:
17 | - name: example-python
18 | image: example-python-image
19 | ports:
20 | - containerPort: 8000
21 |
--------------------------------------------------------------------------------
/0-base/requirements.txt:
--------------------------------------------------------------------------------
1 | Flask==3.0.0
2 |
--------------------------------------------------------------------------------
/0-base/static/pets.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/tilt-dev/tilt-example-python/363a39cdc040e0a9c6ce75a2197474094bd0237e/0-base/static/pets.png
--------------------------------------------------------------------------------
/0-base/templates/index.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |

6 |
Hello cats!
7 |
8 |
9 |
10 |
--------------------------------------------------------------------------------
/1-measured/Dockerfile:
--------------------------------------------------------------------------------
1 | FROM python:3-alpine
2 |
3 | WORKDIR /app
4 |
5 | ADD . .
6 |
7 | RUN pip install -r requirements.txt
8 |
9 | ENTRYPOINT ["python", "/app/app.py"]
10 |
--------------------------------------------------------------------------------
/1-measured/Tiltfile:
--------------------------------------------------------------------------------
1 | # -*- mode: Python -*-
2 |
3 | # Records the current time, then kicks off a server update.
4 | # Normally, you would let Tilt do deploys automatically, but this
5 | # shows you how to set up a custom workflow that measures it.
6 | local_resource(
7 | 'deploy',
8 | 'python3 now.py > start-time.txt',
9 | )
10 |
11 | docker_build('example-python-image', '.')
12 | k8s_yaml('kubernetes.yaml')
13 | k8s_resource('example-python', port_forwards=8000,
14 | resource_deps=['deploy'])
15 |
--------------------------------------------------------------------------------
/1-measured/app.py:
--------------------------------------------------------------------------------
1 | import time
2 |
3 | from flask import Flask, render_template
4 | app = Flask(__name__)
5 |
6 | UPDATE_TIME = 'N/A'
7 |
8 |
9 | def get_update_time_secs() -> float:
10 | with open('/app/start-time.txt', 'r') as file:
11 | start_ns_since_epoch = float(file.read().strip())
12 |
13 | start_secs_since_epoch = start_ns_since_epoch / 10**9
14 | now_secs_since_epoch = time.time()
15 |
16 | return round(now_secs_since_epoch - start_secs_since_epoch, 2)
17 |
18 |
19 | @app.route("/")
20 | def serve():
21 | return render_template("index.html", time=UPDATE_TIME)
22 |
23 |
24 | if __name__ == "__main__":
25 | UPDATE_TIME = get_update_time_secs()
26 | app.run(port=8000)
27 |
--------------------------------------------------------------------------------
/1-measured/kubernetes.yaml:
--------------------------------------------------------------------------------
1 | apiVersion: apps/v1
2 | kind: Deployment
3 | metadata:
4 | name: example-python
5 | labels:
6 | app: example-python
7 | spec:
8 | selector:
9 | matchLabels:
10 | app: example-python
11 | template:
12 | metadata:
13 | labels:
14 | app: example-python
15 | spec:
16 | containers:
17 | - name: example-python
18 | image: example-python-image
19 | ports:
20 | - containerPort: 8000
21 |
--------------------------------------------------------------------------------
/1-measured/now.py:
--------------------------------------------------------------------------------
1 | import time
2 |
3 | print("%d" % (float(time.time()) * 1000 * 1000 * 1000))
--------------------------------------------------------------------------------
/1-measured/requirements.txt:
--------------------------------------------------------------------------------
1 | Flask==3.0.0
2 |
--------------------------------------------------------------------------------
/1-measured/static/pets.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/tilt-dev/tilt-example-python/363a39cdc040e0a9c6ce75a2197474094bd0237e/1-measured/static/pets.png
--------------------------------------------------------------------------------
/1-measured/templates/index.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |

6 |
Hello cats!
7 |
Time from "deploy" button pressed → server up: {{time}}s
8 |
9 |
10 |
11 |
--------------------------------------------------------------------------------
/2-optimize-dockerfile/Dockerfile:
--------------------------------------------------------------------------------
1 | FROM python:3-alpine
2 |
3 | WORKDIR /app
4 |
5 | ADD requirements.txt .
6 | RUN pip install -r requirements.txt
7 |
8 | ADD . .
9 |
10 | ENTRYPOINT ["python", "/app/app.py"]
11 |
--------------------------------------------------------------------------------
/2-optimize-dockerfile/Tiltfile:
--------------------------------------------------------------------------------
1 | # -*- mode: Python -*-
2 |
3 | # Records the current time, then kicks off a server update.
4 | # Normally, you would let Tilt do deploys automatically, but this
5 | # shows you how to set up a custom workflow that measures it.
6 | local_resource(
7 | 'deploy',
8 | 'python3 now.py > start-time.txt',
9 | )
10 |
11 | docker_build('example-python-image', '.')
12 | k8s_yaml('kubernetes.yaml')
13 | k8s_resource('example-python', port_forwards=8000,
14 | resource_deps=['deploy'])
15 |
--------------------------------------------------------------------------------
/2-optimize-dockerfile/app.py:
--------------------------------------------------------------------------------
1 | import time
2 |
3 | from flask import Flask, render_template
4 | app = Flask(__name__)
5 |
6 | UPDATE_TIME = 'N/A'
7 |
8 |
9 | def get_update_time_secs() -> float:
10 | with open('/app/start-time.txt', 'r') as file:
11 | start_ns_since_epoch = float(file.read().strip())
12 |
13 | start_secs_since_epoch = start_ns_since_epoch / 10**9
14 | now_secs_since_epoch = time.time()
15 |
16 | return round(now_secs_since_epoch - start_secs_since_epoch, 2)
17 |
18 |
19 | @app.route("/")
20 | def serve():
21 | return render_template("index.html", time=UPDATE_TIME)
22 |
23 |
24 | if __name__ == "__main__":
25 | UPDATE_TIME = get_update_time_secs()
26 | app.run(port=8000)
27 |
--------------------------------------------------------------------------------
/2-optimize-dockerfile/kubernetes.yaml:
--------------------------------------------------------------------------------
1 | apiVersion: apps/v1
2 | kind: Deployment
3 | metadata:
4 | name: example-python
5 | labels:
6 | app: example-python
7 | spec:
8 | selector:
9 | matchLabels:
10 | app: example-python
11 | template:
12 | metadata:
13 | labels:
14 | app: example-python
15 | spec:
16 | containers:
17 | - name: example-python
18 | image: example-python-image
19 | ports:
20 | - containerPort: 8000
21 |
--------------------------------------------------------------------------------
/2-optimize-dockerfile/now.py:
--------------------------------------------------------------------------------
1 | import time
2 |
3 | print("%d" % (float(time.time()) * 1000 * 1000 * 1000))
--------------------------------------------------------------------------------
/2-optimize-dockerfile/requirements.txt:
--------------------------------------------------------------------------------
1 | Flask==3.0.0
2 |
--------------------------------------------------------------------------------
/2-optimize-dockerfile/static/pets.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/tilt-dev/tilt-example-python/363a39cdc040e0a9c6ce75a2197474094bd0237e/2-optimize-dockerfile/static/pets.png
--------------------------------------------------------------------------------
/2-optimize-dockerfile/templates/index.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |

6 |
Hello cats!
7 |
Time from "deploy" button pressed → server up: {{time}}s
8 |
9 |
10 |
11 |
--------------------------------------------------------------------------------
/3-recommended/Dockerfile:
--------------------------------------------------------------------------------
1 | FROM python:3-alpine
2 |
3 | # Default value; will be overridden by build-args, if passed
4 | ARG flask_debug=False
5 |
6 | ENV FLASK_DEBUG $flask_debug
7 |
8 | WORKDIR /app
9 |
10 | ADD requirements.txt .
11 | RUN pip install -r requirements.txt
12 |
13 | ADD . .
14 |
15 | ENTRYPOINT ["python", "/app/app.py"]
16 |
--------------------------------------------------------------------------------
/3-recommended/Tiltfile:
--------------------------------------------------------------------------------
1 | # -*- mode: Python -*
2 |
3 | k8s_yaml('kubernetes.yaml')
4 | k8s_resource('example-python', port_forwards=8000,
5 | resource_deps=['deploy'])
6 |
7 | # Records the current time, then kicks off a server update.
8 | # Normally, you would let Tilt do deploys automatically, but this
9 | # shows you how to set up a custom workflow that measures it.
10 | local_resource(
11 | 'deploy',
12 | 'python3 now.py > start-time.txt',
13 | )
14 |
15 | # Add a live_update rule to our docker_build
16 | congrats = "🎉 Congrats, you ran a live_update! 🎉"
17 | docker_build('example-python-image', '.', build_args={'flask_debug': 'True'},
18 | live_update=[
19 | sync('.', '/app'),
20 | run('cd /app && pip install -r requirements.txt',
21 | trigger='./requirements.txt'),
22 |
23 | # if all that changed was start-time.txt, make sure the server
24 | # reloads so that it will reflect the new startup time
25 | run('touch /app/app.py', trigger='./start-time.txt'),
26 |
27 | # add a congrats message!
28 | run('sed -i "s/Hello cats!/{}/g" /app/templates/index.html'.
29 | format(congrats)),
30 | ])
31 |
--------------------------------------------------------------------------------
/3-recommended/app.py:
--------------------------------------------------------------------------------
1 | import time
2 |
3 | from flask import Flask, render_template
4 | app = Flask(__name__)
5 |
6 | UPDATE_TIME = 'N/A'
7 |
8 |
9 | def get_update_time_secs() -> float:
10 | with open('/app/start-time.txt', 'r') as file:
11 | start_ns_since_epoch = float(file.read().strip())
12 |
13 | start_secs_since_epoch = start_ns_since_epoch / 10**9
14 | now_secs_since_epoch = time.time()
15 |
16 | return round(now_secs_since_epoch - start_secs_since_epoch, 2)
17 |
18 |
19 | @app.route("/")
20 | def serve():
21 | return render_template("index.html", time=UPDATE_TIME)
22 |
23 |
24 | if __name__ == "__main__":
25 | UPDATE_TIME = get_update_time_secs()
26 | app.run(port=8000)
27 |
--------------------------------------------------------------------------------
/3-recommended/kubernetes.yaml:
--------------------------------------------------------------------------------
1 | apiVersion: apps/v1
2 | kind: Deployment
3 | metadata:
4 | name: example-python
5 | labels:
6 | app: example-python
7 | spec:
8 | selector:
9 | matchLabels:
10 | app: example-python
11 | template:
12 | metadata:
13 | labels:
14 | app: example-python
15 | spec:
16 | containers:
17 | - name: example-python
18 | image: example-python-image
19 | ports:
20 | - containerPort: 8000
21 |
--------------------------------------------------------------------------------
/3-recommended/now.py:
--------------------------------------------------------------------------------
1 | import time
2 |
3 | print("%d" % (float(time.time()) * 1000 * 1000 * 1000))
--------------------------------------------------------------------------------
/3-recommended/requirements.txt:
--------------------------------------------------------------------------------
1 | Flask==3.0.0
2 |
--------------------------------------------------------------------------------
/3-recommended/static/pets.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/tilt-dev/tilt-example-python/363a39cdc040e0a9c6ce75a2197474094bd0237e/3-recommended/static/pets.png
--------------------------------------------------------------------------------
/3-recommended/templates/index.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |

6 |
Hello cats!
7 |
Time from "deploy" button pressed → server up: {{time}}s
8 |
9 |
10 |
11 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | Apache License
2 | Version 2.0, January 2004
3 | http://www.apache.org/licenses/
4 |
5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6 |
7 | 1. Definitions.
8 |
9 | "License" shall mean the terms and conditions for use, reproduction,
10 | and distribution as defined by Sections 1 through 9 of this document.
11 |
12 | "Licensor" shall mean the copyright owner or entity authorized by
13 | the copyright owner that is granting the License.
14 |
15 | "Legal Entity" shall mean the union of the acting entity and all
16 | other entities that control, are controlled by, or are under common
17 | control with that entity. For the purposes of this definition,
18 | "control" means (i) the power, direct or indirect, to cause the
19 | direction or management of such entity, whether by contract or
20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the
21 | outstanding shares, or (iii) beneficial ownership of such entity.
22 |
23 | "You" (or "Your") shall mean an individual or Legal Entity
24 | exercising permissions granted by this License.
25 |
26 | "Source" form shall mean the preferred form for making modifications,
27 | including but not limited to software source code, documentation
28 | source, and configuration files.
29 |
30 | "Object" form shall mean any form resulting from mechanical
31 | transformation or translation of a Source form, including but
32 | not limited to compiled object code, generated documentation,
33 | and conversions to other media types.
34 |
35 | "Work" shall mean the work of authorship, whether in Source or
36 | Object form, made available under the License, as indicated by a
37 | copyright notice that is included in or attached to the work
38 | (an example is provided in the Appendix below).
39 |
40 | "Derivative Works" shall mean any work, whether in Source or Object
41 | form, that is based on (or derived from) the Work and for which the
42 | editorial revisions, annotations, elaborations, or other modifications
43 | represent, as a whole, an original work of authorship. For the purposes
44 | of this License, Derivative Works shall not include works that remain
45 | separable from, or merely link (or bind by name) to the interfaces of,
46 | the Work and Derivative Works thereof.
47 |
48 | "Contribution" shall mean any work of authorship, including
49 | the original version of the Work and any modifications or additions
50 | to that Work or Derivative Works thereof, that is intentionally
51 | submitted to Licensor for inclusion in the Work by the copyright owner
52 | or by an individual or Legal Entity authorized to submit on behalf of
53 | the copyright owner. For the purposes of this definition, "submitted"
54 | means any form of electronic, verbal, or written communication sent
55 | to the Licensor or its representatives, including but not limited to
56 | communication on electronic mailing lists, source code control systems,
57 | and issue tracking systems that are managed by, or on behalf of, the
58 | Licensor for the purpose of discussing and improving the Work, but
59 | excluding communication that is conspicuously marked or otherwise
60 | designated in writing by the copyright owner as "Not a Contribution."
61 |
62 | "Contributor" shall mean Licensor and any individual or Legal Entity
63 | on behalf of whom a Contribution has been received by Licensor and
64 | subsequently incorporated within the Work.
65 |
66 | 2. Grant of Copyright License. Subject to the terms and conditions of
67 | this License, each Contributor hereby grants to You a perpetual,
68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69 | copyright license to reproduce, prepare Derivative Works of,
70 | publicly display, publicly perform, sublicense, and distribute the
71 | Work and such Derivative Works in Source or Object form.
72 |
73 | 3. Grant of Patent License. Subject to the terms and conditions of
74 | this License, each Contributor hereby grants to You a perpetual,
75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76 | (except as stated in this section) patent license to make, have made,
77 | use, offer to sell, sell, import, and otherwise transfer the Work,
78 | where such license applies only to those patent claims licensable
79 | by such Contributor that are necessarily infringed by their
80 | Contribution(s) alone or by combination of their Contribution(s)
81 | with the Work to which such Contribution(s) was submitted. If You
82 | institute patent litigation against any entity (including a
83 | cross-claim or counterclaim in a lawsuit) alleging that the Work
84 | or a Contribution incorporated within the Work constitutes direct
85 | or contributory patent infringement, then any patent licenses
86 | granted to You under this License for that Work shall terminate
87 | as of the date such litigation is filed.
88 |
89 | 4. Redistribution. You may reproduce and distribute copies of the
90 | Work or Derivative Works thereof in any medium, with or without
91 | modifications, and in Source or Object form, provided that You
92 | meet the following conditions:
93 |
94 | (a) You must give any other recipients of the Work or
95 | Derivative Works a copy of this License; and
96 |
97 | (b) You must cause any modified files to carry prominent notices
98 | stating that You changed the files; and
99 |
100 | (c) You must retain, in the Source form of any Derivative Works
101 | that You distribute, all copyright, patent, trademark, and
102 | attribution notices from the Source form of the Work,
103 | excluding those notices that do not pertain to any part of
104 | the Derivative Works; and
105 |
106 | (d) If the Work includes a "NOTICE" text file as part of its
107 | distribution, then any Derivative Works that You distribute must
108 | include a readable copy of the attribution notices contained
109 | within such NOTICE file, excluding those notices that do not
110 | pertain to any part of the Derivative Works, in at least one
111 | of the following places: within a NOTICE text file distributed
112 | as part of the Derivative Works; within the Source form or
113 | documentation, if provided along with the Derivative Works; or,
114 | within a display generated by the Derivative Works, if and
115 | wherever such third-party notices normally appear. The contents
116 | of the NOTICE file are for informational purposes only and
117 | do not modify the License. You may add Your own attribution
118 | notices within Derivative Works that You distribute, alongside
119 | or as an addendum to the NOTICE text from the Work, provided
120 | that such additional attribution notices cannot be construed
121 | as modifying the License.
122 |
123 | You may add Your own copyright statement to Your modifications and
124 | may provide additional or different license terms and conditions
125 | for use, reproduction, or distribution of Your modifications, or
126 | for any such Derivative Works as a whole, provided Your use,
127 | reproduction, and distribution of the Work otherwise complies with
128 | the conditions stated in this License.
129 |
130 | 5. Submission of Contributions. Unless You explicitly state otherwise,
131 | any Contribution intentionally submitted for inclusion in the Work
132 | by You to the Licensor shall be under the terms and conditions of
133 | this License, without any additional terms or conditions.
134 | Notwithstanding the above, nothing herein shall supersede or modify
135 | the terms of any separate license agreement you may have executed
136 | with Licensor regarding such Contributions.
137 |
138 | 6. Trademarks. This License does not grant permission to use the trade
139 | names, trademarks, service marks, or product names of the Licensor,
140 | except as required for reasonable and customary use in describing the
141 | origin of the Work and reproducing the content of the NOTICE file.
142 |
143 | 7. Disclaimer of Warranty. Unless required by applicable law or
144 | agreed to in writing, Licensor provides the Work (and each
145 | Contributor provides its Contributions) on an "AS IS" BASIS,
146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147 | implied, including, without limitation, any warranties or conditions
148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149 | PARTICULAR PURPOSE. You are solely responsible for determining the
150 | appropriateness of using or redistributing the Work and assume any
151 | risks associated with Your exercise of permissions under this License.
152 |
153 | 8. Limitation of Liability. In no event and under no legal theory,
154 | whether in tort (including negligence), contract, or otherwise,
155 | unless required by applicable law (such as deliberate and grossly
156 | negligent acts) or agreed to in writing, shall any Contributor be
157 | liable to You for damages, including any direct, indirect, special,
158 | incidental, or consequential damages of any character arising as a
159 | result of this License or out of the use or inability to use the
160 | Work (including but not limited to damages for loss of goodwill,
161 | work stoppage, computer failure or malfunction, or any and all
162 | other commercial damages or losses), even if such Contributor
163 | has been advised of the possibility of such damages.
164 |
165 | 9. Accepting Warranty or Additional Liability. While redistributing
166 | the Work or Derivative Works thereof, You may choose to offer,
167 | and charge a fee for, acceptance of support, warranty, indemnity,
168 | or other liability obligations and/or rights consistent with this
169 | License. However, in accepting such obligations, You may act only
170 | on Your own behalf and on Your sole responsibility, not on behalf
171 | of any other Contributor, and only if You agree to indemnify,
172 | defend, and hold each Contributor harmless for any liability
173 | incurred by, or claims asserted against, such Contributor by reason
174 | of your accepting any such warranty or additional liability.
175 |
176 | END OF TERMS AND CONDITIONS
177 |
178 | APPENDIX: How to apply the Apache License to your work.
179 |
180 | To apply the Apache License to your work, attach the following
181 | boilerplate notice, with the fields enclosed by brackets "[]"
182 | replaced with your own identifying information. (Don't include
183 | the brackets!) The text should be enclosed in the appropriate
184 | comment syntax for the file format. We also recommend that a
185 | file or class name and description of purpose be included on the
186 | same "printed page" as the copyright notice for easier
187 | identification within third-party archives.
188 |
189 | Copyright [yyyy] [name of copyright owner]
190 |
191 | Licensed under the Apache License, Version 2.0 (the "License");
192 | you may not use this file except in compliance with the License.
193 | You may obtain a copy of the License at
194 |
195 | http://www.apache.org/licenses/LICENSE-2.0
196 |
197 | Unless required by applicable law or agreed to in writing, software
198 | distributed under the License is distributed on an "AS IS" BASIS,
199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200 | See the License for the specific language governing permissions and
201 | limitations under the License.
202 |
--------------------------------------------------------------------------------
/NOTICE:
--------------------------------------------------------------------------------
1 | Tilt Example Python
2 | Copyright 2022 Docker, Inc.
3 |
4 | This product includes software developed at Docker, Inc. (https://www.docker.com).
5 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # tilt-example-python
2 |
3 | [](https://circleci.com/gh/tilt-dev/tilt-example-python)
4 |
5 | An example project that demonstrates how to use Tilt to develop on a Python app (built with Flask). Read [doc](https://docs.tilt.dev/example_python.html).
6 |
7 | ## Fastest Deployment
8 |
9 | This progression of examples shows how to start, and incrementally update your project for the fastest possible update time. Follow along in our [Python example project guide](https://docs.tilt.dev/example_python.html).
10 |
11 | - [0-base](0-base): the simplest way to start
12 | - [1-measured](1-measured): use `local_resource` to measure your deployment time
13 | - [2-optimize-dockerfile](2-optimize-dockerfile): be sure to optimize your Dockerfile to make good use of caching
14 | - [3-recommended](3-recommended): use `live_update` for super-fast deploys
15 |
16 | ## Other Examples
17 | - [debugger-examples](debugger-examples): examples of how to use remote Python debuggers with your Tilt workflow
18 |
19 | ## License
20 |
21 | Copyright 2022 Docker, Inc.
22 |
23 | Licensed under [the Apache License, Version 2.0](LICENSE)
24 |
--------------------------------------------------------------------------------
/debugger-examples/README.md:
--------------------------------------------------------------------------------
1 | # Examples of Tilt + Remote Debuggers
2 |
3 | - [web-pdb](web-pdb): pdb in your browser
4 | - [remote-pdb](remote-pdb): pdb accessible by TCP connection (via Netcat, Telnet, Socat, or similar)
5 |
--------------------------------------------------------------------------------
/debugger-examples/remote-pdb/Dockerfile:
--------------------------------------------------------------------------------
1 | FROM python:3-alpine
2 |
3 | WORKDIR /app
4 |
5 | ADD requirements.txt .
6 | RUN pip install -r requirements.txt
7 |
8 | ADD . .
9 |
10 | ENTRYPOINT ["python", "/app/app.py"]
11 |
--------------------------------------------------------------------------------
/debugger-examples/remote-pdb/README.md:
--------------------------------------------------------------------------------
1 | # Run with Tilt, Debug with [`remote-pdb`](https://pypi.org/project/remote-pdb/)
2 |
3 | This directory contains an example of how to wire your app for use with [`remote-pdb`](https://pypi.org/project/remote-pdb/). For more information on using remote debuggers with your Tilt setup, check out [our guide to Python debuggers](https://docs.tilt.dev/debuggers_python.html).
4 |
5 | To see `remote-pdb` in action:
6 |
7 | 1. Call `tilt up` from this directory
8 | 2. Hit `localhost:8000`; the request will hang because the app hit a breakpoint. You'll know that the debugger is live and ready for connections when you see the following in the logs:
9 | ```
10 | CRITICAL:root:RemotePdb session open at 127.0.0.1:5555, waiting for connection …
11 | RemotePdb session open at 127.0.0.1:5555, waiting for connection …
12 | ```
13 | 3. In a separate terminal window, open a TCP connection to `localhost:5555`, e.g. via Netcat: `nc 127.0.0.1 5555`
14 | * The [remote-pdb guide](https://pypi.org/project/remote-pdb/) has some other connection options, if you prefer.
15 | 4. Congrats, you've accessed the debugger! Poke around and inspect the system state. Type `c(ontinue)` to resume execution.
16 |
--------------------------------------------------------------------------------
/debugger-examples/remote-pdb/Tiltfile:
--------------------------------------------------------------------------------
1 | # -*- mode: Python -*
2 |
3 | k8s_yaml('kubernetes.yaml')
4 |
5 | docker_build('example-python-image', '.',
6 | live_update=[
7 | sync('.', '/app'),
8 | run('cd /app && pip install -r requirements.txt',
9 | trigger='./requirements.txt'),
10 | ])
11 |
12 | k8s_resource('example-python',
13 | port_forwards=[
14 | 8000, # app
15 | 5555, # debugger
16 | ])
17 |
--------------------------------------------------------------------------------
/debugger-examples/remote-pdb/app.py:
--------------------------------------------------------------------------------
1 | from random import choice
2 |
3 | from flask import Flask, render_template
4 | app = Flask(__name__)
5 |
6 | CHOICES = ["✨", "🎉", "🤖", "🐢", "👍", "🐙", "👋", "👀"]
7 |
8 |
9 | @app.route("/")
10 | def serve():
11 | emoji = choice(CHOICES)
12 |
13 | from remote_pdb import RemotePdb; RemotePdb('127.0.0.1', 5555).set_trace()
14 |
15 | return render_template("index.html", emoji=emoji)
16 |
17 |
18 | if __name__ == "__main__":
19 | app.run(port=8000)
20 |
--------------------------------------------------------------------------------
/debugger-examples/remote-pdb/kubernetes.yaml:
--------------------------------------------------------------------------------
1 | apiVersion: apps/v1
2 | kind: Deployment
3 | metadata:
4 | name: example-python
5 | labels:
6 | app: example-python
7 | spec:
8 | selector:
9 | matchLabels:
10 | app: example-python
11 | template:
12 | metadata:
13 | labels:
14 | app: example-python
15 | spec:
16 | containers:
17 | - name: example-python
18 | image: example-python-image
19 | ports:
20 | - containerPort: 5555 # for debugger use
21 | - containerPort: 8000
22 |
--------------------------------------------------------------------------------
/debugger-examples/remote-pdb/requirements.txt:
--------------------------------------------------------------------------------
1 | Flask==3.0.0
2 | remote-pdb==2.0.0
3 |
--------------------------------------------------------------------------------
/debugger-examples/remote-pdb/static/pets.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/tilt-dev/tilt-example-python/363a39cdc040e0a9c6ce75a2197474094bd0237e/debugger-examples/remote-pdb/static/pets.png
--------------------------------------------------------------------------------
/debugger-examples/remote-pdb/templates/index.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |

6 |
Hello debugger!
7 |
Picked you a random emoji: {{emoji}}
8 |
9 |
10 |
11 |
--------------------------------------------------------------------------------
/debugger-examples/web-pdb/Dockerfile:
--------------------------------------------------------------------------------
1 | FROM python:3-alpine
2 |
3 | WORKDIR /app
4 |
5 | ADD requirements.txt .
6 | RUN pip install -r requirements.txt
7 |
8 | ADD . .
9 |
10 | ENTRYPOINT ["python", "/app/app.py"]
11 |
--------------------------------------------------------------------------------
/debugger-examples/web-pdb/README.md:
--------------------------------------------------------------------------------
1 | # Run with Tilt, Debug with [`web-pdb`](https://github.com/romanvm/python-web-pdb)
2 |
3 | This directory contains an example of how to wire your app for use with [`web-pdb`](https://github.com/romanvm/python-web-pdb). For more information on using remote debuggers with your Tilt setup, check out [our guide to Python debuggers](https://docs.tilt.dev/debuggers_python.html).
4 |
5 | *Note: for best results, use web-pdb >= v1.5.3*
6 |
7 | To see `web-pdb` in action:
8 |
9 | 1. Call `tilt up` from this directory
10 | 2. Hit `localhost:8000`; the request will hang because the app hit a breakpoint. You'll know that the debugger is live and ready for connections when you see the following in the logs:
11 | ```
12 | CRITICAL - Web-PDB: starting web-server on [podname]:5555...
13 | ```
14 | 3. In a new tab in your web browser, navigate to `localhost:5555`
15 | 4. Congrats, you've accessed the debugger! Poke around and inspect the system state. Type `c(ontinue)` to resume execution.
16 |
--------------------------------------------------------------------------------
/debugger-examples/web-pdb/Tiltfile:
--------------------------------------------------------------------------------
1 | # -*- mode: Python -*
2 |
3 | k8s_yaml('kubernetes.yaml')
4 |
5 | docker_build('example-python-image', '.',
6 | live_update=[
7 | sync('.', '/app'),
8 | run('cd /app && pip install -r requirements.txt',
9 | trigger='./requirements.txt'),
10 | ])
11 |
12 | k8s_resource('example-python',
13 | port_forwards=[
14 | 8000, # app
15 | 5555, # debugger
16 | ])
17 |
--------------------------------------------------------------------------------
/debugger-examples/web-pdb/app.py:
--------------------------------------------------------------------------------
1 | from random import choice
2 |
3 | from flask import Flask, render_template
4 | app = Flask(__name__)
5 |
6 | CHOICES = ["✨", "🎉", "🤖", "🐢", "👍", "🐙", "👋", "👀"]
7 |
8 |
9 | @app.route("/")
10 | def serve():
11 | emoji = choice(CHOICES)
12 |
13 | import web_pdb; web_pdb.set_trace()
14 |
15 | return render_template("index.html", emoji=emoji)
16 |
17 |
18 | if __name__ == "__main__":
19 | app.run(port=8000)
20 |
--------------------------------------------------------------------------------
/debugger-examples/web-pdb/kubernetes.yaml:
--------------------------------------------------------------------------------
1 | apiVersion: apps/v1
2 | kind: Deployment
3 | metadata:
4 | name: example-python
5 | labels:
6 | app: example-python
7 | spec:
8 | selector:
9 | matchLabels:
10 | app: example-python
11 | template:
12 | metadata:
13 | labels:
14 | app: example-python
15 | spec:
16 | containers:
17 | - name: example-python
18 | image: example-python-image
19 | ports:
20 | - containerPort: 5555 # for debugger use
21 | - containerPort: 8000
22 |
--------------------------------------------------------------------------------
/debugger-examples/web-pdb/requirements.txt:
--------------------------------------------------------------------------------
1 | Flask==3.0.0
2 | web-pdb==1.5.3
3 |
--------------------------------------------------------------------------------
/debugger-examples/web-pdb/static/pets.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/tilt-dev/tilt-example-python/363a39cdc040e0a9c6ce75a2197474094bd0237e/debugger-examples/web-pdb/static/pets.png
--------------------------------------------------------------------------------
/debugger-examples/web-pdb/templates/index.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |

6 |
Hello debugger!
7 |
Picked you a random emoji: {{emoji}}
8 |
9 |
10 |
11 |
--------------------------------------------------------------------------------
/test/test.ps1:
--------------------------------------------------------------------------------
1 |
2 | echo "Testing 0-base"
3 | tilt ci --file 0-base/Tiltfile
4 | if (!$?) {
5 | throw "failed"
6 | }
7 | tilt down --file 0-base/Tiltfile
8 |
9 | echo "Testing 1-measured"
10 | tilt ci --file 1-measured/Tiltfile
11 | if (!$?) {
12 | throw "failed"
13 | }
14 | tilt down --file 1-measured/Tiltfile
15 |
16 | echo "Testing 2-optimize-dockerfile"
17 | tilt ci --file 2-optimize-dockerfile/Tiltfile
18 | if (!$?) {
19 | throw "failed"
20 | }
21 | tilt down --file 2-optimize-dockerfile/Tiltfile
22 |
23 | echo "Testing 3-recommended"
24 | tilt ci --file 3-recommended/Tiltfile
25 | if (!$?) {
26 | throw "failed"
27 | }
28 | tilt down --file 3-recommended/Tiltfile
29 |
--------------------------------------------------------------------------------
/test/test.sh:
--------------------------------------------------------------------------------
1 | #!/bin/bash
2 |
3 | set -ex
4 |
5 | # cd to the root of the repo.
6 | cd $(dirname $(dirname $0))
7 |
8 | echo "Testing 0-base"
9 | tilt ci --file 0-base/Tiltfile
10 | tilt down --file 0-base/Tiltfile
11 |
12 | echo "Testing 1-measured"
13 | tilt ci --file 1-measured/Tiltfile
14 | tilt down --file 1-measured/Tiltfile
15 |
16 | echo "Testing 2-optimize-dockerfile"
17 | tilt ci --file 2-optimize-dockerfile/Tiltfile
18 | tilt down --file 2-optimize-dockerfile/Tiltfile
19 |
20 | echo "Testing 3-recommended"
21 | tilt ci --file 3-recommended/Tiltfile
22 | tilt down --file 3-recommended/Tiltfile
23 |
--------------------------------------------------------------------------------