Skip to content

Commit 98c4e8d

Browse files
kevchu3kevchu3
committed
Initial commit
0 parents  commit 98c4e8d

File tree

15 files changed

+789
-0
lines changed

15 files changed

+789
-0
lines changed

‎LICENSE‎

Lines changed: 201 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,201 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION
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.

‎README.md‎

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
# 🚀 **Module 2: Introduction to DevSpaces**
2+
3+
**Technology Stack:**
4+
5+
- Python
6+
- DevSpaces
7+
8+
---
9+
10+
## 🎯 **Scenario**
11+
12+
Inside your workspace is a very simple Python Application built using Flask. The application returns a “hello world” based on the language you choose for it.
13+
14+
The country is based on a 2-letter country code.
15+
For example, `countrycode=IT` will output “ciao mondo” (IT is for Italy).
16+
17+
You can find all the mappings in the `translate.json` file, located in your `resources` folder.
18+
There is also a timestamp after the “hello world” message.
19+
20+
---
21+
22+
## 🐾 **Guided Walkthrough**
23+
24+
The application has some problems that we would like you to fix:
25+
26+
1. Run `pip install -r requirements.txt` to install the necessary dependencies
27+
2. Your tests will not run with pytest because your environment variables are not set, please set the 3 items below
28+
- 2.1. `FLASK_APP=app.py`
29+
- 2.2. `FLASK_ENV=development`
30+
- 2.3. `PYTHONPATH=.`
31+
3. Format the hello timestamp to use Eastern Standard Time (New York time)
32+
4. Format the hello timestamp to display as {HH:MM MM/DD/YYYY}
33+
5. Write a test case that tests both the timezone and the new date format
34+
6. In `/routes/main.py` create a new route that will route to `/api/query`
35+
- 6.1. The request should be a GET method
36+
- 6.2. Append a query string to take an argument for the country code (e.g `/api/query?countryCode=en`) and set the API to return the correct greeting based on the country used in the querystring
37+
7. Final Compilation
38+
39+
```python
40+
In a new terminal, run the App in flask (not python), use these settings
41+
flask run --host=0.0.0.0 --port=8080
42+
43+
Open a Second terminal - and run pytest to ensure all test cases are passing
44+
./pytest
45+
```
46+
47+
---
48+
49+
## 🧩 **Challenge**
50+
51+
- [ ] Add an /api/magic8 endpoint that returns a random country code (like a magic 8-ball) and returns a random hello world greeting
52+
- [ ] Write additional tests for /api/query and /api/magic8
53+
- [ ] Add an additional end point for /api/query which functions the same but uses POST instead, use curl to test.
54+
- [ ] Attach a simple stylesheet that will change the background color to blue
55+
- [ ] Put the hello world inside a HTML `<blockquote>` tag - add color in the stylesheet to emphasize the blockquote area - (use render_template)
56+
- [ ] Your styles.css can be kept in a new folder named /static (you can create)
57+
- [ ] Your html files can be kept in a new folder named /templates (you can create)
58+
59+
---
60+
61+
## 🥚 **Easter Eggs!**
62+
63+
- [ ] There is an easter egg in the code
64+
- Be thorough! Look through the code..
65+
- Find and Solve the Golden Egg (it’s a 2 step process)
66+
67+
---
68+
69+
## ✅ **Key Takeaways**
70+
71+
- First look at Dev Spaces
72+
- Familiarized yourself with setting up a Python App in Dev Spaces
73+
- Took advantage of ‘quick build’ python apps in a container
74+
- Using environment variables in your application
75+
- Used your first OpenShift Service / Route!

‎app.py‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
from flask import Flask
2+
from dotenv import load_dotenv
3+
import os
4+
5+
# Load environment variables
6+
load_dotenv()
7+
8+
app = Flask(__name__)
9+
10+
# Testing purposes
11+
from routes.main import get_translation
12+
from routes.main import get_current_datetime
13+
14+
# Register routes
15+
from routes.main import main as main_blueprint
16+
17+
app.register_blueprint(main_blueprint)

‎catalog-info.yaml‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
apiVersion: backstage.io/v1alpha1
2+
kind: Component
3+
metadata:
4+
name: workshop-module2-python
5+
title: Module 2 - Python
6+
description: |
7+
Introduction to Red Hat Dev Spaces
8+
annotations:
9+
backstage.io/techdocs-ref: dir:.
10+
tags:
11+
- devspaces
12+
links:
13+
- url: https://devspaces.apps.<cluster-domain>/#https://gitlab.apps.<cluster-domain>/developers/developer-experience-workshop-module2-python.git
14+
title: "Launch from Dev Spaces"
15+
icon: web
16+
spec:
17+
type: module
18+
lifecycle: production
19+
owner: group:default/cluster-admins
20+
gitlab:
21+
remoteUrl: https://gitlab.apps.<cluster-domain>/developers/developer-experience-workshop-module2-python.git
22+
owner: developers
23+
repository: workshop-repository
24+
branch: main
25+
subcomponentOf: component:default/workshop-repository
26+
dependsOn:
27+
- component:default/workshop-agenda

‎devfile.yaml‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
schemaVersion: 2.2.2
2+
metadata:
3+
name: workshop-module2-python
4+
description: module2
5+
displayName: devfile
6+
7+
components:
8+
- container:
9+
args:
10+
- tail
11+
- -f
12+
- /dev/null
13+
endpoints:
14+
- name: https-python
15+
protocol: https
16+
targetPort: 5000
17+
- exposure: none
18+
name: debug
19+
targetPort: 5858
20+
env:
21+
- name: ADMIN
22+
value: "http://opensesame.shared-config.svc.cluster.local:3000/opensesame"
23+
- name: DEBUG_PORT
24+
value: "5858"
25+
image: image-registry.openshift-image-registry.svc.cluster.local:5000/openshift/devspaces-dotnet-python:latest
26+
mountSources: true
27+
name: py
28+
29+
commands:
30+
- exec:
31+
commandLine: pip install -r requirements.txt
32+
component: py
33+
group:
34+
isDefault: true
35+
kind: build
36+
workingDir: ${PROJECT_SOURCE}
37+
id: pip-install-requirements
38+
- exec:
39+
commandLine: flask run --host=0.0.0.0 --port=5000
40+
component: py
41+
group:
42+
isDefault: true
43+
kind: run
44+
workingDir: ${PROJECT_SOURCE}
45+
id: run-python

0 commit comments

Comments
 (0)