Installation

Get up and running with ByteHide Logs for Python in minutes.

Requirements

• Python 3.7 or higher - Ensure you have a compatible Python version
• pip - Python package manager (usually included with Python)

Check your Python version:

python --version

python --version

Install the SDK

Install the bytehide-logs package using pip:

pip install bytehide-logs

pip install bytehide-logs

For a specific version:

pip install bytehide-logs==1.0.0

pip install bytehide-logs==1.0.0

Verify Installation

Create a test script to verify the installation:

from bytehide_logs import Log, LogSettings, LogLevel

# Verify imports work
print("ByteHide Logs installed successfully!")

# Initialize with basic settings
Log.set_project_token("test-token")
Log.initialize(LogSettings(
    console_enabled=True,
    minimum_level=LogLevel.INFO
))

# Test logging
Log.info("Verification successful - ready to log!")

from bytehide_logs import Log, LogSettings, LogLevel

# Verify imports work
print("ByteHide Logs installed successfully!")

# Initialize with basic settings
Log.set_project_token("test-token")
Log.initialize(LogSettings(
    console_enabled=True,
    minimum_level=LogLevel.INFO
))

# Test logging
Log.info("Verification successful - ready to log!")

Run the verification script:

python verify_installation.py

python verify_installation.py

Expected output:

ByteHide Logs installed successfully!
Verification successful - ready to log!

ByteHide Logs installed successfully!
Verification successful - ready to log!

Installation Variations

Using Requirements File

Add to requirements.txt:

bytehide-logs>=1.0.0

bytehide-logs>=1.0.0

Then install:

pip install -r requirements.txt

pip install -r requirements.txt

Development Installation

Clone the repository and install in editable mode:

git clone https://github.com/bytehide/bytehide-logs-python.git
cd bytehide-logs-python
pip install -e .

git clone https://github.com/bytehide/bytehide-logs-python.git
cd bytehide-logs-python
pip install -e .

With Optional Dependencies

Install with extra features:

# Development dependencies
pip install bytehide-logs[dev]

# All extras
pip install bytehide-logs[all]

# Development dependencies
pip install bytehide-logs[dev]

# All extras
pip install bytehide-logs[all]

Python Version Compatibility

ByteHide Logs supports Python 3.7 and later:

Next Steps

After installation, proceed to:

1. Quick Start - Get logging running in your application
2. Configuration - Configure logging behavior
3. Set Project Token - Configure your credentials

Troubleshooting

"No module named 'bytehide_logs'"

Make sure the package is installed in the correct Python environment:

pip install bytehide-logs
python -c "import bytehide_logs; print(bytehide_logs.__version__)"

pip install bytehide-logs
python -c "import bytehide_logs; print(bytehide_logs.__version__)"

Version Compatibility Issues

If you encounter compatibility issues, try installing a specific version:

pip install bytehide-logs==1.0.0 --force-reinstall

pip install bytehide-logs==1.0.0 --force-reinstall

Virtual Environment Recommendation

Always use a virtual environment to avoid dependency conflicts:

# Create virtual environment
python -m venv venv

# Activate
source venv/bin/activate  # On Windows: venv\Scripts\activate

# Install
pip install bytehide-logs

# Create virtual environment
python -m venv venv

# Activate
source venv/bin/activate  # On Windows: venv\Scripts\activate

# Install
pip install bytehide-logs

Support

For installation issues, visit the Support Portal.