sso-config-generator 0.2.0__tar.gz

sso_config_generator-0.2.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 easytocloud
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

sso_config_generator-0.2.0/PKG-INFO

@@ -0,0 +1,243 @@
+Metadata-Version: 2.2
+Name: sso-config-generator
+Version: 0.2.0
+Summary: Python tool for generating AWS SSO configuration and directory structure
+Author-email: easytocloud <info@easytocloud.com>
+License: MIT License
+        
+        Copyright (c) 2024 easytocloud
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+        
+Project-URL: Homepage, https://github.com/easytocloud/sso-config-generator
+Project-URL: Repository, https://github.com/easytocloud/sso-config-generator
+Project-URL: Issues, https://github.com/easytocloud/sso-config-generator/issues
+Project-URL: Changelog, https://github.com/easytocloud/sso-config-generator/blob/main/CHANGELOG.md
+Keywords: aws,sso,config,generator,cli,aws-cli
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Topic :: Software Development :: Build Tools
+Classifier: Topic :: System :: Systems Administration
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: boto3>=1.34.0
+Requires-Dist: click>=8.1.0
+Requires-Dist: pyyaml>=6.0.1
+
+# SSO Config Generator
+
+A Python CLI tool for generating AWS SSO configuration and directory structures.
+
+## Overview
+
+SSO Config Generator is a standalone Python tool that simplifies AWS SSO configuration management by:
+
+1. Generating properly configured AWS CLI config files
+2. Creating directory structures that mirror your AWS Organization
+3. Setting up environment files for easy role switching using `direnv`
+
+## Installation
+
+You can install SSO Config Generator using pip:
+
+```bash
+pip install sso-config-generator
+```
+
+### Prerequisites
+
+- Python 3.8 or higher
+- AWS CLI v2 configured with:
+  - Default region set in `~/.aws/config` or via `AWS_DEFAULT_REGION` environment variable
+  - AWS SSO configured via `aws configure sso`
+- `direnv` (optional, for automatic profile switching)
+
+### AWS Configuration
+
+Before using the tool, ensure you have:
+
+1. Set your AWS region:
+   ```bash
+   # Either in ~/.aws/config
+   [default]
+   region = eu-west-1
+
+   # Or via environment variable
+   export AWS_DEFAULT_REGION=eu-west-1
+   ```
+
+2. Configure AWS SSO:
+   ```bash
+   # Configure SSO
+   aws configure sso
+   # Follow the prompts to enter:
+   # - SSO start URL (e.g., https://your-domain.awsapps.com/start)
+   # - SSO Region
+   # - SSO registration scopes (accept default)
+   
+   # Login to SSO to create credentials
+   aws sso login
+   ```
+
+### Troubleshooting
+
+1. "Error: You must specify a region"
+   - Set AWS_DEFAULT_REGION environment variable
+   - Or configure default region in ~/.aws/config
+
+2. "Unable to locate credentials"
+   - Run `aws sso login` to refresh your SSO credentials
+   - Ensure you've completed AWS SSO configuration with `aws configure sso`
+   - Check if your SSO session has expired (sessions typically last 8 hours)
+
+3. "SSO session is expired"
+   - Run `aws sso login` to start a new session
+
+## Usage
+
+### Basic Usage
+
+Simply run:
+
+```bash
+uvx sso-config-generator
+```
+
+This will:
+- Create/update your AWS CLI config file (`~/.aws/config`)
+- Generate a directory structure in the current directory + sso-name
+- Create `.envrc` files in each account directory with AdministratorAccess role
+- Use OU structure for directory organization (cached for performance)
+
+The tool caches OU structure information in `~/.aws/.ou` to improve performance. When the cache exists, it will be used automatically with a notification. To rebuild the cache:
+
+```bash
+uvx sso-config-generator --rebuild-cache
+```
+
+### Command Options
+
+```
+Usage: sso-config-generator [OPTIONS]
+
+Options:
+  --create-directories/--no-create-directories  Create a directory for each account (default: True)
+  --use-ou-structure/--no-use-ou-structure     Create directories for each OU (default: True)
+  --developer-role-name NAME                   Role name to use for .envrc files (default: AdministratorAccess)
+  --rebuild-cache                              Force rebuild of OU structure cache
+  --sso-name NAME                              Use specified SSO name instead of extracting from SSO start URL
+  --create-repos-md                            Create repos.md files in each account directory
+  --skip-sso-name                              Do not create a directory for the SSO name (default: False)
+  --unified-root PATH                          Directory where account directories are created
+                                               (default: current directory)
+                                               If current directory is named "environment", SSO name is
+                                               automatically skipped
+  --validate                                   Validate current AWS SSO configuration instead of generating
+  --help                                       Show this message and exit
+  --version                                    Show the version and exit
+```
+
+### Examples
+
+1. Basic config generation (uses defaults):
+```bash
+uvx sso-config-generator
+```
+
+2. Disable OU structure (flat account directories):
+```bash
+uvx sso-config-generator --no-use-ou-structure
+```
+
+3. Use different role for .envrc files:
+```bash
+uvx sso-config-generator --developer-role-name ReadOnlyAccess
+```
+
+4. Force rebuild of OU cache:
+```bash
+uvx sso-config-generator --rebuild-cache
+```
+
+5. Specify custom root directory:
+```bash
+uvx sso-config-generator --unified-root ~/aws-environments
+```
+
+6. Skip creating directories (config file only):
+```bash
+uvx sso-config-generator --no-create-directories
+```
+
+7. Working in an "environment" directory (automatic behavior):
+```bash
+# If your current directory is named 'environment'
+cd environment
+uvx sso-config-generator
+# This will automatically skip creating the SSO name directory
+```
+
+8. Validate existing configuration:
+```bash
+uvx sso-config-generator --validate
+```
+
+## Development
+
+### Setup Development Environment
+
+1. Clone the repository:
+```bash
+git clone https://github.com/easytocloud/sso-config-generator.git
+cd sso-config-generator
+```
+
+2. Create a virtual environment:
+```bash
+python -m venv venv
+source venv/bin/activate  # On Windows: venv\Scripts\activate
+```
+
+3. Install the package in development mode:
+```bash
+pip install -e .
+```
+
+### Common Development Tasks
+
+- Build the package: `pip install build && python -m build`
+- Run the tool: `uvx sso-config-generator`
+- Test changes: `./test_sso_config.sh`
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

