utopia-analyzer 1.0.0__tar.gz

utopia_analyzer-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Khizar Arain
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

utopia_analyzer-1.0.0/PKG-INFO

@@ -0,0 +1,194 @@
+Metadata-Version: 2.4
+Name: utopia-analyzer
+Version: 1.0.0
+Summary: Transforms any GitHub profile into a professional developer intelligence report
+Author-email: Khizer Arain <your@email.com>
+License: MIT License
+        
+        Copyright (c) 2024 Khizar Arain
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+        
+Project-URL: Homepage, https://github.com/khizerarain/utopia
+Project-URL: Repository, https://github.com/khizerarain/utopia
+Keywords: github,portfolio,cli,developer-tools,analytics
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Environment :: Console
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: click>=8.0
+Requires-Dist: rich>=13.0
+Requires-Dist: requests>=2.28
+Requires-Dist: python-dotenv>=1.0
+Dynamic: license-file
+
+# UTOPIA
+
+> Analyze any GitHub profile and generate a professional developer portfolio report with scoring, archetypes, and recruiter insights.
+
+**UTOPIA** (Ultimate Technical Overview & Portfolio Intelligence Analyzer) is a Python CLI tool that transforms any public GitHub profile into a detailed intelligence report. It scores the profile across six weighted categories, detects the developer's archetype, simulates an AI recruiter verdict, breaks down the tech stack, roasts bad habits (if asked nicely), and generates a 30-day improvement plan.
+
+## Installation
+
+```bash
+pip install utopia-cli
+```
+
+## Usage
+
+```bash
+utopia khizerarain
+utopia khizerarain --roast
+utopia khizerarain --output markdown --save report.md
+utopia khizerarain --token YOUR_GITHUB_TOKEN
+```
+
+## Publishing to PyPI (for maintainers)
+
+```bash
+pip install build twine
+python -m build
+twine upload dist/*
+```
+
+## Built With
+
+- [Python](https://www.python.org/) — core language
+- [Click](https://click.palletsprojects.com/) — CLI framework
+- [Rich](https://rich.readthedocs.io/) — terminal formatting and charts
+
+## Development Installation
+
+1. Clone the repository:
+
+```bash
+git clone https://github.com/khizerarain/utopia.git
+cd utopia
+```
+
+2. Install dependencies:
+
+```bash
+pip install -r requirements.txt
+```
+
+## Development Usage
+
+```bash
+# Basic terminal report
+python -m utopia.cli torvalds
+
+# Use a GitHub token for higher rate limits
+python -m utopia.cli torvalds --token ghp_xxxxxxxx
+
+# Roast mode
+python -m utopia.cli torvalds --roast
+
+# Save as JSON
+python -m utopia.cli torvalds --output json --save report.json
+
+# Save as Markdown
+python -m utopia.cli torvalds --output markdown --save report.md
+
+# Disable colors
+python -m utopia.cli torvalds --no-color
+
+# Refresh cached data
+python -m utopia.cli torvalds --no-cache
+```
+
+## Sample Output
+
+```
+┌───────────────────────────────────┐
+│ UTOPIA Portfolio Report: torvalds │
+│ UTOPIA SCORE: 80/100              │
+│ Portfolio Grade: B-               │
+└───────────────────────────────────┘
+
+Project Quality │ 23/25 │ ████████████████████████████░░ 92%
+Activity        │ 20/20 │ ██████████████████████████████ 98%
+Documentation   │ 11/15 │ ██████████████████████░░░░░░░░ 72%
+Tech Diversity  │  2/15 │ ████░░░░░░░░░░░░░░░░░░░░░░░░░░ 13%
+Impact          │ 15/15 │ ██████████████████████████████ 100%
+Open Source     │ 10/10 │ ████████████████████████████░░ 95%
+
+You are:
+  Backend Engineer       ██████████████░░░░░░  70.0%
+  DevOps Engineer        ██████████████░░░░░░  70.0%
+  AI/ML Developer        ██████████░░░░░░░░░░  50.0%
+  Data Engineer          ██████████░░░░░░░░░░  50.0%
+
+Would I hire this developer?
+YES
+
+Reasons:
+  ✓ Projects show ongoing maintenance
+  ✓ Projects are well explained
+  ✓ Repositories show solid engineering
+  ✓ Includes automated tests
+
+Strengths:
+  ✓ Strong community impact
+  ✓ Active development history
+  ✓ Active open-source contributor
+
+Weaknesses:
+  ✗ Tech stack is narrow
+  ✗ Needs more README documentation
+  ✗ Project quality could improve
+
+Tech Stack Breakdown
+  C              ████████████████████  97.7%
+  Assembly       ░░░░░░░░░░░░░░░░░░░░   0.7%
+  Shell          ░░░░░░░░░░░░░░░░░░░░   0.4%
+  Rust           ░░░░░░░░░░░░░░░░░░░░   0.3%
+  Other          ░░░░░░░░░░░░░░░░░░░░   0.9%
+
+30-Day Upgrade Plan
+Week 1:
+  • Contribute to an open-source project outside your main stack
+Week 2:
+  • Improve README files across your top repos
+Week 3:
+  • Refactor your most-starred project and add missing features
+Week 4:
+  • Review and merge community PRs in your own repos
+```
+
+## GitHub Token
+
+GitHub's unauthenticated API limit is 60 requests per hour. For full analysis, create a Personal Access Token:
+
+1. Go to **Settings → Developer settings → Personal access tokens → Tokens (classic)**
+2. Generate a new token with `public_repo` scope
+3. Use `--token <PAT>` or set `GITHUB_TOKEN` in a `.env` file
+
+## Running Tests
+
+```bash
+python -m pytest tests/ -v
+```
+
+## License
+
+MIT

utopia_analyzer-1.0.0/README.md

@@ -0,0 +1,151 @@
+# UTOPIA
+
+> Analyze any GitHub profile and generate a professional developer portfolio report with scoring, archetypes, and recruiter insights.
+
+**UTOPIA** (Ultimate Technical Overview & Portfolio Intelligence Analyzer) is a Python CLI tool that transforms any public GitHub profile into a detailed intelligence report. It scores the profile across six weighted categories, detects the developer's archetype, simulates an AI recruiter verdict, breaks down the tech stack, roasts bad habits (if asked nicely), and generates a 30-day improvement plan.
+
+## Installation
+
+```bash
+pip install utopia-cli
+```
+
+## Usage
+
+```bash
+utopia khizerarain
+utopia khizerarain --roast
+utopia khizerarain --output markdown --save report.md
+utopia khizerarain --token YOUR_GITHUB_TOKEN
+```
+
+## Publishing to PyPI (for maintainers)
+
+```bash
+pip install build twine
+python -m build
+twine upload dist/*
+```
+
+## Built With
+
+- [Python](https://www.python.org/) — core language
+- [Click](https://click.palletsprojects.com/) — CLI framework
+- [Rich](https://rich.readthedocs.io/) — terminal formatting and charts
+
+## Development Installation
+
+1. Clone the repository:
+
+```bash
+git clone https://github.com/khizerarain/utopia.git
+cd utopia
+```
+
+2. Install dependencies:
+
+```bash
+pip install -r requirements.txt
+```
+
+## Development Usage
+
+```bash
+# Basic terminal report
+python -m utopia.cli torvalds
+
+# Use a GitHub token for higher rate limits
+python -m utopia.cli torvalds --token ghp_xxxxxxxx
+
+# Roast mode
+python -m utopia.cli torvalds --roast
+
+# Save as JSON
+python -m utopia.cli torvalds --output json --save report.json
+
+# Save as Markdown
+python -m utopia.cli torvalds --output markdown --save report.md
+
+# Disable colors
+python -m utopia.cli torvalds --no-color
+
+# Refresh cached data
+python -m utopia.cli torvalds --no-cache
+```
+
+## Sample Output
+
+```
+┌───────────────────────────────────┐
+│ UTOPIA Portfolio Report: torvalds │
+│ UTOPIA SCORE: 80/100              │
+│ Portfolio Grade: B-               │
+└───────────────────────────────────┘
+
+Project Quality │ 23/25 │ ████████████████████████████░░ 92%
+Activity        │ 20/20 │ ██████████████████████████████ 98%
+Documentation   │ 11/15 │ ██████████████████████░░░░░░░░ 72%
+Tech Diversity  │  2/15 │ ████░░░░░░░░░░░░░░░░░░░░░░░░░░ 13%
+Impact          │ 15/15 │ ██████████████████████████████ 100%
+Open Source     │ 10/10 │ ████████████████████████████░░ 95%
+
+You are:
+  Backend Engineer       ██████████████░░░░░░  70.0%
+  DevOps Engineer        ██████████████░░░░░░  70.0%
+  AI/ML Developer        ██████████░░░░░░░░░░  50.0%
+  Data Engineer          ██████████░░░░░░░░░░  50.0%
+
+Would I hire this developer?
+YES
+
+Reasons:
+  ✓ Projects show ongoing maintenance
+  ✓ Projects are well explained
+  ✓ Repositories show solid engineering
+  ✓ Includes automated tests
+
+Strengths:
+  ✓ Strong community impact
+  ✓ Active development history
+  ✓ Active open-source contributor
+
+Weaknesses:
+  ✗ Tech stack is narrow
+  ✗ Needs more README documentation
+  ✗ Project quality could improve
+
+Tech Stack Breakdown
+  C              ████████████████████  97.7%
+  Assembly       ░░░░░░░░░░░░░░░░░░░░   0.7%
+  Shell          ░░░░░░░░░░░░░░░░░░░░   0.4%
+  Rust           ░░░░░░░░░░░░░░░░░░░░   0.3%
+  Other          ░░░░░░░░░░░░░░░░░░░░   0.9%
+
+30-Day Upgrade Plan
+Week 1:
+  • Contribute to an open-source project outside your main stack
+Week 2:
+  • Improve README files across your top repos
+Week 3:
+  • Refactor your most-starred project and add missing features
+Week 4:
+  • Review and merge community PRs in your own repos
+```
+
+## GitHub Token
+
+GitHub's unauthenticated API limit is 60 requests per hour. For full analysis, create a Personal Access Token:
+
+1. Go to **Settings → Developer settings → Personal access tokens → Tokens (classic)**
+2. Generate a new token with `public_repo` scope
+3. Use `--token <PAT>` or set `GITHUB_TOKEN` in a `.env` file
+
+## Running Tests
+
+```bash
+python -m pytest tests/ -v
+```
+
+## License
+
+MIT

utopia_analyzer-1.0.0/pyproject.toml

@@ -0,0 +1,35 @@
+[build-system]
+requires = ["setuptools>=68", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "utopia-analyzer"
+version = "1.0.0"
+description = "Transforms any GitHub profile into a professional developer intelligence report"
+readme = "README.md"
+license = { file = "LICENSE" }
+requires-python = ">=3.10"
+authors = [{ name = "Khizer Arain", email = "your@email.com" }]
+keywords = ["github", "portfolio", "cli", "developer-tools", "analytics"]
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Environment :: Console",
+]
+dependencies = [
+    "click>=8.0",
+    "rich>=13.0",
+    "requests>=2.28",
+    "python-dotenv>=1.0",
+]
+
+[project.scripts]
+utopia = "utopia.cli:main"
+
+[project.urls]
+Homepage = "https://github.com/khizerarain/utopia"
+Repository = "https://github.com/khizerarain/utopia"
+
+[tool.setuptools.packages.find]
+include = ["utopia*"]

utopia_analyzer-1.0.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

utopia_analyzer-1.0.0/tests/test_archetypes.py

@@ -0,0 +1,58 @@
+"""Tests for the archetype detection module."""
+
+from utopia.archetypes import detect_archetypes
+from utopia.github_client import ProfileData, RepoData
+from tests.test_scoring import make_profile, make_repo
+
+
+def test_backend_archetype_detected():
+    repos = [
+        make_repo(language="Python", topics=["api", "backend", "database"]),
+        make_repo(language="Go", topics=["microservices"]),
+    ]
+    profile = make_profile(
+        repos=repos,
+        total_languages={"Python": 500000, "Go": 200000},
+    )
+    results = detect_archetypes(profile)
+    top = results[0]
+    assert top.key == "backend"
+    assert top.percentage > 0
+
+
+def test_frontend_archetype_detected():
+    repos = [
+        make_repo(language="TypeScript", topics=["react", "frontend", "ui"]),
+        make_repo(language="JavaScript", topics=["vue"]),
+    ]
+    profile = make_profile(
+        repos=repos,
+        total_languages={"TypeScript": 400000, "JavaScript": 100000},
+    )
+    results = detect_archetypes(profile)
+    assert any(r.key == "frontend" and r.percentage > 0 for r in results)
+
+
+def test_full_stack_derived_from_both():
+    repos = [
+        make_repo(language="Python", topics=["api", "backend"]),
+        make_repo(language="TypeScript", topics=["react", "frontend"]),
+    ]
+    profile = make_profile(
+        repos=repos,
+        total_languages={"Python": 300000, "TypeScript": 300000},
+    )
+    results = detect_archetypes(profile)
+    assert any(r.key == "full_stack" for r in results)
+
+
+def test_devops_signals_detected():
+    repos = [
+        make_repo(language="Python", has_workflows=True, has_dockerfile=True, topics=["docker", "kubernetes"]),
+    ]
+    profile = make_profile(
+        repos=repos,
+        total_languages={"Python": 100000},
+    )
+    results = detect_archetypes(profile)
+    assert any(r.key == "devops" and r.percentage > 0 for r in results)

utopia_analyzer-1.0.0/tests/test_formatters.py

@@ -0,0 +1,122 @@
+"""Tests for the output formatters."""
+
+import json
+from datetime import datetime, timedelta, timezone
+
+from utopia.formatters import json_output, markdown_output, terminal
+from utopia.github_client import ProfileData, RepoData
+from utopia.report import build_report
+
+
+def _now_iso(days_ago: int = 0) -> str:
+    dt = datetime.now(timezone.utc) - timedelta(days=days_ago)
+    return dt.isoformat().replace("+00:00", "Z")
+
+
+def make_repo(**kwargs) -> RepoData:
+    defaults = {
+        "name": "repo",
+        "description": "A repo",
+        "language": "Python",
+        "stars": 5,
+        "forks": 1,
+        "size_kb": 500,
+        "created_at": _now_iso(365),
+        "updated_at": _now_iso(10),
+        "pushed_at": _now_iso(10),
+        "has_readme": True,
+        "readme_word_count": 120,
+        "open_issues_count": 0,
+        "topics": ["api", "backend"],
+        "license": "MIT",
+        "is_fork": False,
+        "is_archived": False,
+        "languages": {"Python": 10000},
+        "commit_activity": [2] * 52,
+        "has_tests": False,
+        "has_workflows": False,
+        "has_dockerfile": False,
+    }
+    defaults.update(kwargs)
+    return RepoData(**defaults)
+
+
+def make_profile(repos=None, **kwargs) -> ProfileData:
+    total_languages: dict[str, int] = {}
+    for repo in repos or []:
+        for lang, bytes_count in repo.languages.items():
+            total_languages[lang] = total_languages.get(lang, 0) + bytes_count
+    return ProfileData(
+        username="testuser",
+        name="Test",
+        bio=None,
+        followers=10,
+        following=0,
+        public_repos_count=len(repos) if repos else 0,
+        created_at=_now_iso(1000),
+        repos=repos or [],
+        merged_prs_count=2,
+        total_languages=total_languages,
+        **kwargs,
+    )
+
+
+def _sample_report(roast: bool = False):
+    repos = [
+        make_repo(name="api", language="Python", topics=["api", "backend"]),
+        make_repo(name="ui", language="JavaScript", topics=["react", "frontend"]),
+    ]
+    profile = make_profile(repos=repos)
+    return build_report(profile, roast_mode=roast)
+
+
+def test_terminal_render_no_color():
+    report = _sample_report()
+    output = terminal.render(report, no_color=True)
+    assert "UTOPIA SCORE" in output
+    assert "Project Quality" in output
+    assert "You are:" in output
+    assert "Would I hire" in output
+
+
+def test_terminal_render_with_roast():
+    report = _sample_report(roast=True)
+    output = terminal.render(report, no_color=True)
+    assert "UTOPIA ROAST" in output
+
+
+def test_json_output_is_valid():
+    report = _sample_report()
+    output = json_output.render(report)
+    data = json.loads(output)
+    assert data["username"] == "testuser"
+    assert "score" in data
+    assert "archetypes" in data
+    assert "recruiter" in data
+    assert "improvement_plan" in data
+
+
+def test_json_output_includes_roast_when_enabled():
+    report = _sample_report(roast=True)
+    output = json_output.render(report)
+    data = json.loads(output)
+    assert "roast" in data
+
+
+def test_markdown_output_contains_sections():
+    report = _sample_report(roast=True)
+    output = markdown_output.render(report)
+    assert "# UTOPIA Portfolio Report: testuser" in output
+    assert "## Score Breakdown" in output
+    assert "## Developer Archetype" in output
+    assert "## Recruiter Verdict" in output
+    assert "## Portfolio Roast" in output
+    assert "## 30-Day Upgrade Plan" in output
+
+
+def test_markdown_output_ascii_safe():
+    report = _sample_report()
+    output = markdown_output.render(report)
+    # Markdown bars should use only ASCII chars
+    assert "█" not in output
+    assert "░" not in output