| Name | beaconled JSON |
| Version |
0.2.0
JSON |
| download |
| home_page | None |
| Summary | Your delivery compass for empowered product builders. A comprehensive toolkit for analyzing git repository statistics and development metrics. |
| upload_time | 2025-07-24 18:23:46 |
| maintainer | shrwnsan |
| docs_url | None |
| author | shrwnsan |
| requires_python | >=3.7 |
| license | MIT |
| keywords |
git
analytics
metrics
development
productivity
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Beacon
Your delivery compass for empowered product builders.
A comprehensive toolkit for analyzing git repository statistics and development metrics.
## Features
- Commit-level analytics with detailed breakdowns
- Component and file type analysis
- Impact assessment (high/medium/low)
- Range analysis for teams and sprints
- Multiple output formats (standard, extended, JSON)
- Integration with CI/CD pipelines and git hooks
## Installation
Beacon requires Python 3.7+ and Git. We recommend installing in a virtual environment.
### Quick Install
```bash
# Create and activate a virtual environment
python -m venv .venv
source .venv/bin/activate # On Windows: .venv\Scripts\activate
# Install from PyPI
pip install beaconled
```
### Verify Installation
```bash
beaconled --version
```
For more detailed instructions, including development setup and troubleshooting, see the [Installation Guide](docs/installation.md).
## Quick Start
Analyze a git repository:
```bash
beaconled /path/to/repo
```
Generate a weekly team report:
```bash
beaconled --range --since "1 week ago"
```
For more detailed usage examples, please refer to the [Usage Examples](docs/usage.md).
## Sample Outputs
### Analyzing a Git Repository
When analyzing a repository, Beacon provides commit details, file changes, and metrics in the standard format:
```bash
beaconled /path/to/my-project
```
```bash
Repository Analysis: /path/to/my-project
Analysis Period: Last 30 commits
=== COMMIT SUMMARY ===
Total Commits: 30
Contributors: 4
Date Range: 2025-01-15 to 2025-01-23
=== COMMIT DETAILS ===
[2025-01-23 14:32] feat: Add user authentication module (John Doe)
Impact: HIGH - 8 files changed, 245 insertions, 12 deletions
Components: auth/, middleware/, tests/
[2025-01-23 10:15] fix: Resolve database connection timeout (Jane Smith)
Impact: MEDIUM - 3 files changed, 28 insertions, 15 deletions
Components: database/, config/
[2025-01-22 16:45] docs: Update API documentation (Mike Johnson)
Impact: LOW - 2 files changed, 67 insertions, 3 deletions
Components: docs/
=== FILE CHANGE METRICS ===
Most Active Files:
src/auth/login.py: 12 changes
config/database.py: 8 changes
tests/test_auth.py: 6 changes
File Type Breakdown:
Python (.py): 18 files, 456 lines changed
Markdown (.md): 4 files, 89 lines changed
JSON (.json): 2 files, 23 lines changed
=== IMPACT ASSESSMENT ===
High Impact Commits: 8 (27%)
Medium Impact Commits: 15 (50%)
Low Impact Commits: 7 (23%)
```
### Generating Weekly Team Reports
For range analysis with contributor breakdown and commit frequency:
```bash
beaconled --range --since "1 week ago" --format standard
```
```bash
Weekly Team Report
Analysis Period: 2025-01-16 to 2025-01-23 (7 days)
=== TEAM OVERVIEW ===
Total Contributors: 4
Total Commits: 23
Average Commits/Day: 3.3
Active Days: 6/7
=== CONTRIBUTOR BREAKDOWN ===
John Doe: 9 commits (39%)
- High Impact: 3 commits
- Medium Impact: 4 commits
- Low Impact: 2 commits
- Most Active: Monday, Wednesday
Jane Smith: 7 commits (30%)
- High Impact: 2 commits
- Medium Impact: 3 commits
- Low Impact: 2 commits
- Most Active: Tuesday, Thursday
Mike Johnson: 4 commits (17%)
- High Impact: 1 commit
- Medium Impact: 2 commits
- Low Impact: 1 commit
- Most Active: Friday
Sarah Wilson: 3 commits (13%)
- High Impact: 0 commits
- Medium Impact: 2 commits
- Low Impact: 1 commit
- Most Active: Monday
=== COMMIT FREQUENCY ===
Monday: 5 commits (22%)
Tuesday: 4 commits (17%)
Wednesday: 6 commits (26%)
Thursday: 3 commits (13%)
Friday: 3 commits (13%)
Saturday: 1 commit (4%)
Sunday: 1 commit (4%)
=== COMPONENT ACTIVITY ===
Most Changed Components:
frontend/: 8 commits, 234 lines
backend/api/: 6 commits, 189 lines
tests/: 5 commits, 156 lines
docs/: 4 commits, 78 lines
```
## Documentation
- [Installation Guide](https://github.com/shrwnsan/beacon-delivery-compass/blob/main/docs/installation.md)
- [Usage Examples](https://github.com/shrwnsan/beacon-delivery-compass/blob/main/docs/usage.md)
- [Integration Guide](https://github.com/shrwnsan/beacon-delivery-compass/blob/main/docs/integrations.md)
- [API Reference](https://github.com/shrwnsan/beacon-delivery-compass/blob/main/docs/api-reference.md)
- [Changelog](https://github.com/shrwnsan/beacon-delivery-compass/blob/main/CHANGELOG.md)
## Contributing
We welcome contributions! Please see our [Contributing Guide](CONTRIBUTING.md) for details.
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
Raw data
{
"_id": null,
"home_page": null,
"name": "beaconled",
"maintainer": "shrwnsan",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "git, analytics, metrics, development, productivity",
"author": "shrwnsan",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/d7/e0/0b2f60e0390698a4d3553d1d03a4c450e37c23433996e1e5b55e2ead27e2/beaconled-0.2.0.tar.gz",
"platform": null,
"description": "# Beacon\n\nYour delivery compass for empowered product builders.\n\nA comprehensive toolkit for analyzing git repository statistics and development metrics.\n\n## Features\n\n- Commit-level analytics with detailed breakdowns\n- Component and file type analysis\n- Impact assessment (high/medium/low)\n- Range analysis for teams and sprints\n- Multiple output formats (standard, extended, JSON)\n- Integration with CI/CD pipelines and git hooks\n\n## Installation\n\nBeacon requires Python 3.7+ and Git. We recommend installing in a virtual environment.\n\n### Quick Install\n\n```bash\n# Create and activate a virtual environment\npython -m venv .venv\nsource .venv/bin/activate # On Windows: .venv\\Scripts\\activate\n\n# Install from PyPI\npip install beaconled\n```\n\n### Verify Installation\n\n```bash\nbeaconled --version\n```\n\nFor more detailed instructions, including development setup and troubleshooting, see the [Installation Guide](docs/installation.md).\n\n## Quick Start\n\nAnalyze a git repository:\n\n```bash\nbeaconled /path/to/repo\n```\n\nGenerate a weekly team report:\n```bash\nbeaconled --range --since \"1 week ago\"\n```\n\nFor more detailed usage examples, please refer to the [Usage Examples](docs/usage.md).\n\n## Sample Outputs\n\n### Analyzing a Git Repository\n\nWhen analyzing a repository, Beacon provides commit details, file changes, and metrics in the standard format:\n\n```bash\nbeaconled /path/to/my-project\n```\n\n```bash\nRepository Analysis: /path/to/my-project\nAnalysis Period: Last 30 commits\n\n=== COMMIT SUMMARY ===\nTotal Commits: 30\nContributors: 4\nDate Range: 2025-01-15 to 2025-01-23\n\n=== COMMIT DETAILS ===\n[2025-01-23 14:32] feat: Add user authentication module (John Doe)\n Impact: HIGH - 8 files changed, 245 insertions, 12 deletions\n Components: auth/, middleware/, tests/\n \n[2025-01-23 10:15] fix: Resolve database connection timeout (Jane Smith)\n Impact: MEDIUM - 3 files changed, 28 insertions, 15 deletions\n Components: database/, config/\n \n[2025-01-22 16:45] docs: Update API documentation (Mike Johnson)\n Impact: LOW - 2 files changed, 67 insertions, 3 deletions\n Components: docs/\n\n=== FILE CHANGE METRICS ===\nMost Active Files:\n src/auth/login.py: 12 changes\n config/database.py: 8 changes\n tests/test_auth.py: 6 changes\n\nFile Type Breakdown:\n Python (.py): 18 files, 456 lines changed\n Markdown (.md): 4 files, 89 lines changed\n JSON (.json): 2 files, 23 lines changed\n\n=== IMPACT ASSESSMENT ===\nHigh Impact Commits: 8 (27%)\nMedium Impact Commits: 15 (50%)\nLow Impact Commits: 7 (23%)\n```\n\n### Generating Weekly Team Reports\n\nFor range analysis with contributor breakdown and commit frequency:\n\n```bash\nbeaconled --range --since \"1 week ago\" --format standard\n```\n\n```bash\nWeekly Team Report\nAnalysis Period: 2025-01-16 to 2025-01-23 (7 days)\n\n=== TEAM OVERVIEW ===\nTotal Contributors: 4\nTotal Commits: 23\nAverage Commits/Day: 3.3\nActive Days: 6/7\n\n=== CONTRIBUTOR BREAKDOWN ===\nJohn Doe: 9 commits (39%)\n - High Impact: 3 commits\n - Medium Impact: 4 commits \n - Low Impact: 2 commits\n - Most Active: Monday, Wednesday\n\nJane Smith: 7 commits (30%)\n - High Impact: 2 commits\n - Medium Impact: 3 commits\n - Low Impact: 2 commits\n - Most Active: Tuesday, Thursday\n\nMike Johnson: 4 commits (17%)\n - High Impact: 1 commit\n - Medium Impact: 2 commits\n - Low Impact: 1 commit\n - Most Active: Friday\n\nSarah Wilson: 3 commits (13%)\n - High Impact: 0 commits\n - Medium Impact: 2 commits\n - Low Impact: 1 commit\n - Most Active: Monday\n\n=== COMMIT FREQUENCY ===\nMonday: 5 commits (22%)\nTuesday: 4 commits (17%)\nWednesday: 6 commits (26%)\nThursday: 3 commits (13%)\nFriday: 3 commits (13%)\nSaturday: 1 commit (4%)\nSunday: 1 commit (4%)\n\n=== COMPONENT ACTIVITY ===\nMost Changed Components:\n frontend/: 8 commits, 234 lines\n backend/api/: 6 commits, 189 lines\n tests/: 5 commits, 156 lines\n docs/: 4 commits, 78 lines\n```\n\n## Documentation\n\n- [Installation Guide](https://github.com/shrwnsan/beacon-delivery-compass/blob/main/docs/installation.md)\n- [Usage Examples](https://github.com/shrwnsan/beacon-delivery-compass/blob/main/docs/usage.md)\n- [Integration Guide](https://github.com/shrwnsan/beacon-delivery-compass/blob/main/docs/integrations.md)\n- [API Reference](https://github.com/shrwnsan/beacon-delivery-compass/blob/main/docs/api-reference.md)\n- [Changelog](https://github.com/shrwnsan/beacon-delivery-compass/blob/main/CHANGELOG.md)\n\n## Contributing\n\nWe welcome contributions! Please see our [Contributing Guide](CONTRIBUTING.md) for details.\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Your delivery compass for empowered product builders. A comprehensive toolkit for analyzing git repository statistics and development metrics.",
"version": "0.2.0",
"project_urls": {
"Documentation": "https://github.com/shrwnsan/beacon-delivery-compass#readme",
"Homepage": "https://github.com/shrwnsan/beacon-delivery-compass",
"Issues": "https://github.com/shrwnsan/beacon-delivery-compass/issues",
"Repository": "https://github.com/shrwnsan/beacon-delivery-compass.git"
},
"split_keywords": [
"git",
" analytics",
" metrics",
" development",
" productivity"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "0eb7a6cbfa5abec4bdf26edd41af173ed2ad2b0a1d5f94c9258eabafa9eab614",
"md5": "3acb31d29579e01345229963a974e5d2",
"sha256": "b1e9c107422cd3df5f1c0e7a4cea18c35b995d0de7063cb0812357c6d3e9d0b1"
},
"downloads": -1,
"filename": "beaconled-0.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3acb31d29579e01345229963a974e5d2",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 12075,
"upload_time": "2025-07-24T18:23:45",
"upload_time_iso_8601": "2025-07-24T18:23:45.532647Z",
"url": "https://files.pythonhosted.org/packages/0e/b7/a6cbfa5abec4bdf26edd41af173ed2ad2b0a1d5f94c9258eabafa9eab614/beaconled-0.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "d7e00b2f60e0390698a4d3553d1d03a4c450e37c23433996e1e5b55e2ead27e2",
"md5": "e485b80788961dc2c4509cc2c747be6b",
"sha256": "73fbba5970eede50ebb61b71e0b5f970f8fccb40ec2203a0b274118aa19b2167"
},
"downloads": -1,
"filename": "beaconled-0.2.0.tar.gz",
"has_sig": false,
"md5_digest": "e485b80788961dc2c4509cc2c747be6b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 12276,
"upload_time": "2025-07-24T18:23:46",
"upload_time_iso_8601": "2025-07-24T18:23:46.919841Z",
"url": "https://files.pythonhosted.org/packages/d7/e0/0b2f60e0390698a4d3553d1d03a4c450e37c23433996e1e5b55e2ead27e2/beaconled-0.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-24 18:23:46",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "shrwnsan",
"github_project": "beacon-delivery-compass#readme",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "beaconled"
}