sso_config_generator-0.2.0/README.md

@@ -0,0 +1,192 @@
+# SSO Config Generator
+
+A Python CLI tool for generating AWS SSO configuration and directory structures.
+
+## Overview
+
+SSO Config Generator is a standalone Python tool that simplifies AWS SSO configuration management by:
+
+1. Generating properly configured AWS CLI config files
+2. Creating directory structures that mirror your AWS Organization
+3. Setting up environment files for easy role switching using `direnv`
+
+## Installation
+
+You can install SSO Config Generator using pip:
+
+```bash
+pip install sso-config-generator
+```
+
+### Prerequisites
+
+- Python 3.8 or higher
+- AWS CLI v2 configured with:
+  - Default region set in `~/.aws/config` or via `AWS_DEFAULT_REGION` environment variable
+  - AWS SSO configured via `aws configure sso`
+- `direnv` (optional, for automatic profile switching)
+
+### AWS Configuration
+
+Before using the tool, ensure you have:
+
+1. Set your AWS region:
+   ```bash
+   # Either in ~/.aws/config
+   [default]
+   region = eu-west-1
+
+   # Or via environment variable
+   export AWS_DEFAULT_REGION=eu-west-1
+   ```
+
+2. Configure AWS SSO:
+   ```bash
+   # Configure SSO
+   aws configure sso
+   # Follow the prompts to enter:
+   # - SSO start URL (e.g., https://your-domain.awsapps.com/start)
+   # - SSO Region
+   # - SSO registration scopes (accept default)
+   
+   # Login to SSO to create credentials
+   aws sso login
+   ```
+
+### Troubleshooting
+
+1. "Error: You must specify a region"
+   - Set AWS_DEFAULT_REGION environment variable
+   - Or configure default region in ~/.aws/config
+
+2. "Unable to locate credentials"
+   - Run `aws sso login` to refresh your SSO credentials
+   - Ensure you've completed AWS SSO configuration with `aws configure sso`
+   - Check if your SSO session has expired (sessions typically last 8 hours)
+
+3. "SSO session is expired"
+   - Run `aws sso login` to start a new session
+
+## Usage
+
+### Basic Usage
+
+Simply run:
+
+```bash
+uvx sso-config-generator
+```
+
+This will:
+- Create/update your AWS CLI config file (`~/.aws/config`)
+- Generate a directory structure in the current directory + sso-name
+- Create `.envrc` files in each account directory with AdministratorAccess role
+- Use OU structure for directory organization (cached for performance)
+
+The tool caches OU structure information in `~/.aws/.ou` to improve performance. When the cache exists, it will be used automatically with a notification. To rebuild the cache:
+
+```bash
+uvx sso-config-generator --rebuild-cache
+```
+
+### Command Options
+
+```
+Usage: sso-config-generator [OPTIONS]
+
+Options:
+  --create-directories/--no-create-directories  Create a directory for each account (default: True)
+  --use-ou-structure/--no-use-ou-structure     Create directories for each OU (default: True)
+  --developer-role-name NAME                   Role name to use for .envrc files (default: AdministratorAccess)
+  --rebuild-cache                              Force rebuild of OU structure cache
+  --sso-name NAME                              Use specified SSO name instead of extracting from SSO start URL
+  --create-repos-md                            Create repos.md files in each account directory
+  --skip-sso-name                              Do not create a directory for the SSO name (default: False)
+  --unified-root PATH                          Directory where account directories are created
+                                               (default: current directory)
+                                               If current directory is named "environment", SSO name is
+                                               automatically skipped
+  --validate                                   Validate current AWS SSO configuration instead of generating
+  --help                                       Show this message and exit
+  --version                                    Show the version and exit
+```
+
+### Examples
+
+1. Basic config generation (uses defaults):
+```bash
+uvx sso-config-generator
+```
+
+2. Disable OU structure (flat account directories):
+```bash
+uvx sso-config-generator --no-use-ou-structure
+```
+
+3. Use different role for .envrc files:
+```bash
+uvx sso-config-generator --developer-role-name ReadOnlyAccess
+```
+
+4. Force rebuild of OU cache:
+```bash
+uvx sso-config-generator --rebuild-cache
+```
+
+5. Specify custom root directory:
+```bash
+uvx sso-config-generator --unified-root ~/aws-environments
+```
+
+6. Skip creating directories (config file only):
+```bash
+uvx sso-config-generator --no-create-directories
+```
+
+7. Working in an "environment" directory (automatic behavior):
+```bash
+# If your current directory is named 'environment'
+cd environment
+uvx sso-config-generator
+# This will automatically skip creating the SSO name directory
+```
+
+8. Validate existing configuration:
+```bash
+uvx sso-config-generator --validate
+```
+
+## Development
+
+### Setup Development Environment
+
+1. Clone the repository:
+```bash
+git clone https://github.com/easytocloud/sso-config-generator.git
+cd sso-config-generator
+```
+
+2. Create a virtual environment:
+```bash
+python -m venv venv
+source venv/bin/activate  # On Windows: venv\Scripts\activate
+```
+
+3. Install the package in development mode:
+```bash
+pip install -e .
+```
+
+### Common Development Tasks
+
+- Build the package: `pip install build && python -m build`
+- Run the tool: `uvx sso-config-generator`
+- Test changes: `./test_sso_config.sh`
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

