diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..04f83a1 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,33 @@ +> [!NOTE] +> Thank you for making change! Please consider filling this template for your pull request to improve quality of checkin message. + +> [!TIP] +> This repo uses [Conventional Commit conventions](https://www.conventionalcommits.org/en/v1.0.0/) - please try to rename your PR headline to match it. + +# Why this change is needed + +Describe what issue this change is trying to address. + +If this is a bug fix, please describe + +- How the bug was discovered. +- Is there a repro for the bug. + +# How + +Describe how the change works. + +- What are some considerations that the reviewer should be aware of. +- Are there other known solutions and why this one is picked of them all? + +# Test + +- What tests have been run? Please describe any verification steps you used. + +# Closes issue + +Please link the issue as follows: + +```text +"Fixes #520 - Add Python version requirements to documentation" +``` \ No newline at end of file diff --git a/.github/workflows/publish_to_pypi.yml b/.github/workflows/publish_to_pypi.yml deleted file mode 100644 index 70ef87c..0000000 --- a/.github/workflows/publish_to_pypi.yml +++ /dev/null @@ -1,21 +0,0 @@ -name: Publish Python package to PyPI - -on: - release: - types: [created] - -jobs: - build-and-publish: - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v4 - - name: Install uv - uses: astral-sh/setup-uv@v5 - - name: Build package - run: uv build - - name: Publish package to PyPI - uses: pypa/gh-action-pypi-publish@v1.13.0 - with: - user: ${{ secrets.PYPI_USERNAME }} - password: ${{ secrets.PYPI_PASSWORD }} - packages_dir: dist \ No newline at end of file diff --git a/LICENSE b/LICENSE index 7ac9f75..7965606 100644 --- a/LICENSE +++ b/LICENSE @@ -1,21 +1,21 @@ -MIT License + MIT License -Copyright (c) 2025 Miles Cole + Copyright (c) Microsoft Corporation. -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: + Permission is hereby granted, free of charge, to any person obtaining a copy + of this software and associated documentation files (the "Software"), to deal + in the Software without restriction, including without limitation the rights + to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + copies of the Software, and to permit persons to whom the Software is + furnished to do so, subject to the following conditions: -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. + The above copyright notice and this permission notice shall be included in all + copies or substantial portions of the Software. -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE. + THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + SOFTWARE \ No newline at end of file diff --git a/README.md b/README.md index 9f70f21..9ad658d 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,11 @@ -# LakeBench +# 🌊 LakeBench [![PyPI Release](https://img.shields.io/pypi/v/lakebench)](https://pypi.org/project/lakebench/) [![PyPI Downloads](https://img.shields.io/pepy/dt/lakebench.svg?label=PyPI%20Downloads)](https://pypi.org/project/lakebench/) +[![Python version](https://img.shields.io/pypi/pyversions/LakeBench)](https://pypi.org/project/LakeBench) +[![Tests](https://img.shields.io/github/actions/workflow/status/microsoft/LakeBench/tests.yml?logo=github&label=tests&branch=main)](https://github.com/microsoft/LakeBench/actions/workflows/tests.yml) -🌊 LakeBench is the first Python-based, multi-modal benchmarking framework designed to evaluate performance across multiple lakehouse compute engines and ELT scenarios. Supporting a variety of engines and both industry-standard and novel benchmarks, LakeBench enables comprehensive, apples-to-apples comparisons in a single, extensible Python library. + +LakeBench is the first Python-based, multi-modal benchmarking framework designed to evaluate performance across multiple lakehouse compute engines and ELT scenarios. Supporting a variety of engines and both industry-standard and novel benchmarks, LakeBench enables comprehensive, apples-to-apples comparisons in a single, extensible Python library. ## 🚀 The Mission of LakeBench LakeBench exists to bring clarity, trust, accessibility, and relevance to engine benchmarking by focusing on four core pillars: diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 0000000..e751608 --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,14 @@ + + +## Security + +Microsoft takes the security of our software products and services seriously, which +includes all source code repositories in our GitHub organizations. + +**Please do not report security vulnerabilities through public GitHub issues.** + +For security reporting information, locations, contact information, and policies, +please review the latest guidance for Microsoft repositories at +[https://aka.ms/SECURITY.md](https://aka.ms/SECURITY.md). + + \ No newline at end of file