Changelog:

- fixed #7
- Added dotenv support
- Added playground.py
- Added __main__.py for directly running the package
- Added Custom Seed feature
- Updated docs

Author: Yuen Sze Hong

.gitignore

@@ -17,3 +17,4 @@ cookie.json
 notes.txt
 todolist.txt
 images/
+.env

README.md

@@ -1,49 +1,97 @@
 # Microsoft Designer API
 
+A Python library for generating images using Microsoft Designer's API.
+
 ### Installation
 
-```$ pip3 install microsoftdesigner```
+```bash
+pip install microsoftdesigner
+```
 
-### Usage
+### Configuration
 
-``` 
-$ python3 -m microsoftdesigner -h
-
-options:
-  -h, --help            show this help message and exit
-  --user_id USER_ID     User ID
-  --auth_token AUTH_TOKEN
-                        Auth Token
-  --prompt PROMPT       Prompt
-  --save_path FILE_PATH
-                        File Path to save the output (optional)
-  --file_name FILE_NAME
-                        File Name to save the output (optional)
-  --resolution RESOLUTION
-                        Resolution of the image (optional)
-                        (default: 1024x1024, available: 1024x1792, 1792x1024)
+Create a `.env` file in your project root with:
 
+```env
+USER_ID=your_user_id_here
+AUTH_TOKEN=your_auth_token_here
 ```
-## Getting Started
-- Create a new user account or login [Microsoft Designer](https://designer.microsoft.com/)
-- Open the developer tools and go to the network tab
-- Create a new image using random text
-- Find the request with post method and copy the request headers
-- Copy the user id, auth token (Authorization: value) from the request headers
-- Run the script with the copied values
-- Note: **auth_token will expire after 24 hours**
-- Note: **Do not pass resolution other than 1024x1024, 1024x1792, 1792x1024**
+
+### Command Line Usage
 
 ```bash
-$ python3 -m microsoftdesigner --user_id <user_id> --auth_token <auth_token> --prompt <prompt> --resolution <resolution> --save_path <save_path>
+python -m microsoftdesigner --help
 
+options:
+  -h, --help            show this help message and exit
+  --user_id USER_ID     User ID (or set MSDESIGNER_USER_ID env var)
+  --auth_token AUTH_TOKEN
+                        Authentication token (or set MSDESIGNER_AUTH_TOKEN env var)
+  --prompt PROMPT       Image generation prompt
+  --save_path SAVE_PATH
+                        Path to save generated images (default: images)
+  --resolution {1024x1024,1024x1792,1792x1024}
+                        Image resolution (default: 1024x1024)
+  --boost_count BOOST_COUNT
+                        Boost count for generation quality (default: 1)
+  --seed SEED          Random seed for reproducible results (optional)
 ```
-### **Python Example**
 
+### Python Usage
+
+Basic example:
 ```python
 from microsoftdesigner.gen_images import create_img
-create_img(user_id, auth_token, prompt, resolution)
+from dotenv import load_dotenv
+import os
+
+load_dotenv()  # Load environment variables from .env file
+
+# Get credentials from environment
+user_id = os.getenv("USER_ID") 
+auth_token = os.getenv("AUTH_TOKEN")
+
+# Generate images
+image_paths = create_img(
+    user_id=user_id,
+    auth_token=auth_token,
+    prompt="a beautiful sunset over mountains",
+    save_path="images",      # Optional: defaults to 'images'
+    resolution="1024x1024",  # Optional: 1024x1024, 1024x1792, 1792x1024
+    boost_count=1,          # Optional: enhance generation quality (default: 1)
+    seed=42                 # Optional: set for reproducible results
+)
 
