dbrownell-toolsdirectory 0.14.1

Creates functionality to manipulate the shell in support of tools defined within a tools directory.

Project:

Package:

Development:

Contents

• Overview
• Installation
• Development
• Additional Information
• License

Overview

dbrownell_ToolsDirectory is a Python utility that automates the setup of tool environments by generating shell initialization scripts. It scans a directory structure containing organized tools and their versions, then creates either Bash or Batch scripts that add these tools to your system path and configure their environment variables. This tool is handy for managing multiple tool versions across different operating systems and architectures, allowing you to maintain a centralized directory of tools and automatically generate the necessary shell commands to make them available in your terminal environment.

How to use dbrownell_ToolsDirectory

There are two ways to use dbrownell_ToolsDirectory: through convenience activation scripts or by using the CLI directly.

1. Clone the repository locally:

   git clone https://github.com/davidbrownell/dbrownell_ToolsDirectory
   

2. Run the activation script for your shell:

   For Bash (Linux/macOS):

   . <repository location>/src/dbrownell_ToolsDirectory/Scripts/activate.sh <tools directory>
   

   For Batch (Windows):

   <repository location>\src\dbrownell_ToolsDirectory\Scripts\activate.bat <tools directory>
   

3. All tools and environment variables from <tools directory> will be added to your environment.

Example

Hard Drive

/Tools/
├── Tool1/
│   └── Tool1.env
├── Tool2/
│   └── bin/
└── Tool3/
    ├── v1.2.3/
    └── v4.5.6/

Tool1.env

FOO=BAR
FILENAME=./filename

After Activation

# Added by traversing the directory hierarchy
PATH=${PATH}:/Tools/Tool1:/Tools/Tool2/bin:/Tools/Tool3/v4.5.6

# Added through .env files within the directory hierarchy
FOO=BAR
FILENAME=/Tools/Tool1/filename

Installation

Installation Method	Command
Via uv	uv add dbrownell_ToolsDirectory
Via pip	pip install dbrownell_ToolsDirectory

Development

Please visit Contributing and Development for information on contributing to this project.

Additional Information

Additional information can be found at these locations.

Title	Document	Description
Code of Conduct	CODE_OF_CONDUCT.md	Information about the norms, rules, and responsibilities we adhere to when participating in this open source community.
Contributing	CONTRIBUTING.md	Information about contributing to this project.
Development	DEVELOPMENT.md	Information about development activities involved in making changes to this project.
Governance	GOVERNANCE.md	Information about how this project is governed.
Maintainers	MAINTAINERS.md	Information about individuals who maintain this project.
Security	SECURITY.md	Information about how to privately report security issues associated with this project.

License

dbrownell_ToolsDirectory is licensed under the MIT license.