Search through github issues and PRs like never before.

Navigation

Verified details

These details have been verified by PyPI
Project links
GitHub Statistics
Maintainers
Avatar for Sachahu from gravatar.com Sachahu

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • Author: Sacha hu
  • Maintainer: Sacha hu
  • Requires: Python <3.14, >=3.10
  • Provides-Extra: api , cpu , gpu
Classifiers
Report project as malware

Project description

Github-Search-Engine

GitHub Actions Workflow Status

GitHub Release PyPI - Python Version GitHub Repo stars

Getting Started

Installation

Installing the package (from PyPI)

You can install this package from PyPI using:

pip install Github-Search-Engine[cpu]

You can also choose to install extras:

pip install Github-Search-Engine[gpu,api]

Installing the package (from source)

You can install this package from source using:

pip install git+https://github.com/sachahu1/Github-Search-Engine.git

Installing the package (Manual)

You can also install the package yourself by cloning the repo:

git clone https://github.com/sachahu1/Github-Search-Engine.git

And installing the package with poetry:

poetry install

Using as a CLI tool

You can use this package as a CLI tool, start with:

github_search_engine -h

Once you're more familiar with the CLI, you can index your favourite GitHub repository:

github_search_engine index <owner> <repository_name> --db_path=./local-store --github_access_token=<Your GitHub Personal Access Token>

Then, search through any issue using:

github_search_engine search <owner> <repository_name> "<Your query>" --db_path=./local-store --github_access_token=<Your GitHub Personal Access Token>

Launching an API server

You can use this package as an API. To do that, simply run:

github_search_engine api --github_access_token=<Your GitHub Personal Access Token>

Building the documentation

Using Docker

To access the documentation locally, the easiest way is to use the docker image. To do so, simply run:

docker build . -f Dockerfile --target documentation -t github_search_engine-docs
docker run -p 80:80 -it github_search_engine-docs

Then navigate to http://localhost

Manually

Alternatively you can build the documentation yourself. First, make sure you have the dependencies installed:

poetry install --with=documentation

Then build the documentation:

poetry run sphinx-build -M html docs/source/ docs/build

Then open the documentation in your browser:

open docs/build/html/index.html

Project details

Verified details

These details have been verified by PyPI
Project links
GitHub Statistics
Maintainers
Avatar for Sachahu from gravatar.com Sachahu

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • Author: Sacha hu
  • Maintainer: Sacha hu
  • Requires: Python <3.14, >=3.10
  • Provides-Extra: api , cpu , gpu
Classifiers

Release history Release notifications | RSS feed

This version

0.3.0

0.3.0rc1 pre-release

0.2.3

0.2.3rc1 pre-release

0.2.2

0.2.2rc1 pre-release

0.2.1

0.2.1rc1 pre-release

0.2.0

0.2.0rc1 pre-release

0.1.0

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

github_search_engine-0.3.0.tar.gz (9.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

github_search_engine-0.3.0-py3-none-any.whl (12.1 kB view details)

Uploaded Python 3

File details

Details for the file github_search_engine-0.3.0.tar.gz.

File metadata

  • Download URL: github_search_engine-0.3.0.tar.gz
  • Upload date:
  • Size: 9.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for github_search_engine-0.3.0.tar.gz
Algorithm Hash digest
SHA256 92b2393ebcd5d5f7307564afd08053ec9c2daae719d010d1534035205117d665
MD5 d8195c7b9a511ad1848c6c06f0d2c1fc
BLAKE2b-256 2a4ef83d375682137837639048b41c30837c2eab4fc08093958fc6fce4e6d4b3

See more details on using hashes here.

Provenance

The following attestation bundles were made for github_search_engine-0.3.0.tar.gz:

Publisher: release.yaml on sachahu1/Github-Search-Engine

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file github_search_engine-0.3.0-py3-none-any.whl.

File metadata

File hashes

Hashes for github_search_engine-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 bb2fc06b15ba8ae2cb4c4818e55f0646a85bc40c84103b56bd474ad42f780bf4
MD5 032b1bd4b1c4203213bbd5de6bf61b92
BLAKE2b-256 0ebce21b391db1c3b25bb8b9b1a8c57c059b18f9687290e99dfe4156a91d39de

See more details on using hashes here.

Provenance

The following attestation bundles were made for github_search_engine-0.3.0-py3-none-any.whl:

Publisher: release.yaml on sachahu1/Github-Search-Engine

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page