-# Image will be saved in images folder
+# Example output: list of paths like
+# ['images/1024x1024/123e4567-e89b-12d3-a456-426614174000.jpg',
+#  'images/1024x1024/987fcdeb-51d3-12d3-a456-426614174000.jpg', ...]
+print(f"Generated images saved to: {image_paths}")
 ```
 
+## Getting Started
+
+1. Create/login to your [Microsoft Designer](https://designer.microsoft.com/) account
+2. Open browser developer tools (F12) and go to Network tab
+3. Generate an image using any prompt in Microsoft Designer
+4. In the Network tab, find the POST request to `/DallE.ashx`
+5. From the request headers, copy:
+   - `UserId` header value → set as USER_ID
+   - `Authorization` header value → set as AUTH_TOKEN
+6. Save these values in your .env file or pass them directly to the API
+
+### Important Notes
+
+- **Authentication**: Auth tokens expire after 24 hours - you'll need to refresh them
+- **Resolutions**: Only use supported resolutions:
+  - Square: 1024x1024
+  - Portrait: 1024x1792
+  - Widescreen: 1792x1024
+- **File Organization**: Generated images are automatically saved in resolution-specific subfolders:
+  ```
+  images/
+  ├── 1024x1024/
+  ├── 1024x1792/
+  └── 1792x1024/
+  ```
+- **Error Handling**: The API will return an empty list if you've run out of credits (403 error)
+

playground.py

@@ -0,0 +1,50 @@
+import os
+from typing import Dict, Literal
+from microsoftdesigner.gen_images import create_img
+from dotenv import load_dotenv
+
+load_dotenv()
+
+ResolutionType = Literal['square', 'widescreen', 'portrait']
+
+RESOLUTIONS: Dict[ResolutionType, str] = {
+    'square': '1024x1024',
+    'portrait': '1024x1792', 
+    'widescreen': '1792x1024'  # Fixed typo in 'portrait'
+}
+
+ACTIONS = [
+    "sitting",
+    "riding",
+    "laying",
+]
+
+PROMPTS = [f"anime girl {action} on an exercise ball in a room with exercise balls" for action in ACTIONS ]
+
+DEFAULT_NUM_IMAGES = 40
+
+def generate_images(
+    prompt: str,
+    resolution_type: ResolutionType = 'widescreen',
+) -> None:
+    """
+    Generate images using Microsoft Designer API.
+    
+    Args:
+        prompt: The text prompt for image generation
+        resolution_type: Type of resolution from RESOLUTIONS
+        num_images: Number of images to generate
+    """
+    user_id = os.getenv("USER_ID")
+    auth_token = os.getenv("AUTH_TOKEN")
+
+    if not user_id or not auth_token:
+        raise ValueError("USER_ID and AUTH_TOKEN must be set in .env file")
+    
+    # for _ in range(num_images):
+    resolution = RESOLUTIONS[resolution_type]
+    create_img(user_id, auth_token, prompt, resolution=resolution)
+
+if __name__ == "__main__":
+    prompt = PROMPTS[1]
+    generate_images(prompt)

pyproject.toml

@@ -24,9 +24,9 @@ dependencies = [
     "httpx>=0.28.1",
     "beautifulsoup4>=4.12.3",
     "lxml>=5.3",
+    "python-dotenv",
 ]
 
 [project.urls]
 Homepage = "https://github.com/imnotdev25/Msdesigner-api"
 Issues = "https://github.com/imnotdev25/Msdesigner-api/issues"
-

src/microsoftdesigner/__main__.py

@@ -0,0 +1,69 @@
+import os
+import argparse
+import sys
+from venv import logger
+from dotenv import load_dotenv
+from microsoftdesigner.constants import VALID_RESOLUTIONS
+from microsoftdesigner.gen_images import create_img
+
+load_dotenv()
+
+parser = argparse.ArgumentParser(description="Generate images using Microsoft Designer API")
+parser.add_argument(
+    "--user_id",
+    required=False,
+    help="User ID",
+    default=os.getenv("MSDESIGNER_USER_ID"),
+)
+parser.add_argument(
+    "--auth_token",
+    required=False,
+    help="Authentication token",
+    default=os.getenv("MSDESIGNER_AUTH_TOKEN"),
+)
+parser.add_argument("--prompt", required=True, help="Image generation prompt")
+parser.add_argument("--save_path", default="images", help="Path to save generated images")
+parser.add_argument(
+    "--resolution",
+    default="1024x1024",
+    choices=VALID_RESOLUTIONS,
+    help="Image resolution",
+)
+parser.add_argument(
+    "--boost_count", type=int, default=1, help="Boost count"
+)
+parser.add_argument(
+    "--seed",
+    type=int,
+    default=None,
+    help="Seed for reproducible generations (random if not provided)",
+)
+
+args = parser.parse_args()
+
+user_id = args.user_id
+auth_token = args.auth_token
+
+if not user_id:
+    parser.error(
+        "Please provide --user_id argument or set MSDESIGNER_USER_ID environment variable."
+    )
+if not auth_token:
+    parser.error(
+        "Please provide --auth_token argument or set MSDESIGNER_AUTH_TOKEN environment variable."
+    )
+
+try:
+    image_paths = create_img(
+        user_id,
+        auth_token,
+        args.prompt,
+        save_path=args.save_path,
+        resolution=args.resolution,
+        boost_count=args.boost_count,
+        seed=args.seed,
+    )
+    logger.info(f"Generated images saved to: {image_paths}")
+except Exception as e:
+    logger.error(f"Failed to generate images: {str(e)}")
+    sys.exit(1)

src/microsoftdesigner/constants.py

@@ -1,13 +1,28 @@
 import uuid
 
+# Base URL for Microsoft Designer's DALL-E API
 MS_BASE_URL = "https://designerapp.officeapps.live.com/designerapp/DallE.ashx"
 
-HEADERS = {'Host': 'designerapp.officeapps.live.com',
+# Default headers for API requests
+HEADERS = {
+    'Host': 'designerapp.officeapps.live.com',
     'User-Agent': 'Mozilla/5.0 (X11; Linux x86_64; rv:133.0) Gecko/20100101 Firefox/133.0',
-    'Accept': 'application/json, text/plain, */*', 'Accept-Language': 'en-US,en;q=0.5',
-    'Accept-Encoding': 'gzip, deflate, br, zstd', 'Referer': 'https://designer.microsoft.com/',
-    'ClientId': f'{str(uuid.uuid4())}', 'ContainerId': f'{str(uuid.uuid4())}', 'SessionId': f'{str(uuid.uuid4())}',
-    'HostApp': 'DesignerApp', 'ClientName': 'DesignerApp', 'Origin': 'https://designer.microsoft.com',
-    'Connection': 'keep-alive', 'FileToken': f'{str(uuid.uuid4())}', }
+    'Accept': 'application/json, text/plain, */*',
+    'Accept-Language': 'en-US,en;q=0.5',
+    'Accept-Encoding': 'gzip, deflate, br, zstd',
+    'Referer': 'https://designer.microsoft.com/',
+    'ClientId': f'{str(uuid.uuid4())}',
+    'ContainerId': f'{str(uuid.uuid4())}',
+    'SessionId': f'{str(uuid.uuid4())}',
+    'HostApp': 'DesignerApp',
+    'ClientName': 'DesignerApp',
+    'Origin': 'https://designer.microsoft.com',
+    'Connection': 'keep-alive',
+    'FileToken': f'{str(uuid.uuid4())}',
+}
 
+# Query parameters for the API endpoint
 PARAMS = {'action': 'GetDallEImagesCogSci'}
+
+# Valid resolutions
+VALID_RESOLUTIONS = {'1024x1024', '1024x1792', '1792x1024'}