sso_config_generator-0.2.0/pyproject.toml

@@ -0,0 +1,43 @@
+[project]
+name = "sso-config-generator"
+version = "0.2.0"
+description = "Python tool for generating AWS SSO configuration and directory structure"
+authors = [
+    {name = "easytocloud", email = "info@easytocloud.com"}
+]
+dependencies = [
+    "boto3>=1.34.0",
+    "click>=8.1.0",
+    "pyyaml>=6.0.1",
+]
+requires-python = ">=3.8"
+readme = "README.md"
+license = {file = "LICENSE"}
+keywords = ["aws", "sso", "config", "generator", "cli", "aws-cli"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Environment :: Console",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Topic :: Software Development :: Build Tools",
+    "Topic :: System :: Systems Administration",
+]
+
+[project.urls]
+Homepage = "https://github.com/easytocloud/sso-config-generator"
+Repository = "https://github.com/easytocloud/sso-config-generator"
+Issues = "https://github.com/easytocloud/sso-config-generator/issues"
+Changelog = "https://github.com/easytocloud/sso-config-generator/blob/main/CHANGELOG.md"
+
+[build-system]
+requires = ["setuptools>=45"]
+build-backend = "setuptools.build_meta"
+
+[project.scripts]
+sso-config-generator = "sso_config_generator.cli:cli"

