Installation Guide#

PySSL can be installed in several ways depending on your needs. This guide covers all installation methods from basic usage to development setup.

📦 Quick Installation#

### From PyPI (Coming Soon)

Once PySSL is released on PyPI, installation will be as simple as:

pip install pyssl

### From Source (Current Method)

For now, install directly from the source repository:

git clone https://github.com/yourusername/pyssl.git
cd pyssl
pip install -e .

🔧 Development Installation#

If you want to contribute to PySSL or run the tests:

git clone https://github.com/yourusername/pyssl.git
cd pyssl
pip install -e ".[test]"

This installs PySSL in editable mode with all testing dependencies.

📋 Requirements#

PySSL requires Python 3.8 or higher and the following dependencies:

Core Dependencies:

numpy - Numerical computing
pandas - Data manipulation and analysis
scikit-learn - Machine learning library

Testing Dependencies (for development):

pytest - Testing framework
pytest-cov - Coverage reporting

Documentation Dependencies (for docs):

sphinx - Documentation generator
pydata-sphinx-theme - Modern documentation theme
myst-parser - Markdown support for Sphinx

🚀 Verify Installation#

To verify that PySSL is installed correctly, run this simple test:

import numpy as np
from sklearn.linear_model import LogisticRegression
from ssl_framework.main import SelfTrainingClassifier

# Create sample data
X_labeled = np.array([[1, 2], [3, 4]])
y_labeled = np.array([0, 1])
X_unlabeled = np.array([[2, 3]])

# Test basic functionality
ssl_clf = SelfTrainingClassifier(LogisticRegression())
ssl_clf.fit(X_labeled, y_labeled, X_unlabeled)

print("✅ PySSL installed successfully!")

If this runs without errors, you’re ready to use PySSL!

🐍 Using uv (Recommended for Development)#

For the fastest and most reliable development setup, we recommend using uv:

# Install uv if you haven't already
curl -LsSf https://astral.sh/uv/install.sh | sh

# Clone and set up PySSL
git clone https://github.com/yourusername/pyssl.git
cd pyssl

# Create virtual environment and install dependencies
uv sync

# Run tests
uv run pytest tests/

🐛 Troubleshooting#

ImportError: No module named ‘ssl_framework’

Make sure you installed PySSL in editable mode with pip install -e . and that you’re in the correct directory.

ModuleNotFoundError: No module named ‘sklearn’

Install scikit-learn:

pip install scikit-learn

Tests failing during development setup

Ensure all test dependencies are installed:

pip install -e ".[test]"
pytest tests/

Documentation build failing

Install documentation dependencies:

pip install -e ".[docs]"
sphinx-build -b html docs/source docs/build

🔄 Updating PySSL#

To update your PySSL installation:

From source:

cd pyssl
git pull origin main
pip install -e .

From PyPI (when available):

pip install --upgrade pyssl

📚 Next Steps#

Now that you have PySSL installed, check out:

Getting Started with PySSL - Learn the basics
5-Minute Quickstart Tutorial - 5-minute tutorial
examples/basic_usage - Complete examples