diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..da69f9d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,28 @@ +--- +name: Bug report +about: Create a report to help us improve +title: "" +labels: bug +assignees: "" +--- + +**Version** +List the versions of all `flood` packages you are using. + + +**Platform** +The output of `uname -a` (UNIX), or version and 32 or 64-bit (Windows) + +**Description** +Enter your issue details here. +One way to structure the description: + +[short summary of the bug] + +I tried this code: + +[code sample that causes the bug] + +I expected to see this happen: [explanation] + +Instead, this happened: [explanation] diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..df05885 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,19 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: "" +labels: feature-request +assignees: "" +--- + +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered. + +**Additional context** +Add any other context or screenshots about the feature request here. diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md new file mode 100644 index 0000000..0052461 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question.md @@ -0,0 +1,9 @@ +--- +name: Question +about: Please use the Telegram group for questions +title: "" +labels: "" +assignees: "" +--- + +Please post your question as a discussion in Telegram: https://t.me/paradigm_flood diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..e3bcd5e --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,32 @@ + + +## Motivation + + + +## Solution + + + +## PR Checklist + +- [ ] Added Tests +- [ ] Added Documentation +- [ ] Breaking changes diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml new file mode 100644 index 0000000..656027b --- /dev/null +++ b/.github/workflows/lint.yml @@ -0,0 +1,9 @@ +name: Lint +on: [ push, pull_request ] + +jobs: + ruff: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + - uses: chartboost/ruff-action@v1 diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml new file mode 100644 index 0000000..2a4697b --- /dev/null +++ b/.github/workflows/tests.yml @@ -0,0 +1,29 @@ +name: Pytest + +on: + push: + branches: + - main + pull_request: + +jobs: + build: + + runs-on: ubuntu-latest + + steps: + - name: Checkout repository + uses: actions/checkout@v2 + + - name: Set up Python + uses: actions/setup-python@v2 + with: + python-version: 3.x # Specify the desired Python version + + - name: Install dependencies + run: | + python -m pip install --upgrade pip + pip install ./ + + - name: Run pytest + run: pytest diff --git a/README.md b/README.md index 40103ca..f9472b2 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,15 @@ -# 🌊🌊 flood 🌊🌊 +#

🌊🌊 flood 🌊🌊

-`flood` is a load testing tool for benchmarking EVM nodes over RPC +**`flood` is a load testing tool for benchmarking EVM nodes over RPC** + +![](./assets/cover.png) + +[![CI status](https://github.com/paradigmxyz/flood/workflows/Pytest/badge.svg)][gh-ci] +[![Telegram Chat][tg-badge]][tg-url] + +[gh-ci]: https://github.com/paradigmxyz/flood/actions/workflows/ci.yml +[tg-badge]: https://img.shields.io/endpoint?color=neon&logo=telegram&label=chat&url=https%3A%2F%2Ftg.sumanjay.workers.dev%2Fparadigm%5Fflood For each RPC method, `flood` measures how load affects metrics such as: 1. throughput diff --git a/assets/cover.png b/assets/cover.png new file mode 100644 index 0000000..cb42139 Binary files /dev/null and b/assets/cover.png differ diff --git a/pyproject.toml b/pyproject.toml index ad09e7f..955f6b0 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -72,3 +72,5 @@ line-length = 80 skip-string-normalization = true target-version = ['py37'] +[tool.ruff] +line-length = 80