Skip to content

Commit

Permalink
better README
Browse files Browse the repository at this point in the history
  • Loading branch information
florian committed Jun 17, 2024
1 parent 04c918a commit c749e4f
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,17 @@
<img src="./static/pypi.svg" alt="PyPI Scout Logo" width="200">
</p>

PyPI Scout helps you find PyPI packages with the help of vector embeddings and Sentence Transformers.
Find Python Packages on PyPI packages with the help of vector embeddings .

![Demo](./static/demo.gif)

## Overview
## What does this do?

Finding the right Python package on PyPI can be a bit difficult, since it isn't really designed for discovering packages easily. For example, you can search for the word "plot" and get a list of hundreds of packages that contain the word "plot" in seemingly random order.

Inspired by [this blog post](https://koaning.io/posts/search-boxes/) about finding arXiv articles using vector embeddings, I decided to build a small application that helps you find Python packages with a similar approach. For example, you can ask it "I want to make nice plots and visualizations", and it will provide you with a short list of packages that can help you with that.

## How does this work?

The project works by collecting project summaries and descriptions for all packages on PyPI with more than 50 weekly downloads. These are then converted into vector representations using [Sentence Transformers](https://www.sbert.net/). When the user enters a query, it is converted into a vector representation, and the most similar package descriptions are fetched from the vector database. Additional weight is given to the amount of weekly downloads before presenting the results to the user in a dashboard.

Expand Down

0 comments on commit c749e4f

Please sign in to comment.