sso_config_generator-0.2.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

sso_config_generator-0.2.0/src/sso_config_generator/__init__.py

@@ -0,0 +1,7 @@
+"""SSO Config Generator - Generate AWS SSO configuration and directory structures."""
+
+__version__ = "0.2.0"
+
+from .core import SSOConfigGenerator
+
+__all__ = ["SSOConfigGenerator", "__version__"]

sso_config_generator-0.2.0/src/sso_config_generator/cli.py

@@ -0,0 +1,97 @@
+import os
+import sys
+from typing import Optional
+import click
+from . import __version__
+from .core import SSOConfigGenerator
+
+@click.command()
+@click.version_option(version=__version__)
+@click.option('--create-directories/--no-create-directories', default=True, 
+              help='Create a directory for each account')
+@click.option('--use-ou-structure/--no-use-ou-structure', default=True, 
+              help='Create directories for each OU')
+@click.option('--developer-role-name', default="AdministratorAccess", 
+              help='Role name to use for .envrc files')
+@click.option('--rebuild-cache', is_flag=True, 
+              help='Force rebuild of OU structure cache')
+@click.option('--sso-name', 
+              help='Use specified SSO name instead of extracting from SSO start URL')
+@click.option('--create-repos-md', is_flag=True, 
+              help='Create repos.md files in each account directory')
+@click.option('--skip-sso-name', is_flag=True, 
+              help='Do not create a directory for the SSO name')
+@click.option('--unified-root', 
+              help='Directory where account directories are created (default: current directory). '
+                   'If current directory is named "environment", SSO name is automatically skipped.')
+@click.option('--validate', is_flag=True,
+              help='Validate current AWS SSO configuration instead of generating')
+def cli(create_directories: bool, use_ou_structure: bool, developer_role_name: str,
+        sso_name: Optional[str], create_repos_md: bool, skip_sso_name: bool, unified_root: Optional[str],
+        rebuild_cache: bool, validate: bool):
+    """SSO Config Generator - Generate AWS SSO configuration and directory structures.
+    
+    This tool will:
+    1. Generate AWS CLI config file with SSO profiles for each account/role
+    2. Create directory structure using OU hierarchy (if --use-ou-structure)
+    3. Set up environment files (.envrc) for direnv with the specified role
+    
+    The tool uses a cache file (~/.aws/.ou) to store the OU structure and account information.
+    Use --rebuild-cache to force a refresh of the cache.
+    
+    Example usage:
+        # Basic usage (uses defaults)
+        sso-config-generator
+        
+        # Force rebuild of OU cache
+        sso-config-generator --rebuild-cache
+        
+        # Use different role for .envrc files
+        sso-config-generator --developer-role-name ReadOnlyAccess
+        
+        # Disable OU structure (flat account directories)
+        sso-config-generator --no-use-ou-structure
+        
+        # Specify custom root directory
+        sso-config-generator --unified-root ~/aws-environments
+        
+        # Skip creating the SSO name directory
+        sso-config-generator --skip-sso-name
+        
+        # Validate existing configuration
+        sso-config-generator --validate
+    """
+    try:
+        if validate:
+            # Run validation
+            generator = SSOConfigGenerator()
+            if not generator.validate():
+                sys.exit(1)
+        else:
+            # Remove cache if rebuild requested
+            if rebuild_cache:
+                cache_path = os.path.expanduser("~/.aws/.ou")
+                if os.path.exists(cache_path):
+                    os.remove(cache_path)
+                    print("Removed existing OU cache.")
+            
+            # Generate configuration
+            generator = SSOConfigGenerator(
+                create_directories=create_directories,
+                use_ou_structure=use_ou_structure,
+                developer_role_name=developer_role_name,
+                sso_name=sso_name,
+                create_repos_md=create_repos_md,
+                skip_sso_name=skip_sso_name,
+                unified_root=unified_root
+            )
+            
+            if not generator.generate():
+                sys.exit(1)
+                
+    except Exception as e:
+        print(f"Error: {str(e)}", file=sys.stderr)
+        sys.exit(1)
+
+if __name__ == '__main__':
+    cli()