Skip to main content

A command-line tool for analyzing GitHub repositories and calculating social signals based on various metrics.

Project description

SOSIG (Social Signal) Command Line Tool

A command-line tool for analyzing GitHub repositories and calculating social signals based on various metrics.

Features

  • Analyze local Git repositories for various metrics and social signals
  • Store and manage repository analysis data in a local database
  • Configure analysis weights and parameters
  • View repository statistics and comparisons
  • Database management and optimization utilities

Installation

# Clone the repository
git clone https://github.com/will-wright-eng/sosig.git
cd sosig

# Install dependencies
pip install -r requirements.lock

# For development
pip install -r requirements-dev.lock

Usage

SOSIG provides three main command groups:

GitHub Metrics Operations (gh)

# Analyze repositories
sosig gh analyze path/to/repo1 path/to/repo2

# List analyzed repositories (sorted by social signal by default)
sosig gh list
sosig gh list --sort stars  # Sort by stars

Available sort options:

  • social_signal (default)
  • stars
  • age_days
  • name
  • username
  • last_analyzed
  • commit_count

Database Operations (db)

# View database statistics
sosig db stats

# Show database schema
sosig db schema

# Remove specific repository
sosig db remove repo-name

# Clear all data
sosig db clear

# Optimize database
sosig db vacuum

Configuration Operations (config)

# Show current configuration
sosig config show

# Update configuration values
sosig config set metrics.weights.age 0.3

Project Structure

sosig/
├── src/sosig/
│   ├── commands/          # CLI command implementations
│   ├── core/             # Core functionality and models
│   └── utils/            # Utility functions and services
├── scripts/              # Helper scripts
│   └── results/          # Analysis results
└── requirements.lock     # Locked dependencies

Scripts

The project includes several utility scripts:

  • analyze-repo-file.sh: Batch analyze repositories from a file
  • fetch-repos.sh: Fetch repository information from GitHub

Development

Setup

rye add pip
rye sync
rye build
python -m pip install -e .

Debug Mode

All commands support a --debug flag for additional logging:

sosig gh analyze path/to/repo --debug

Workspace Configuration

Analysis operations use a workspace directory (default: ~/.local/share/ssig/workspace):

sosig gh analyze path/to/repo --workspace /custom/path

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sosig-0.2.0.tar.gz (12.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

sosig-0.2.0-py3-none-any.whl (18.3 kB view details)

Uploaded Python 3

File details

Details for the file sosig-0.2.0.tar.gz.

File metadata

  • Download URL: sosig-0.2.0.tar.gz
  • Upload date:
  • Size: 12.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for sosig-0.2.0.tar.gz
Algorithm Hash digest
SHA256 9b0cf9bff5ebcd0a24ad38982000dcbba15217c0ef063d7151fd2da7e5858b2c
MD5 d29516bdfdff6555f3ea8a7473076442
BLAKE2b-256 9bdd14b50dbd69f78a6a7aeb6ce6525ee86ae4c7a6a1d1ea39c544db0f7dde9f

See more details on using hashes here.

File details

Details for the file sosig-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: sosig-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 18.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for sosig-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b7ad3317b04f34abfce9c81ff9fe70ed2584551241b15f21c754a34f6e981eea
MD5 fcbf3b5a3f36f881fef2afc997f30efc
BLAKE2b-256 92715562f3d1f0edcf500963a4754d25a51efdf5f179e4c8a5db380f63d604e5

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page