Installing Snapjobs
Installation Guide
Get started with Snapjobs in your preferred environment
Platform-specific Installation
# Using pip
pip install Snapjobs
# Using poetry
poetry add Snapjobs-ai
# Using conda
conda install -c Snapjobs Snapjobs-ai1
2
3
4
5
6
7
8
9
10
Environment Setup
Configuration File
Snapjobs_API_KEY=your_api_key
Snapjobs_ENVIRONMENT=production
Snapjobs_TIMEOUT=30000
Snapjobs_MAX_RETRIES=3
Snapjobs_DEBUG=false1
2
3
4
5
SDK Initialization
from install Snapjobs import MatchingEngine
import os
# Using environment variables
engine = MatchingEngine(
api_key=os.getenv('Snapjobs_API_KEY'),
environment='production'
)
# Or using direct configuration
engine = MatchingEngine(
api_key='your_api_key',
environment='production',
timeout=30000
)1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
System Requirements
Python
- Python 3.8 or higher
- pip 20.0 or higher
- 4GB RAM minimum
Node.js
- Node.js 14 or higher
- npm 6.0 or higher
- 4GB RAM minimum
Docker
- Docker 20.10 or higher
- 8GB RAM recommended
- 4 CPU cores recommended
Verification
Test Your Installation
Verify your Snapjobs installation is working correctly
Code Editor
// Initialize the client
const client = new SnapjobsClient({
apiKey: process.env.Snapjobs_API_KEY
});
// Test connection
const status = await client.testConnection();
console.log('Connection status:', status);
// Try a basic operation
const skills = await client.extractSkills(
"Need a React developer"
);
console.log('Extracted skills:', skills);1
2
3
4
5
6
7
8
9
10
11
12
13
14
Output
Common Issues
API Key Issues
Troubleshoot API key configuration problems
// Check if API key is properly set
if (!process.env.Snapjobs_API_KEY) {
throw new Error('Snapjobs_API_KEY not found in environment');
}
// Verify API key format
if (!/^Snapjobs_[a-zA-Z0-9]{32}$/.test(process.env.Snapjobs_API_KEY)) {
throw new Error('Invalid API key format');
}1
2
3
4
5
6
7
8
9
Connection Issues
Handle common connection problems
try {
await client.testConnection();
} catch (error) {
if (error.code === 'ECONNREFUSED') {
console.error('Connection refused. Check your network.');
} else if (error.code === 'TIMEOUT') {
console.error('Connection timed out. Try increasing timeout.');
}
}1
2
3
4
5
6
7
8
9