-
-
Notifications
You must be signed in to change notification settings - Fork 20
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit d7bae7d
Showing
11 changed files
with
350 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
# http://editorconfig.org | ||
|
||
root = true | ||
|
||
[*] | ||
indent_style = space | ||
indent_size = 4 | ||
trim_trailing_whitespace = true | ||
insert_final_newline = true | ||
charset = utf-8 | ||
end_of_line = lf | ||
|
||
[Makefile] | ||
indent_style = tab |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
github: frankie567 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,65 @@ | ||
name: Build | ||
|
||
on: [push, pull_request] | ||
|
||
jobs: | ||
test: | ||
|
||
runs-on: ubuntu-latest | ||
strategy: | ||
matrix: | ||
python_version: [3.7, 3.8, 3.9, '3.10', '3.11'] | ||
|
||
steps: | ||
- uses: actions/checkout@v3 | ||
- name: Set up Python | ||
uses: actions/setup-python@v4 | ||
with: | ||
python-version: ${{ matrix.python_version }} | ||
- name: Install dependencies | ||
run: | | ||
python -m pip install --upgrade pip | ||
pip install hatch | ||
hatch env create | ||
- name: Lint and typecheck | ||
run: | | ||
hatch run lint-check | ||
- name: Test | ||
run: | | ||
hatch run test-cov-xml | ||
- uses: codecov/codecov-action@v3 | ||
with: | ||
token: ${{ secrets.CODECOV_TOKEN }} | ||
fail_ci_if_error: true | ||
verbose: true | ||
|
||
release: | ||
runs-on: ubuntu-latest | ||
needs: test | ||
if: startsWith(github.ref, 'refs/tags/') | ||
|
||
steps: | ||
- uses: actions/checkout@v3 | ||
- name: Set up Python | ||
uses: actions/setup-python@v4 | ||
with: | ||
python-version: 3.7 | ||
- name: Install dependencies | ||
shell: bash | ||
run: | | ||
python -m pip install --upgrade pip | ||
pip install hatch | ||
- name: Build and publish on PyPI | ||
env: | ||
HATCH_INDEX_USER: ${{ secrets.HATCH_INDEX_USER }} | ||
HATCH_INDEX_AUTH: ${{ secrets.HATCH_INDEX_AUTH }} | ||
run: | | ||
hatch build | ||
hatch publish | ||
- name: Create release | ||
uses: ncipollo/release-action@v1 | ||
with: | ||
draft: true | ||
body: ${{ github.event.head_commit.message }} | ||
artifacts: dist/*.whl,dist/*.tar.gz | ||
token: ${{ secrets.GITHUB_TOKEN }} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,114 @@ | ||
# Byte-compiled / optimized / DLL files | ||
__pycache__/ | ||
*.py[cod] | ||
*$py.class | ||
|
||
# C extensions | ||
*.so | ||
|
||
# Distribution / packaging | ||
.Python | ||
env/ | ||
build/ | ||
develop-eggs/ | ||
dist/ | ||
downloads/ | ||
eggs/ | ||
.eggs/ | ||
lib/ | ||
lib64/ | ||
parts/ | ||
sdist/ | ||
var/ | ||
wheels/ | ||
*.egg-info/ | ||
.installed.cfg | ||
*.egg | ||
|
||
# PyInstaller | ||
# Usually these files are written by a python script from a template | ||
# before PyInstaller builds the exe, so as to inject date/other infos into it. | ||
*.manifest | ||
*.spec | ||
|
||
# Installer logs | ||
pip-log.txt | ||
pip-delete-this-directory.txt | ||
|
||
# Unit test / coverage reports | ||
htmlcov/ | ||
.tox/ | ||
.coverage | ||
.coverage.* | ||
.cache | ||
nosetests.xml | ||
coverage.xml | ||
*.cover | ||
.hypothesis/ | ||
.pytest_cache/ | ||
junit/ | ||
junit.xml | ||
test*.db* | ||
|
||
# Translations | ||
*.mo | ||
*.pot | ||
|
||
# Django stuff: | ||
*.log | ||
local_settings.py | ||
|
||
# Flask stuff: | ||
instance/ | ||
.webassets-cache | ||
|
||
# Scrapy stuff: | ||
.scrapy | ||
|
||
# Sphinx documentation | ||
docs/_build/ | ||
|
||
# PyBuilder | ||
target/ | ||
|
||
# Jupyter Notebook | ||
.ipynb_checkpoints | ||
|
||
# pyenv | ||
.python-version | ||
|
||
# celery beat schedule file | ||
celerybeat-schedule | ||
|
||
# SageMath parsed files | ||
*.sage.py | ||
|
||
# dotenv | ||
.env | ||
|
||
# virtualenv | ||
.venv | ||
venv/ | ||
ENV/ | ||
|
||
# Spyder project settings | ||
.spyderproject | ||
.spyproject | ||
|
||
# Rope project settings | ||
.ropeproject | ||
|
||
# mkdocs documentation | ||
/site | ||
|
||
# mypy | ||
.mypy_cache/ | ||
|
||
# OS files | ||
.DS_Store | ||
|
||
# .idea | ||
.idea/ | ||
|
||
# VSCode | ||
.vscode |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
MIT License | ||
|
||
Copyright (c) 2021 François Voron | ||
|
||
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 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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,45 @@ | ||
# httpx-ws | ||
|
||
WebSockets support for HTTPX | ||
|
||
[](https://github.com/frankie567/httpx-ws/actions) | ||
[](https://codecov.io/gh/frankie567/httpx-ws) | ||
[](https://badge.fury.io/py/httpx-ws) | ||
[](https://pepy.tech/project/httpx-ws) | ||
|
||
<p align="center"> | ||
<a href="https://github.com/sponsors/frankie567"><img src="https://md-btn.deta.dev/button.svg?text=Buy%20me%20a%20coffee%20%E2%98%95%EF%B8%8F&bg=ef4444&w=200&h=50"></a> | ||
</p> | ||
|
||
|
||
## Installation | ||
|
||
```bash | ||
pip install httpx-ws | ||
``` | ||
|
||
## Development | ||
|
||
### Setup environment | ||
|
||
We use [Hatch](https://hatch.pypa.io/latest/install/) to manage the development environment and production build. Ensure it's installed on your system. | ||
|
||
### Run unit tests | ||
|
||
You can run all the tests with: | ||
|
||
```bash | ||
hatch run test | ||
``` | ||
|
||
### Format the code | ||
|
||
Execute the following command to apply `isort` and `black` formatting: | ||
|
||
```bash | ||
hatch run lint | ||
``` | ||
|
||
## License | ||
|
||
This project is licensed under the terms of the MIT license. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
__version__ = "0.0.0" |
Empty file.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,79 @@ | ||
[tool.isort] | ||
profile = "black" | ||
|
||
[tool.pytest.ini_options] | ||
addopts = "--cov=httpx_ws/ --cov-report=term-missing" | ||
asyncio_mode = "auto" | ||
|
||
[tool.hatch] | ||
|
||
[tool.hatch.metadata] | ||
allow-direct-references = true | ||
|
||
[tool.hatch.version] | ||
source = "regex_commit" | ||
commit_extra_args = ["-e"] | ||
path = "httpx_ws/__init__.py" | ||
|
||
[tool.hatch.envs.default] | ||
dependencies = [ | ||
"black", | ||
"isort", | ||
"mypy", | ||
"ruff", | ||
"pytest", | ||
"pytest-asyncio", | ||
"pytest-cov", | ||
] | ||
|
||
[tool.hatch.envs.default.scripts] | ||
test = "pytest" | ||
test-cov-xml = "pytest --cov-report=xml" | ||
lint = [ | ||
"isort ./httpx_ws ./tests", | ||
"black .", | ||
"ruff --fix .", | ||
"mypy httpx_ws/", | ||
] | ||
lint-check = [ | ||
"isort --check-only ./httpx_ws ./tests", | ||
"black --check .", | ||
"ruff .", | ||
"mypy httpx_ws/", | ||
] | ||
|
||
[tool.hatch.build.targets.sdist] | ||
support-legacy = true # Create setup.py | ||
|
||
[build-system] | ||
requires = ["hatchling", "hatch-regex-commit"] | ||
build-backend = "hatchling.build" | ||
|
||
[project] | ||
name = "httpx-ws" | ||
authors = [ | ||
{ name = "François Voron", email = "fvoron@gmail.com" } | ||
] | ||
description = "WebSockets support for HTTPX" | ||
readme = "README.md" | ||
dynamic = ["version"] | ||
classifiers = [ | ||
"License :: OSI Approved :: MIT License", | ||
"Development Status :: 4 - Beta", | ||
"Framework :: AsyncIO", | ||
"Intended Audience :: Developers", | ||
"Programming Language :: Python :: 3.7", | ||
"Programming Language :: Python :: 3.8", | ||
"Programming Language :: Python :: 3.9", | ||
"Programming Language :: Python :: 3.10", | ||
"Programming Language :: Python :: 3 :: Only", | ||
"Topic :: Internet :: WWW/HTTP :: Session", | ||
] | ||
requires-python = ">=3.7" | ||
dependencies = [ | ||
"httpx" | ||
] | ||
|
||
[project.urls] | ||
Documentation = "https://github.com/frankie567/httpx-ws" | ||
Source = "https://github.com/frankie567/httpx-ws" |
Empty file.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
import asyncio | ||
|
||
import pytest | ||
|
||
|
||
@pytest.fixture(scope="session") | ||
def event_loop(): | ||
"""Force the pytest-asyncio loop to be the main one.""" | ||
loop = asyncio.get_event_loop() | ||
yield loop |