{"id":26678247,"url":"https://github.com/telexintegrations/github-fork-tracker","last_synced_at":"2025-08-21T07:13:40.017Z","repository":{"id":278978861,"uuid":"937307174","full_name":"telexintegrations/github-fork-tracker","owner":"telexintegrations","description":"This project is a FastAPI-based telexintegration that monitor a GitHub repository for fork events and sends a notification to a telex channel with details of the fork event.","archived":false,"fork":false,"pushed_at":"2025-02-23T17:26:30.000Z","size":285,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-07-27T10:45:12.131Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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/telexintegrations.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-02-22T20:27:32.000Z","updated_at":"2025-02-23T17:45:04.000Z","dependencies_parsed_at":"2025-02-23T00:21:29.400Z","dependency_job_id":"e1c456ad-b5cb-48c4-ad4b-79e98507380b","html_url":"https://github.com/telexintegrations/github-fork-tracker","commit_stats":null,"previous_names":["telexintegrations/github-fork-tracker"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/telexintegrations/github-fork-tracker","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/telexintegrations%2Fgithub-fork-tracker","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/telexintegrations%2Fgithub-fork-tracker/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/telexintegrations%2Fgithub-fork-tracker/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/telexintegrations%2Fgithub-fork-tracker/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/telexintegrations","download_url":"https://codeload.github.com/telexintegrations/github-fork-tracker/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/telexintegrations%2Fgithub-fork-tracker/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":271441859,"owners_count":24760349,"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","status":"online","status_checked_at":"2025-08-21T02:00:08.990Z","response_time":74,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":[],"created_at":"2025-03-26T05:15:17.605Z","updated_at":"2025-08-21T07:13:39.983Z","avatar_url":"https://github.com/telexintegrations.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# GitHub Fork Event Tracker with Telex Integration\r\nThis project is a FastAPI-based application that monitors a GitHub repository for fork events and sends notifications with details of the fork event to a Telex channel. It is designed to help you stay informed about when and by whom your repository is forked.\r\n\r\n---\r\n\r\n## Features\r\n- Real-time Monitoring: Automatically detects fork events on a specified GitHub repository.\r\n- Telex Notifications: Sends detailed notifications to a Telex channel, including the forker's username, repository name, and the timestamp of the fork event.\r\n- Easy Integration: Built with FastAPI, making it lightweight, fast, and easy to integrate into your existing systems.\r\n- Asynchronous HTTP requests using httpx\r\n\r\n---\r\n\r\n## Technology Stack\r\n- **FastAPI** (Web framework)\r\n- **httpx** (Async HTTP requests)\r\n- **Uvicorn** (ASGI server for FastAPI)\r\n- **GitHub API** (Access to GitHub Repository)\r\n\r\n---\r\n\r\n## Prerequisites\r\nBefore you begin, ensure you have the following:\r\n- Python 3.7 or higher installed.\r\n- A GitHub repository to monitor.\r\n- A Telex return url and channel ID for sending notifications.\r\n- (Optional) Docker for containerized deployment.\r\n\r\n---\r\n\r\n## Installation\r\n1. **Clone the repository:**\r\n   ```bash\r\n   git clone https://github.com/telexintegrations/github-fork-tracker.git\r\n   cd github-fork-tracker\r\n   ```\r\n2. **Create a virtual environment and activate it:**\r\n   ```bash\r\n   python -m venv venv\r\n   source venv/bin/activate  # On Windows use: venv\\Scripts\\activate\r\n   ```\r\n3. **Install dependencies:**\r\n   ```bash\r\n   pip install -r requirements.txt\r\n   ```\r\n\r\n---\r\n\r\n## Running the API Locally\r\n1. **Start the FastAPI server:**\r\n   ```bash\r\n   uvicorn main:app --host 0.0.0.0 --port 8000 --reload\r\n   ```\r\n2. **Access the API documentation:**\r\n   - Open [http://127.0.0.1:8000/docs](http://127.0.0.1:8000/docs) for an interactive Swagger UI.\r\n\r\n---\r\n\r\n## API Endpoints\r\n- **Endpoint:** `POST /tick`\r\n- **Example Request:**\r\n```bash\r\ncurl --location 'https://github-fork-tracker.onrender.com/tick' \\\r\n--header 'Content-Type: application/json' \\\r\n--data '{\r\n  \"channel_id\": \"\u003cyour-test-telex-channel-id\u003e\",\r\n  \"return_url\": \"https://ping.telex.im/v1/return/\u003cyour-test-telex-channel-id\u003e\",\r\n  \"settings\": [\r\n    {\r\n      \"label\": \"repo_name\",\r\n      \"type\": \"text\",\r\n      \"required\": true,\r\n      \"default\": \"\u003cgithub_username\u003e/\u003crepo\u003e\"\r\n    }\r\n  ]\r\n}'\r\n```\r\n- **Example Response:** `{\"message\":\"Task added to background tasks\"}`\r\n\r\n---\r\n\r\n## Usage\r\n- Ensure the application is hosted and running on a publicly accessed server.\r\n- Login to your telex app\r\n- Navigate to the `Channels` tab, and add a new channel specifically for monitoring\r\n- Navigate to the `Apps` tab, and add new integration\r\n   - Add your integration.json enpoint to the `Integration Json Url` field and save as shown below;\r\n     ![add_integration](images/add-integration.png)\r\n   - Toggle to enable/activate integration as shown below;\r\n     ![activate_integration](images/activate-integration.png)\r\n   - Click `Manage App` and navigate to the `Settings` tab to configure your integration as shown below;\r\n     * Add `github_username/repo` to `Repo_name` field\r\n     * Set the interval to triger request every 4 hours `0 */4 * * *` or as needed. \r\n     ![settings_config](images/settings-config.png)\r\n     * Navigate to `Output` tab, and select `Custom channel`, selecting your previously created monitoring channel as shown below;\r\n     ![output_config](images/output-config.png)\r\n     * Check your telex monitoring channel for the notification\r\n     ![channel_notification](images/channel-notification.png)\r\n\r\n---\r\n\r\n## Contributing\r\nContributions are welcome! Please feel free to submit a pull request or open an issue if you have any suggestions or improvements.\r\n\r\n---\r\n\r\n## License\r\nThis project is licensed under the MIT License. See the LICENSE file for details.\r\n\r\n---\r\n\r\n## Acknowledgments\r\n- FastAPI for the web framework.\r\n- GitHub API for repository event monitoring.\r\n- Telex channel for sending notifications.\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftelexintegrations%2Fgithub-fork-tracker","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftelexintegrations%2Fgithub-fork-tracker","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftelexintegrations%2Fgithub-fork-tracker/lists"}