Skip to content

Commit

Permalink
feat!: rename package
Browse files Browse the repository at this point in the history
  • Loading branch information
billsioros committed May 22, 2023
1 parent ac30472 commit 757d508
Show file tree
Hide file tree
Showing 18 changed files with 69 additions and 69 deletions.
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/bug_report.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ body:
description: Please provide the reproduction steps corresponding to the bug.
placeholder: Provide us with some python code!
value: |
from linqpy import linqpy
from querpyable import querpyable
render: python
validations:
required: true
Expand Down Expand Up @@ -74,7 +74,7 @@ body:
id: code-of-conduct
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct](https://billsioros.github.io/linqpy/latest/CODE_OF_CONDUCT/)
description: By submitting this issue, you agree to follow our [Code of Conduct](https://billsioros.github.io/querpyable/latest/CODE_OF_CONDUCT/)
options:
- label: I agree to follow this project's Code of Conduct
required: true
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
blank_issues_enabled: false
contact_links:
- name: Q&A
url: https://github.com/billsioros/linqpy/discussions/categories/q-a
url: https://github.com/billsioros/querpyable/discussions/categories/q-a
about: Please ask and answer questions here.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/docs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ body:
id: code-of-conduct
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct](https://billsioros.github.io/linqpy/latest/CODE_OF_CONDUCT/)
description: By submitting this issue, you agree to follow our [Code of Conduct](https://billsioros.github.io/querpyable/latest/CODE_OF_CONDUCT/)
options:
- label: I agree to follow this project's Code of Conduct
required: true
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/feature_request.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ body:
id: code-of-conduct
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct](https://billsioros.github.io/linqpy/latest/CODE_OF_CONDUCT/)
description: By submitting this issue, you agree to follow our [Code of Conduct](https://billsioros.github.io/querpyable/latest/CODE_OF_CONDUCT/)
options:
- label: I agree to follow this project's Code of Conduct
required: true
2 changes: 1 addition & 1 deletion .github/SECURITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,4 @@ include a fix for the issue generated with `git format-patch`. You may
include a name and link, if you would like to be credited for the report.

After fixing the issue, we will make a security release along with an
announcement on [GitHub Discussions](https://github.com/billsioros/linqpy/discussions).
announcement on [GitHub Discussions](https://github.com/billsioros/querpyable/discussions).
6 changes: 3 additions & 3 deletions .github/label-commenter-config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,10 @@ labels:
- name: ":no_entry_sign: invalid"
labeled:
issue:
body: Thank you @{{ issue.user.login }} for reporting this issue! Please follow the issue templates, as well as the [Contributing Guidelines](https://github.com/billsioros/linqpy/blob/master/docs/CONTRIBUTING.md).
body: Thank you @{{ issue.user.login }} for reporting this issue! Please follow the issue templates, as well as the [Contributing Guidelines](https://github.com/billsioros/querpyable/blob/master/docs/CONTRIBUTING.md).
action: close
pr:
body: Thank you @{{ pull_request.user.login }} for suggesting this. Please follow the pull request templates, as well as the [Contributing Guidelines](https://github.com/billsioros/linqpy/blob/master/docs/CONTRIBUTING.md).
body: Thank you @{{ pull_request.user.login }} for suggesting this. Please follow the pull request templates, as well as the [Contributing Guidelines](https://github.com/billsioros/querpyable/blob/master/docs/CONTRIBUTING.md).
action: close
unlabeled:
issue:
Expand Down Expand Up @@ -79,5 +79,5 @@ labels:
body: |
This issue has been **LOCKED** because it was considered off-topic.
Please refrain from submitting issues solely for questions you might have. Instead refer to the project's [discussion page](https://github.com/billsioros/linqpy/discussions/categories/q-a).
Please refrain from submitting issues solely for questions you might have. Instead refer to the project's [discussion page](https://github.com/billsioros/querpyable/discussions/categories/q-a).
action: close
2 changes: 1 addition & 1 deletion .github/workflows/codecov.yml
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,6 @@ jobs:
poetry install
- name: Generate the coverage report
run: |
poetry run python -m pytest -p no:sugar --cov=./src/linqpy --cov-report=xml
poetry run python -m pytest -p no:sugar --cov=./src/querpyable --cov-report=xml
- name: Upload coverage report
uses: codecov/codecov-action@v3
4 changes: 2 additions & 2 deletions .github/workflows/greetings.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,5 @@ jobs:
- uses: actions/first-interaction@v1
with:
repo-token: ${{ secrets.GITHUB_TOKEN }}
issue-message: "Thank you for contributing to **linqpy**! Please remember to reference our [Contributing Guidelines](https://github.com/billsioros/linqpy/blob/master/docs/CONTRIBUTING.md)."
pr-message: "Thank you for contributing to **linqpy**! Please remember to reference our [Contributing Guidelines](https://github.com/billsioros/linqpy/blob/master/docs/CONTRIBUTING.md)."
issue-message: "Thank you for contributing to **querpyable**! Please remember to reference our [Contributing Guidelines](https://github.com/billsioros/querpyable/blob/master/docs/CONTRIBUTING.md)."
pr-message: "Thank you for contributing to **querpyable**! Please remember to reference our [Contributing Guidelines](https://github.com/billsioros/querpyable/blob/master/docs/CONTRIBUTING.md)."
12 changes: 6 additions & 6 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,18 +8,18 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm

## v1.0.0 (2023-05-21)
### Feature
* Pypi name ([`08ab3fe`](https://github.com/billsioros/LinqPy/commit/08ab3feeef8a927552d597253571aa27e45ad29c))
* Pypi name ([`08ab3fe`](https://github.com/billsioros/Querpyable/commit/08ab3feeef8a927552d597253571aa27e45ad29c))

### Breaking
* pypi name ([`08ab3fe`](https://github.com/billsioros/LinqPy/commit/08ab3feeef8a927552d597253571aa27e45ad29c))
* pypi name ([`08ab3fe`](https://github.com/billsioros/Querpyable/commit/08ab3feeef8a927552d597253571aa27e45ad29c))

**[See all commits in this version](https://github.com/billsioros/LinqPy/compare/v0.1.0...v1.0.0)**
**[See all commits in this version](https://github.com/billsioros/Querpyable/compare/v0.1.0...v1.0.0)**

## v0.1.0 (2023-05-21)
### Feature
* Initial commit ([`0accfb4`](https://github.com/billsioros/linqpy/commit/0accfb461139970dffedcd4c5105d4008173f50e))
* Initial commit ([`0accfb4`](https://github.com/billsioros/querpyable/commit/0accfb461139970dffedcd4c5105d4008173f50e))

### Fix
* Aligning with the test suite ([`f7d8508`](https://github.com/billsioros/linqpy/commit/f7d8508218ccd7057042a87c424029d8c98382d6))
* Aligning with the test suite ([`f7d8508`](https://github.com/billsioros/querpyable/commit/f7d8508218ccd7057042a87c424029d8c98382d6))

**[See all commits in this version](https://github.com/billsioros/linqpy/compare/v0.0.0...v0.1.0)**
**[See all commits in this version](https://github.com/billsioros/querpyable/compare/v0.0.0...v0.1.0)**
40 changes: 20 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,46 +1,46 @@
<h1 align="center">LinqPy</h1>
<h1 align="center">Querpyable</h1>

<p align="center"><em>A Python implementation of LINQ</em></p>

<p align="center">
<a href="https://www.python.org/">
<img
src="https://img.shields.io/pypi/pyversions/linqpy"
src="https://img.shields.io/pypi/pyversions/querpyable"
alt="PyPI - Python Version"
/>
</a>
<a href="https://pypi.org/project/linqpy/">
<a href="https://pypi.org/project/querpyable/">
<img
src="https://img.shields.io/pypi/v/linqpy"
src="https://img.shields.io/pypi/v/querpyable"
alt="PyPI"
/>
</a>
<a href="https://github.com/billsioros/linqpy/actions/workflows/ci.yml">
<a href="https://github.com/billsioros/querpyable/actions/workflows/ci.yml">
<img
src="https://github.com/billsioros/linqpy/actions/workflows/ci.yml/badge.svg"
src="https://github.com/billsioros/querpyable/actions/workflows/ci.yml/badge.svg"
alt="CI"
/>
</a>
<a href="https://github.com/billsioros/linqpy/actions/workflows/cd.yml">
<a href="https://github.com/billsioros/querpyable/actions/workflows/cd.yml">
<img
src="https://github.com/billsioros/linqpy/actions/workflows/cd.yml/badge.svg"
src="https://github.com/billsioros/querpyable/actions/workflows/cd.yml/badge.svg"
alt="CD"
/>
</a>
<a href="https://results.pre-commit.ci/latest/github/billsioros/linqpy/master">
<a href="https://results.pre-commit.ci/latest/github/billsioros/querpyable/master">
<img
src="https://results.pre-commit.ci/badge/github/billsioros/linqpy/master.svg"
src="https://results.pre-commit.ci/badge/github/billsioros/querpyable/master.svg"
alt="pre-commit.ci status"
/>
</a>
<a href="https://codecov.io/gh/billsioros/linqpy">
<a href="https://codecov.io/gh/billsioros/querpyable">
<img
src="https://codecov.io/gh/billsioros/linqpy/branch/master/graph/badge.svg?token=coLOL0j6Ap"
src="https://codecov.io/gh/billsioros/querpyable/branch/master/graph/badge.svg?token=coLOL0j6Ap"
alt="Test Coverage"/>
</a>
<a href="https://opensource.org/licenses/MIT">
<img
src="https://img.shields.io/pypi/l/linqpy"
src="https://img.shields.io/pypi/l/querpyable"
alt="PyPI - License"
/>
</a>
Expand All @@ -55,7 +55,7 @@
src="https://img.shields.io/badge/cookiecutter-template-D4AA00.svg?style=flat&logo=cookiecutter"
alt="Cookiecutter Template">
</a>
<a href="https://app.renovatebot.com/dashboard#github/billsioros/linqpy">
<a href="https://app.renovatebot.com/dashboard#github/billsioros/querpyable">
<img
src="https://img.shields.io/badge/renovate-enabled-brightgreen.svg?style=flat&logo=renovatebot"
alt="Renovate - Enabled">
Expand All @@ -65,9 +65,9 @@
src="https://img.shields.io/badge/Buy%20me%20a-coffee-FFDD00.svg?style=flat&logo=buymeacoffee"
alt="Buy me a coffee">
</a>
<a href="https://app.fossa.com/projects/custom%2B27372%2Fgithub.com%2Fbillsioros%2Flinqpy/refs/branch/fix%2Fworking-version/f7d8508218ccd7057042a87c424029d8c98382d6">
<a href="https://app.fossa.com/projects/custom%2B27372%2Fgithub.com%2Fbillsioros%2Fquerpyable/refs/branch/fix%2Fworking-version/f7d8508218ccd7057042a87c424029d8c98382d6">
<img
src="https://app.fossa.com/api/projects/custom%2B27372%2Fgithub.com%2Fbillsioros%2Flinqpy.svg?type=shield"
src="https://app.fossa.com/api/projects/custom%2B27372%2Fgithub.com%2Fbillsioros%2Fquerpyable.svg?type=shield"
alt="FOSSA Status"
/>
</a>
Expand All @@ -87,7 +87,7 @@ Queryable \
## :cd: Installation

```bash
pip install linqpy
pip install querpyable
```

In order to locally set up the project please follow the instructions below:
Expand All @@ -99,7 +99,7 @@ git config --local user.name Vasilis Sioros
git config --local user.email [email protected]
git add .
git commit -m "feat: initial commit"
git remote add origin https://github.com/billsioros/linqpy
git remote add origin https://github.com/billsioros/querpyable

# Create a virtual environment using poetry and install the required dependencies
poetry shell
Expand All @@ -111,15 +111,15 @@ pre-commit install --install-hooks

## :book: Documentation

The project's documentation can be found [here](https://billsioros.github.io/linqpy/).
The project's documentation can be found [here](https://billsioros.github.io/querpyable/).

## :heart: Support the project

Feel free to [**Buy me a coffee! ☕**](https://www.buymeacoffee.com/billsioros).

## :sparkles: Contributing

If you would like to contribute to the project, please go through the [Contributing Guidelines](https://billsioros.github.io/linqpy/latest/CONTRIBUTING/) first.
If you would like to contribute to the project, please go through the [Contributing Guidelines](https://billsioros.github.io/querpyable/latest/CONTRIBUTING/) first.

## :label: Credits

Expand Down
22 changes: 11 additions & 11 deletions docs/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Contributing

Hello and thank you for considering contributing to **linqpy**!
Hello and thank you for considering contributing to **querpyable**!

Reading and following these guidelines will help us make the contribution process easy and effective for everyone involved.

Expand All @@ -12,7 +12,7 @@ By participating and contributing to this project, you agree to uphold our [Code

## Getting Help

In case all you need is an answer to a question, please refrain from opening an issue and instead visit the project's [discussion page](https://github.com/billsioros/linqpy/discussions/categories/q-a).
In case all you need is an answer to a question, please refrain from opening an issue and instead visit the project's [discussion page](https://github.com/billsioros/querpyable/discussions/categories/q-a).

## Getting Started

Expand All @@ -23,7 +23,7 @@ Contributions are made to this repository via Issues and Pull Requests (PRs). A

### Issues

[Issues](https://github.com/billsioros/linqpy/issues) should be used to report problems with the library or request a new feature or documentation change. When you create a new Issue, a template will be loaded that will guide you through collecting and providing the required information.
[Issues](https://github.com/billsioros/querpyable/issues) should be used to report problems with the library or request a new feature or documentation change. When you create a new Issue, a template will be loaded that will guide you through collecting and providing the required information.

If you find an Issue that addresses the problem you're having, please add your own reproduction information to the existing issue rather than creating a new one. Adding a [reaction](https://github.blog/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/) can also help in indicating to our maintainers that a particular problem is affecting more than just the reporter.

Expand All @@ -34,11 +34,11 @@ PRs can be a quick way to get your fix or improvement slated for the next releas
- Only fix/add the functionality in question **OR** address wide-spread whitespace/style issues, not both.
- Address a single concern in the least number of changed lines as possible.
- Be accompanied by a complete Pull Request template (loaded automatically when a PR is created).
- Add [unit or integration tests](https://github.com/billsioros/linqpy/tree/master/tests) for added or changed functionality.
- Add [unit or integration tests](https://github.com/billsioros/querpyable/tree/master/tests) for added or changed functionality.
- Any code related changes should be accompanied by corresponding changes to the project's documentation.
- If your pull request introduces a new feature, the corresponding `README` [section](https://billsioros.github.io/linqpy/latest/#features) must be updated to reflect this.
- If your pull request introduces a new feature, the corresponding `README` [section](https://billsioros.github.io/querpyable/latest/#features) must be updated to reflect this.
- Write clear, concise commit message(s) using the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) format. [Why?](#writing-your-commit-message)
- This project only accepts pull requests related to open issues. In case there is no relevant open issue, feel free to [create one](https://github.com/billsioros/linqpy/issues/new/choose).
- This project only accepts pull requests related to open issues. In case there is no relevant open issue, feel free to [create one](https://github.com/billsioros/querpyable/issues/new/choose).

For changes that address core functionality or would require breaking changes (e.g. a major release), it's best to open an Issue to discuss your proposal first. This is not required but can save time creating and reviewing changes.

Expand All @@ -49,19 +49,19 @@ In general, we follow the ["fork-and-pull" Git workflow](https://github.com/susa
3. Create a branch locally with a succinct but descriptive name
4. Commit changes to the branch
5. Push changes to your fork
6. [Open a PR in our repository](https://github.com/billsioros/linqpy/compare) and follow the PR template so that we can efficiently review the changes
6. [Open a PR in our repository](https://github.com/billsioros/querpyable/compare) and follow the PR template so that we can efficiently review the changes

## Setting up a local development environment

The following sections assume that you have already locally [cloned the repository](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/cloning-a-repository).

### Installing Poetry

The **linqpy** project utilizes the [Poetry](https://python-poetry.org/) Python package manager. [Having installed Poetry](https://python-poetry.org/docs/#installation) in the **global** namespace you may now run `poetry shell` to create a brand new [virtual environment](https://docs.python.org/3/tutorial/venv.html) and `poetry install`, in order to install the project's dependencies (development dependencies as well).
The **querpyable** project utilizes the [Poetry](https://python-poetry.org/) Python package manager. [Having installed Poetry](https://python-poetry.org/docs/#installation) in the **global** namespace you may now run `poetry shell` to create a brand new [virtual environment](https://docs.python.org/3/tutorial/venv.html) and `poetry install`, in order to install the project's dependencies (development dependencies as well).

### Installing pre-commit hooks

The project utilizes the [pre-commit](https://pre-commit.com/) framework. Having [created a virtual environment and installed the required dependencies](#installing-poetry), you may run `pre-commit install --install-hooks` to install the [git hook scripts](https://github.com/billsioros/linqpy/blob/master/.pre-commit-config.yaml).
The project utilizes the [pre-commit](https://pre-commit.com/) framework. Having [created a virtual environment and installed the required dependencies](#installing-poetry), you may run `pre-commit install --install-hooks` to install the [git hook scripts](https://github.com/billsioros/querpyable/blob/master/.pre-commit-config.yaml).

### Testing via `pytest`

Expand Down Expand Up @@ -90,13 +90,13 @@ Formatting, type-checking, running the test suite, as well as a few other operat

### Documenting your changes

**linqpy** utilizes [MkDocs](https://www.mkdocs.org/) to build and deploy its documentation to [GitHub Pages](https://pages.github.com/). The documentation is auto-generated from the [python docstrings](https://www.python.org/dev/peps/pep-0257/#id15) throughout the source code. As a result, any code related change should be accompanied by a corresponding change to the method's / class's docstring.
**querpyable** utilizes [MkDocs](https://www.mkdocs.org/) to build and deploy its documentation to [GitHub Pages](https://pages.github.com/). The documentation is auto-generated from the [python docstrings](https://www.python.org/dev/peps/pep-0257/#id15) throughout the source code. As a result, any code related change should be accompanied by a corresponding change to the method's / class's docstring.

Having made your changes, please run `poe docs` and make sure that no error is being raised on build time. Afterwards, open `http://localhost:8000/` in your browser of choice and make sure that the documentation renders correctly.

### Writing your commit message

The project's version number and [Changelog](https://github.com/billsioros/linqpy/blob/master/CHANGELOG.md), depend on a consistent commit history. As a result, your commit message's format is extremely important. Before opening a pull request, please make sure that your commits strictly follow the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) format].
The project's version number and [Changelog](https://github.com/billsioros/querpyable/blob/master/CHANGELOG.md), depend on a consistent commit history. As a result, your commit message's format is extremely important. Before opening a pull request, please make sure that your commits strictly follow the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) format].

### Creating a pull request

Expand Down
4 changes: 2 additions & 2 deletions docs/src/linqpy.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Documentation for `linqpy`
# Documentation for `querpyable`

::: linqpy.linqpy
::: querpyable.querpyable
Loading

0 comments on commit 757d508

Please sign in to comment.