Skip to content

Commit

Permalink
specify supported python versions in the docs
Browse files Browse the repository at this point in the history
  • Loading branch information
karangattu committed Mar 20, 2024
1 parent 64d3c04 commit 82adebe
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 10 deletions.
12 changes: 8 additions & 4 deletions docs/Fieldsurveys.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ If you want to play around with the app before setting up one for your case, fee

## Prerequisites

- Python `3.8` or higher\
- Python `3.8` , `3.9`, `3.10` or `3.11` *(`3.12` is not tested and might not work as expected)*\

::: {.callout-tip appearance="simple"}
## Check python version on your machine
Expand Down Expand Up @@ -213,10 +213,14 @@ If running `fieldsurveys` on the ***Windows Powershell***/***Command Prompt*** t
fieldsurveys : The term 'fieldsurveys' is not recognized as the name of a cmdlet, function, script file, or operable
program.
Check the spelling of the name, or if a path was included, verify that the path is correct and try again.
OR
'fieldsurveys' is not a recognized as an internal or external command, operable program or batch file.
```
You might need to add Python scripts location to the PATH.\
**Locate the Scripts Directory**: First, you need to find the directory where your Python scripts are located. By default, this directory is usually **`C:\Users\username\AppData\Local\Packages\PythonSoftwareFoundation.Python.3.XX_xyz\LocalCache\local-packages\Python3xx\Scripts`** on Windows, where **`XX`** represents the Python version number.
**Locate the Scripts Directory**: First, you need to find the directory where your Python scripts are located. By default, this directory is usually **`C:\Users\username\AppData\Local\Programs\Python3XX\Scripts`** on Windows, where **`XX`** represents the Python version number.
1. **Open System Properties**: Right-click on the "This PC" or "My Computer" icon on your desktop or File Explorer and select "Properties". Alternatively, you can search for "System" in the Start menu and select "System" from the search results.
Expand All @@ -226,11 +230,11 @@ You might need to add Python scripts location to the PATH.\
4. **Edit System Variables**: In the Environment Variables window, under the "System variables" section, find the **`Path`** variable and select it. Then click on the "Edit..." button.
5. **Add Python Scripts Directory**: In the Edit Environment Variable window, click on the "New" button and then paste the path to the directory where your Python scripts are located. For example, if your scripts are in **`C:\Users\username\AppData\Local\Packages\PythonSoftwareFoundation.Python.3.XX_xyz\LocalCache\local-packages\Python3xx\Scripts`**, you would add **`C:\Users\username\AppData\Local\Packages\PythonSoftwareFoundation.Python.3.XX_xyz\LocalCache\local-packages\Python3xx\Scripts`** to the list of paths.
5. **Add Python Scripts Directory**: In the Edit Environment Variable window, click on the "New" button and then paste the path to the directory where your Python scripts are located. For example, if your scripts are in **`C:\Users\username\AppData\Local\Programs\Python3XX\Scripts`**, you would add **`C:\Users\username\AppData\Local\Programs\Python3XX\Scripts`** to the list of paths.
6. **Apply Changes**: Click "OK" to close all the windows and apply the changes.
7. **Verify**: Open a new command prompt window and type the name of one of your Python scripts (without the **`.py`** extension). If the script executes without errors, it means the path has been successfully added to the system PATH.
7. **Verify**: Open a new command prompt window and type the name of one of your Python scripts (i.e. \`fieldsurveys\`). If the script executes without errors, it means the path has been successfully added to the system PATH.
:::
## Deploying the app on the web (so it can be accessed from anywhere)
Expand Down
14 changes: 9 additions & 5 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -166,7 +166,7 @@ <h2 class="anchored" data-anchor-id="can-i-see-a-demo-of-the-app">Can I see a de
<section id="prerequisites" class="level2">
<h2 class="anchored" data-anchor-id="prerequisites">Prerequisites</h2>
<ul>
<li><p>Python <code>3.8</code> or higher<br>
<li><p>Python <code>3.8</code> , <code>3.9</code>, <code>3.10</code> or <code>3.11</code> <em>(<code>3.12</code> is not tested and might not work as expected)</em><br>
</p>
<div class="callout callout-style-simple callout-tip callout-titled">
<div class="callout-header d-flex align-content-center">
Expand Down Expand Up @@ -359,17 +359,21 @@ <h2 class="anchored" data-anchor-id="run-the-app-on-your-machine">Run the app on
<p>If running <code>fieldsurveys</code> on the <strong><em>Windows Powershell</em></strong>/<strong><em>Command Prompt</em></strong> throws an error stating</p>
<pre><code>fieldsurveys : The term 'fieldsurveys' is not recognized as the name of a cmdlet, function, script file, or operable
program.
Check the spelling of the name, or if a path was included, verify that the path is correct and try again.</code></pre>
Check the spelling of the name, or if a path was included, verify that the path is correct and try again.

OR

'fieldsurveys' is not a recognized as an internal or external command, operable program or batch file.</code></pre>
<p>You might need to add Python scripts location to the PATH.<br>
<strong>Locate the Scripts Directory</strong>: First, you need to find the directory where your Python scripts are located. By default, this directory is usually <strong><code>C:\Users\username\AppData\Local\Packages\PythonSoftwareFoundation.Python.3.XX_xyz\LocalCache\local-packages\Python3xx\Scripts</code></strong> on Windows, where <strong><code>XX</code></strong> represents the Python version number.</p>
<strong>Locate the Scripts Directory</strong>: First, you need to find the directory where your Python scripts are located. By default, this directory is usually <strong><code>C:\Users\username\AppData\Local\Programs\Python3XX\Scripts</code></strong> on Windows, where <strong><code>XX</code></strong> represents the Python version number.</p>
<ol type="1">
<li><p><strong>Open System Properties</strong>: Right-click on the “This PC” or “My Computer” icon on your desktop or File Explorer and select “Properties”. Alternatively, you can search for “System” in the Start menu and select “System” from the search results.</p></li>
<li><p><strong>Open Advanced System Settings</strong>: In the System window, click on “Advanced system settings” on the left side. This will open the System Properties window.</p></li>
<li><p><strong>Open Environment Variables</strong>: In the System Properties window, click on the “Environment Variables…” button.</p></li>
<li><p><strong>Edit System Variables</strong>: In the Environment Variables window, under the “System variables” section, find the <strong><code>Path</code></strong> variable and select it. Then click on the “Edit…” button.</p></li>
<li><p><strong>Add Python Scripts Directory</strong>: In the Edit Environment Variable window, click on the “New” button and then paste the path to the directory where your Python scripts are located. For example, if your scripts are in <strong><code>C:\Users\username\AppData\Local\Packages\PythonSoftwareFoundation.Python.3.XX_xyz\LocalCache\local-packages\Python3xx\Scripts</code></strong>, you would add <strong><code>C:\Users\username\AppData\Local\Packages\PythonSoftwareFoundation.Python.3.XX_xyz\LocalCache\local-packages\Python3xx\Scripts</code></strong> to the list of paths.</p></li>
<li><p><strong>Add Python Scripts Directory</strong>: In the Edit Environment Variable window, click on the “New” button and then paste the path to the directory where your Python scripts are located. For example, if your scripts are in <strong><code>C:\Users\username\AppData\Local\Programs\Python3XX\Scripts</code></strong>, you would add <strong><code>C:\Users\username\AppData\Local\Programs\Python3XX\Scripts</code></strong> to the list of paths.</p></li>
<li><p><strong>Apply Changes</strong>: Click “OK” to close all the windows and apply the changes.</p></li>
<li><p><strong>Verify</strong>: Open a new command prompt window and type the name of one of your Python scripts (without the <strong><code>.py</code></strong> extension). If the script executes without errors, it means the path has been successfully added to the system PATH.</p></li>
<li><p><strong>Verify</strong>: Open a new command prompt window and type the name of one of your Python scripts (i.e.&nbsp;`fieldsurveys`). If the script executes without errors, it means the path has been successfully added to the system PATH.</p></li>
</ol>
</div>
</div>
Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

setup(
name="fieldsurveys",
version="0.1.36",
version="0.1.37",
author="Karan Gathani",
author_email="[email protected]",
packages=find_packages(),
Expand Down

0 comments on commit 82adebe

Please sign in to comment.