Skip to main content

Python CLI for marking duplicates submissions on GitHub.

Project description

dup_hawk

🦅 A bot the looks for duplicate issues on a GitHub repo, created especially for competitive security reviews.

dup-hawk

Getting Started

Requirements

  • git
    • You'll know you did it right if you can run git --version and you see a response like git version x.x.x
  • Python
    • You'll know you've installed python right if you can run:
      • python --version or python3 --version and get an output like: Python x.x.x
  • pipx
    • pipx is different from pip
    • You may have to close and re-open your terminal
    • You'll know you've installed it right if you can run:
      • pipx --version and see something like x.x.x.x
  • poetry
    • You'll know you've installed it right if you can run poetry --version and get an output like Poetry (version 1.4.2)

Installation

pipx

pipx install dup_hawk

From Source

git clone https://github.com/Cyfrin/dup-hawk
cd dup-hawk
pip install . -e

Quickstart

dup-hawk --help

To run the duplicate checker, run:

dup-hawk --git-repo-url {URL} --git-pat-token {PAT_TOKEN}

And you will have marked the issues on your github repo!

Tests

poetry run pytest

Integration tests

poetry run pytest -m ""

Specific tests with pdb and stdout

poetry run pytest -k "test_mark_duplicates_from_dfs" --pdb -s

Big TODO

Add mocking unit tests.

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

dup_hawk-0.0.12.tar.gz (5.3 kB view hashes)

Uploaded Source

Built Distribution

dup_hawk-0.0.12-py3-none-any.whl (6.6 kB view hashes)

Uploaded Python 3

Supported by

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