Skip to content

Standardize README format for PyPI and OSS best practices #41

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
oscarvalenzuelab merged 1 commit into from
Nov 5, 2025
Merged

Standardize README format for PyPI and OSS best practices #41

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ src2purl /path/to/project --confidence-threshold 0.85

### API Authentication

**⚠️ No API keys required!** The tool works with the free public APIs. API keys only provide enhanced rate limits and additional features.
**No API keys required!** The tool works with the free public APIs. API keys only provide enhanced rate limits and additional features.

#### Recommended API Keys (Optional)

Expand All @@ -107,9 +107,9 @@ export GITHUB_TOKEN=your_github_personal_access_token
```
- **Get token**: https://github.com/settings/tokens (no special permissions needed)
- **Benefits**:
- ✅ **Rate limit**: 10 → 5000 requests/hour
- ✅ **Better search**: More accurate repository identification
- ✅ **No cost**: Completely free
- **Rate limit**: 10 → 5000 requests/hour
- **Better search**: More accurate repository identification
- **No cost**: Completely free
- **Impact**: Significant improvement for repository discovery

**2. SCANOSS API** - **Nice to Have** (Free, optional)
Expand All @@ -118,9 +118,9 @@ export SCANOSS_API_KEY=your_scanoss_key
```
- **Get token**: Register at https://www.scanoss.com
- **Benefits**:
- ✅ **No cost**: Free tier available
- ✅ **Enhanced rate limits**: Premium API endpoint
- ✅ **Additional features**: Possible extra metadata
- **No cost**: Free tier available
- **Enhanced rate limits**: Premium API endpoint
- **Additional features**: Possible extra metadata
- **Impact**: Minor improvement (SCANOSS works great without key)

**3. Software Heritage API** - **For Heavy Usage** (Free, only if using `--use-swh`)
Expand All @@ -129,8 +129,8 @@ export SWH_API_TOKEN=your_swh_token
```
- **Get token**: Register at https://archive.softwareheritage.org/api/
- **Benefits**:
- ✅ **Bypass rate limits**: No 60-second waits
- ✅ **Faster comprehensive scans**: When using `--use-swh`
- **Bypass rate limits**: No 60-second waits
- **Faster comprehensive scans**: When using `--use-swh`
- **Impact**: Essential for `--use-swh` flag, not needed for default fast mode

#### Performance Comparison
Expand Down