Skip to content

Commit 3348287

Browse files
Small documentation tweaks resolving #1117 and #1116 (#1118)
* Updated link to point to actual discourse instead of an older discourse link Signed-off-by: Brandon Biggs <brandon.biggs@inl.gov> * Made sure title underline characters match the length of the title * Readded my changes from #1117 and fixed a typo along with the title underline characters matching Signed-off-by: Brandon Biggs <brandon.biggs@inl.gov> * Fixed a space --------- Signed-off-by: Brandon Biggs <brandon.biggs@inl.gov> Co-authored-by: Brandon Biggs <brandon.biggs@inl.gov>
1 parent 10cb1ef commit 3348287

2 files changed

Lines changed: 26 additions & 6 deletions

File tree

source/install-ihpc-apps.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ template and modifying it to work at your center. See
88
:ref:`app-development-tutorials-interactive-apps-add-jupyter` to install
99
Jupyter.
1010

11-
If you have developed an app and would like to contribute it to the community, please post a description and link to the app to https://discourse.osc.edu/c/open-ondemand.
11+
If you have developed an app and would like to contribute it to the community, please post a description and link to the app to https://discourse.openondemand.org.
1212
In order to submit the code of an interactive app that you developed to the GitHub repository, it should be available on the developer’s GitHub and well commented. The comments need to include, but not limited to, mentioning if there are parts of the app that are site-specific. Also, the following files must be included:
1313

1414
- LICENSE file - the license should be open source. If you are not sure what to choose, OnDemand uses MIT License.

source/tutorials/tutorials-passenger-apps/python-starter-app.rst

Lines changed: 25 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -41,8 +41,16 @@ in the ``Develop`` menu of your OnDemand installation.
4141
There you should see this application at the top of the list. Clicking
4242
``Launch Python Hello World`` will launch this application in a new tab.
4343

44-
When the new tab opens you should see a blank page with the text ``Hello World``
45-
with some extra text about the system. This is your new `Python`_ application!
44+
When the new tab opens you should see a mostly blank page with the something
45+
like the following:
46+
47+
.. code:: shell
48+
49+
Hello World from Open OnDemand (Python WSGI)!
50+
3.9.21 (main, Dec 5 2024, 00:00:00)
51+
[GCC 11.5.0 20240719 (Red Hat 11.5.0-2)]
52+
53+
This is your new `Python`_ application!
4654

4755

4856
Application using Flask and a virtual environment
@@ -66,21 +74,33 @@ to create one. This will create a subdirectory ``python-hello-world`` with a
6674
6775
python3 -m venv python-hello-world
6876
69-
Now, let's create the ``requriements.txt`` file where we'll add the application's
77+
You can also use other Python virtual environment managers such as ``uv``. If you
78+
have ``uv`` installed, the following command will create a virtual environment
79+
subdirectory ``.venv``.
80+
81+
.. code:: shell
82+
uv venv
83+
84+
Install required packages
85+
`````````````````````````
86+
87+
Now, let's create the ``requirements.txt`` file where we'll add the application's
7088
required libraries. Here, we're only adding ``flask`` of any version.
7189

7290
.. code:: text
7391
7492
# requirements.txt
7593
flask
7694
95+
Activate environment and install requirements.txt
96+
7797
.. code:: shell
7898
7999
source python-hello-world/bin/activate
80100
python3 -m pip install -r requirements.txt
81101
82-
Create the python files
83-
```````````````````````
102+
Create application files
103+
````````````````````````
84104

85105
In the basic example above, the entire implementation is held within a ``passenger_wsgi.py``.
86106
This project is more advanced, so it will include two files. ``passenger_wsgi.py`` and

0 commit comments

Comments
 (0)