Installation

Prerequisites

• Python 3.11.9
• A dev-tool key (Dev Tools Key) from the BitWarden vault
• pyproject.toml in the root directory of your project
• development.env in the root directory of your project
• requirements.txt in the root directory of your project

Installation

Personal Access Token (PAT)

In order to build and update this repository, you will need a Personal Access Token (PAT):

1. Get the PAT from BitWarden; it is called Dev Tools Key

2. Copy the token and replace "YOUR_TOKEN_HERE" in the command below with your token

3. Run the following command in a command prompt:

mkdir "%USERPROFILE%\stratus" 2>NUL & echo YOUR_TOKEN_HERE > "%USERPROFILE%\stratus\dev_tool_github_pat"

Install the dev_tool

1. Download the latest release:
   • Navigate to the latest release
   • Download dev_tool_windows_x.x.xx.exe and cli_windows_x.x.xx.exe
2. Setup the launcher:
   • Rename dev_tool_windows_x.x.xx.exe to dev_tool.exe
   • Move it to %USERPROFILE%/stratus/
3. Setup the CLI:
   • Rename cli_windows_x.x.xx.exe to cli.exe
   • Move it to %USERPROFILE%/stratus/
4. Add the stratus directory to the Windows PATH:
   • Go to the Start Menu, type "environment variables" and select "Edit environment variables for your account"
   • Under the "User variables for <Account Name>", find the "Path" variable and select "Edit"
   • Click "New" and enter: %USERPROFILE%\stratus
   • Press "OK" and close the window
5. Close or restart your IDE or text editor
6. Open a terminal in the project root, and type "dev_tool.exe" in the terminal to use it

Updating

Update dev_tool.exe (Manually)

1. Download the latest release
2. Close PyCharm and any running instances of the dev-tool
3. Replace the old dev_tool.exe in the %USERPROFILE%\stratus directory

Update cli.exe

Automatically

1. Open dev_tool.exe
2. Navigate to the System tab
3. Select the Update the dev_tool option

Manually

1. Download the latest release
2. Close all running instances
3. Delete older executables from %USERPROFILE%/stratus
4. Rename the new file to cli.exe and place it in %USERPROFILE%/stratus

Configuration

pyproject.toml

Create a pyproject.toml file in the root directory of your project with appropriate configuration settings for your project. See the documentation for details.

development.env

Create a development.env file in the root directory of your project with the necessary environment variables. An up-to-date list can be found in the BitWarden vault.

Development

To build the tool:

cls && build_dev_tool.bat