|
12 | 12 |
|
13 | 13 | ## Installation |
14 | 14 |
|
15 | | -1. Install the SDK: |
| 15 | +### For End Users (Production/Consumption): |
| 16 | +1. Install the published SDK from PyPI: |
16 | 17 | ```bash |
17 | 18 | pip install PowerPlatform-Dataverse-Client |
18 | 19 | ``` |
|
22 | 23 | pip install azure-identity |
23 | 24 | ``` |
24 | 25 |
|
| 26 | +### For Developers (Contributing/Local Development): |
| 27 | +1. Clone the repository and navigate to the project directory |
| 28 | +2. Install in editable/development mode: |
| 29 | + ```bash |
| 30 | + pip install -e . |
| 31 | + ``` |
| 32 | +
|
| 33 | +**Key Differences:** |
| 34 | +- `pip install PowerPlatform-Dataverse-Client` → Downloads and installs the published package from PyPI |
| 35 | +- `pip install -e .` → Installs from local source code in "editable" mode |
| 36 | +
|
| 37 | +**Editable Mode Benefits:** |
| 38 | +- ✅ Changes to source code are immediately available (no reinstall needed) |
| 39 | +- ✅ Perfect for development, testing, and contributing |
| 40 | +- ✅ Examples and tests can access the local codebase |
| 41 | +- ✅ Supports debugging and live code modifications |
| 42 | +
|
25 | 43 | ## What This Script Does |
26 | 44 |
|
27 | 45 | - ✅ Validates package installation and imports |
@@ -76,9 +94,19 @@ def validate_imports(): |
76 | 94 | except ImportError as e: |
77 | 95 | print(f" ❌ Import failed: {e}") |
78 | 96 | print("\n💡 Troubleshooting:") |
79 | | - print(" • Install with: pip install PowerPlatform-Dataverse-Client") |
80 | | - print(" • Install Azure Identity: pip install azure-identity") |
81 | | - print(" • Check virtual environment is activated") |
| 97 | + print(" 📦 For end users (published package):") |
| 98 | + print(" • pip install PowerPlatform-Dataverse-Client") |
| 99 | + print(" • pip install azure-identity") |
| 100 | + print(" ") |
| 101 | + print(" 🛠️ For developers (local development):") |
| 102 | + print(" • Navigate to the project root directory") |
| 103 | + print(" • pip install -e .") |
| 104 | + print(" • This enables 'editable mode' for live development") |
| 105 | + print(" ") |
| 106 | + print(" 🔧 General fixes:") |
| 107 | + print(" • Check virtual environment is activated") |
| 108 | + print(" • Verify you're in the correct directory") |
| 109 | + print(" • Try: pip list | grep PowerPlatform") |
82 | 110 | return False, None, None |
83 | 111 |
|
84 | 112 |
|
|
0 commit comments