{"id":28092693,"url":"https://github.com/basemax/github-name-friends","last_synced_at":"2025-05-15T16:16:08.615Z","repository":{"id":292757381,"uuid":"980750132","full_name":"BaseMax/github-name-friends","owner":"BaseMax","description":"A simple Python tool that generates a list of your GitHub friends with their profile links, names, followers, and more. The tool fetches data from GitHub profiles, formats it in multiple output formats (Markdown, HTML, JSON, CSV), and allows you to sort users by name or followers.","archived":false,"fork":false,"pushed_at":"2025-05-09T16:56:25.000Z","size":16,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-05-12T02:09:42.925Z","etag":null,"topics":["api","friend","gh","github","github-api","github-profile","github-username","py","python","python3","sort"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/BaseMax.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-05-09T16:43:12.000Z","updated_at":"2025-05-11T06:43:10.000Z","dependencies_parsed_at":"2025-05-12T02:09:46.927Z","dependency_job_id":"eb58c20b-fd72-42b2-bc06-0fa0a2a7ed29","html_url":"https://github.com/BaseMax/github-name-friends","commit_stats":null,"previous_names":["basemax/github-name-friends"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BaseMax%2Fgithub-name-friends","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BaseMax%2Fgithub-name-friends/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BaseMax%2Fgithub-name-friends/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BaseMax%2Fgithub-name-friends/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/BaseMax","download_url":"https://codeload.github.com/BaseMax/github-name-friends/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253950850,"owners_count":21989421,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","friend","gh","github","github-api","github-profile","github-username","py","python","python3","sort"],"created_at":"2025-05-13T13:36:02.247Z","updated_at":"2025-05-13T13:36:03.084Z","avatar_url":"https://github.com/BaseMax.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# GitHub Name Friends\n\nA simple Python tool that generates a list of your GitHub friends with their profile links, names, followers, and more. The tool fetches data from GitHub profiles, formats it in multiple output formats (Markdown, HTML, JSON, CSV), and allows you to sort users by name or followers.\n\n## Features\n\n- Fetches GitHub profile data (name, followers, location, bio, etc.)\n- Supports input from a file or command line\n- Sort users by name or followers\n- Output in Markdown, HTML, JSON, and CSV formats\n\n## Installation\n\n1. Clone the repository:\n\n```bash\ngit clone https://github.com/BaseMax/github-name-friends.git\n```\n\n2. Install dependencies:\n\n```bash\npip install -r requirements.txt\n```\n\n3. Create a .env file with your GitHub token (optional but recommended for higher API limits):\n\n```plaintext\nGITHUB_TOKEN=your_github_token\n```\n\n## Usage\n\n### Command-Line Arguments\n\n- `-f`, `--file`: Input file containing GitHub usernames or profile URLs (one per line).\n- `usernames`: GitHub usernames or profile URLs directly passed as arguments.\n- `-v`, `--verbose`: Enable verbose output (for debugging).\n- `--include-orgs`: Include organization accounts.\n- `--sort-by`: Sort users by name or followers (default: name).\n- `--out-dir`: Directory to save the output files (default: current directory).\n\n## Example Usage\n\n### 1. Using a file:\n\n```bash\n$ python github_friends.py -f friends.txt\n```\n\n### 2. Using a list of usernames:\n\n```bash\n$ python github_friends.py user1 user2 user3\n```\n\n### 3. Enabling verbose output:\n\n```bash\n$ python github_friends.py user1 -v\n```\n\n### 4. Sorting by followers:\n\n```bash\n$ python github_friends.py user1 user2 --sort-by followers\n```\n\n## Output\n\nThe tool will generate the following files in the output directory:\n\n- `friends.md`: A Markdown file with a list of your friends' GitHub profile links.\n- `friends.html`: An HTML file with a list of your friends' GitHub profile links.\n- `friends.json`: A JSON file containing detailed information about the users.\n- `friends.csv`: A CSV file with basic profile information.\n\n### Example Output (Markdown)\n\n```markdown\n# My Friends\n\n- [John Doe](https://github.com/johndoe)\n- [Jane Smith](https://github.com/janesmith)\n```\n\n### Example Output (HTML)\n\n```html\n\u003c!DOCTYPE html\u003e\n\u003chtml\u003e\n\u003chead\u003e\n  \u003cmeta charset=\"UTF-8\"\u003e\n  \u003ctitle\u003eMy Friends\u003c/title\u003e\n  \u003cstyle\u003ebody{font-family:sans-serif;padding:20px;}a{color:#0366d6;text-decoration:none;}li{margin:5px 0;}\u003c/style\u003e\n\u003c/head\u003e\n\u003cbody\u003e\n  \u003ch1\u003eMy Friends\u003c/h1\u003e\n  \u003cul\u003e\n    \u003cli\u003e\u003ca href=\"https://github.com/johndoe\" target=\"_blank\"\u003eJohn Doe\u003c/a\u003e\u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"https://github.com/janesmith\" target=\"_blank\"\u003eJane Smith\u003c/a\u003e\u003c/li\u003e\n  \u003c/ul\u003e\n\u003c/body\u003e\n\u003c/html\u003e\n```\n\n### License\n\nMIT License - Copyright (c) 2025 Max Base\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbasemax%2Fgithub-name-friends","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbasemax%2Fgithub-name-friends","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbasemax%2Fgithub-name-friends/lists"}