Tell me about my stars
Project description
The Repo Stargazer
Problem
I have been starring github projects for a long time.
There are two primary intentions behind giving stars -
- Recognize the efforts of the author(s).
- Bookmark the repository for my own use.
Unfortunately the user interface to search the existing starred repositories is very primitive.
Also, it would be nice to have not only Semantic search but also provide the results to LLM to further explore the starred repositories.
I also wanted to explore Google ADK, Google A2A Protocol & MCP. This project makes use of all 3 technologies.
Solution
This project/tool uses semantic search and an AI agent as an attempt to solve the above problems.
Install (User)
Read below to install uv. You haven't done it yet? Come on guys!!
https://docs.astral.sh/uv/getting-started/installation/
and then simply run repo-stargazer using uvx
If you don't know -
uvxwill create an isolated environment, download the latest version and then run this tool. It's magic!!
uvx --from repo-stargazer rsg --help
Usage
The tool requires you to have a configuration file in which various settings are to be specified.
There is an example configuration file rsg-config.example.toml at the root of this repository. The configuration
uses TOML syntax.
You should make a copy of it and perhaps call it rsg-config.toml (The name of the file does not really matter!)
Step 1 - Obtain the Github Personal Access Token
This tool fetches your starred github repositories. In order to access to them without incurring rate limits it is required to use the Github Personal Access Token.
Read this to learn how to obtain it -
Step 2 - Edit the rsg-config.toml
- You should provide the Github PAT obtained in Step 1
- You should fill the
[embedder]section (Supported provider types are - ollama, openai, azure_openai) - You should fill the
[agent.litellm_params]section
In rsg-config.example.toml, I have added necessary comments to help fill out various configuration.
Step 3 - Build the database
The real work starts with this step.
At the moment, I use naive RAG technique.
- Information about your starred github repos are downloaded using the GitHub API
- Then the
readmefiles of these repos are downloaded. Note - Some repos, do not havereadmefile. - Then these
readmefiles are chunked and their embeddings are stored in a vector store
The data above (including vectorstore) is stored in your computers data directories for example $HOME/.local/share/rsg
on macos and linux.
You can change the location of the data by setting the environment variable RSG_DATA_HOME
uvx --from repo-stargazer rsg build --config rsg-config.toml
Step 4 - Run the agent using adk web & ui
Let's see all of it in action.
For the user interface, I am still using the development UI that comes as part of Google ADK.
In near future, would provide a decent UI with out any developer specific elements.
uvx --from repo-stargazer rsg run-adk-server --config rsg-config.toml
Developer
# I shouldn't have to write this instruction. But what the heck!
git clone https://github.com/ksachdeva/repo-stargazer
Now open the repo in devcontainer. You should know these things!
Just in case, Read if you have never used devcontainers
https://code.visualstudio.com/docs/devcontainers/containers
Various commands (via poe [https://poethepoet.natn.io/index.html]) to use during development.
Hint - Look inside
pyproject.tomlto see the underlying poe magic!
# Help
# Note - The `pyproject.toml` has `RSG_DATA_HOME` env variable set to `$PWD/tmp`
uv run poe --help
# Build the database
# Note - The `pyproject.toml` has `RSG_DATA_HOME` env variable set to `$PWD/tmp`
uv run poe build --config rsg-config.toml
# Run the Google ADK server
# Note - The `pyproject.toml` has `RSG_DATA_HOME` env variable set to `$PWD/tmp`
uv run poe adk-server --config rsg-config.toml
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
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file repo_stargazer-0.2.2.tar.gz.
File metadata
- Download URL: repo_stargazer-0.2.2.tar.gz
- Upload date:
- Size: 4.0 MB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.12.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
ec1f3a063800e8d9e22edcd621cf92b4581e68e752db01eb51da748303c65206
|
|
| MD5 |
13ffca9274b39de8947f873ccac3d0af
|
|
| BLAKE2b-256 |
78e3f27bc90297362ae67ca8f656a6d091ac188d8637ce0f1bddf3863b71fc0f
|
Provenance
The following attestation bundles were made for repo_stargazer-0.2.2.tar.gz:
Publisher:
publish.yaml on ksachdeva/repo-stargazer
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
repo_stargazer-0.2.2.tar.gz -
Subject digest:
ec1f3a063800e8d9e22edcd621cf92b4581e68e752db01eb51da748303c65206 - Sigstore transparency entry: 238747399
- Sigstore integration time:
-
Permalink:
ksachdeva/repo-stargazer@1c03e549f59a0fa5f878513a0e7e260d0667358b -
Branch / Tag:
refs/tags/0.2.2 - Owner: https://github.com/ksachdeva
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yaml@1c03e549f59a0fa5f878513a0e7e260d0667358b -
Trigger Event:
release
-
Statement type:
File details
Details for the file repo_stargazer-0.2.2-py3-none-any.whl.
File metadata
- Download URL: repo_stargazer-0.2.2-py3-none-any.whl
- Upload date:
- Size: 20.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.12.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
ccdc6d25d31ff0955d984d2e8269bb41e91ebfaec6c31629d87a3ca3641af563
|
|
| MD5 |
d62797bdd26c7ef03b06bbef0059c1b8
|
|
| BLAKE2b-256 |
e97c04800a82d03458f91572d78ad34fc80e679969e5e657682023a2c6f8bbd4
|
Provenance
The following attestation bundles were made for repo_stargazer-0.2.2-py3-none-any.whl:
Publisher:
publish.yaml on ksachdeva/repo-stargazer
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
repo_stargazer-0.2.2-py3-none-any.whl -
Subject digest:
ccdc6d25d31ff0955d984d2e8269bb41e91ebfaec6c31629d87a3ca3641af563 - Sigstore transparency entry: 238747400
- Sigstore integration time:
-
Permalink:
ksachdeva/repo-stargazer@1c03e549f59a0fa5f878513a0e7e260d0667358b -
Branch / Tag:
refs/tags/0.2.2 - Owner: https://github.com/ksachdeva
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yaml@1c03e549f59a0fa5f878513a0e7e260d0667358b -
Trigger Event:
release
-
Statement type: