Skip to content

Commit ed04659

Browse files
committed
docs: improve local installation instructions in build script
- Add pipx installation option with proper flags - Include virtual environment installation instructions - Document Python version constraints (3.10-3.12) - Add note about Python 3.13 compatibility issues
1 parent d78f2e2 commit ed04659

1 file changed

Lines changed: 7 additions & 1 deletion

File tree

scripts/build.py

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,13 @@ def main():
120120
print("\n🚀 To publish to PyPI:")
121121
print(" python scripts/publish.py")
122122
print("\n🧪 To test locally:")
123-
print(" pip install dist/deepctl-0.1.0-py3-none-any.whl")
123+
print(" # Option 1: Install with pipx (recommended for CLI tools)")
124+
print(" pipx install --python python3.12 --pip-args=\"--find-links dist/\" dist/deepctl-0.1.0-py3-none-any.whl")
125+
print("\n # Option 2: Install with pip in a virtual environment")
126+
print(" python3.12 -m venv test-env")
127+
print(" source test-env/bin/activate # On Windows: test-env\\Scripts\\activate")
128+
print(" pip install --find-links dist/ dist/deepctl-0.1.0-py3-none-any.whl")
129+
print("\n Note: Python 3.13+ may not be supported by all dependencies yet")
124130

125131

126132
if __name__ == "__main__":

0 commit comments

Comments
 (0)