Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Installation and Example Usage Documentation in README #5

Merged
merged 6 commits into from
Nov 24, 2023
Merged

Conversation

fullerzz
Copy link
Owner

No description provided.

@fullerzz fullerzz marked this pull request as draft November 23, 2023 19:04
@fullerzz fullerzz self-assigned this Nov 23, 2023
@fullerzz fullerzz added the documentation Improvements or additions to documentation label Nov 23, 2023
@fullerzz fullerzz marked this pull request as ready for review November 24, 2023 20:39
@fullerzz fullerzz merged commit 12a7aa0 into dev Nov 24, 2023
3 checks passed
@fullerzz fullerzz deleted the README branch November 24, 2023 20:40
fullerzz added a commit that referenced this pull request Nov 24, 2023
* Setup pre-commit hooks

* Updated path for ruff formatter

* initial readme commit - needs updating

* Updated return object for sendRequests; support for return_exceptions

* initial test setup

* Added tests that interact with test server

* Implemented PUT, PATCH, OPTIONS, DELETE; updated return type to dataclass

* isort formatting

* GitHub Actions + Ruff config

* initial commit of workflow

* Updated import path

* Updated braches config

* Updated RUFF linter config and added to GitHub Actions workflow

* Updated ignore config for Ruff

* Updated type annotations

* Test code formatting fixes

* Added badges to README

* Renamed workflow to CI

* Documentation for Installation and Example Usage in README (#5)

* Created 'Installing' and 'Usage' sections in README

* Added example in 'Usage' section

* Added 'Parsing Results' subsection

* Removed 'Parsing Results' subsection and added to 'Example' code block

* Setup PyPI Publishing from GitHub Actions Workflow (#4)

* Added release workflow to publish to pypi

* Updated version to 0.0.2

* Updated release workflow to only be triggered by pushed to main

* Fixed typo

* Renamed RequestResponse.responseBody -> RequestResponse.body

* uvloop is optional; defaults to asyncio (#9)

* Updated README and reset version to 0.0.1
fullerzz added a commit that referenced this pull request Nov 24, 2023
* Setup pre-commit hooks

* Updated path for ruff formatter

* initial readme commit - needs updating

* Updated return object for sendRequests; support for return_exceptions

* initial test setup

* Added tests that interact with test server

* Implemented PUT, PATCH, OPTIONS, DELETE; updated return type to dataclass

* isort formatting

* GitHub Actions + Ruff config

* initial commit of workflow

* Updated import path

* Updated braches config

* Updated RUFF linter config and added to GitHub Actions workflow

* Updated ignore config for Ruff

* Updated type annotations

* Test code formatting fixes

* Added badges to README

* Renamed workflow to CI

* Documentation for Installation and Example Usage in README (#5)

* Created 'Installing' and 'Usage' sections in README

* Added example in 'Usage' section

* Added 'Parsing Results' subsection

* Removed 'Parsing Results' subsection and added to 'Example' code block

* Setup PyPI Publishing from GitHub Actions Workflow (#4)

* Added release workflow to publish to pypi

* Updated version to 0.0.2

* Updated release workflow to only be triggered by pushed to main

* Fixed typo

* Renamed RequestResponse.responseBody -> RequestResponse.body

* uvloop is optional; defaults to asyncio (#9)

* Updated README and reset version to 0.0.1

* Increased version to 0.0.2.alpha
fullerzz added a commit that referenced this pull request Nov 24, 2023
* Setup pre-commit hooks

* Updated path for ruff formatter

* initial readme commit - needs updating

* Updated return object for sendRequests; support for return_exceptions

* initial test setup

* Added tests that interact with test server

* Implemented PUT, PATCH, OPTIONS, DELETE; updated return type to dataclass

* isort formatting

* GitHub Actions + Ruff config

* initial commit of workflow

* Updated import path

* Updated braches config

* Updated RUFF linter config and added to GitHub Actions workflow

* Updated ignore config for Ruff

* Updated type annotations

* Test code formatting fixes

* Added badges to README

* Renamed workflow to CI

* Documentation for Installation and Example Usage in README (#5)

* Created 'Installing' and 'Usage' sections in README

* Added example in 'Usage' section

* Added 'Parsing Results' subsection

* Removed 'Parsing Results' subsection and added to 'Example' code block

* Setup PyPI Publishing from GitHub Actions Workflow (#4)

* Added release workflow to publish to pypi

* Updated version to 0.0.2

* Updated release workflow to only be triggered by pushed to main

* Fixed typo

* Renamed RequestResponse.responseBody -> RequestResponse.body

* uvloop is optional; defaults to asyncio (#9)

* Updated README and reset version to 0.0.1

* Increased version to 0.0.2.alpha

* Updated  workflow to be triggered by releases
fullerzz added a commit that referenced this pull request Dec 15, 2023
* Setup pre-commit hooks

* Updated path for ruff formatter

* initial readme commit - needs updating

* Updated return object for sendRequests; support for return_exceptions

* initial test setup

* Added tests that interact with test server

* Implemented PUT, PATCH, OPTIONS, DELETE; updated return type to dataclass

* isort formatting

* GitHub Actions + Ruff config

* initial commit of workflow

* Updated import path

* Updated braches config

* Updated RUFF linter config and added to GitHub Actions workflow

* Updated ignore config for Ruff

* Updated type annotations

* Test code formatting fixes

* Added badges to README

* Renamed workflow to CI

* Documentation for Installation and Example Usage in README (#5)

* Created 'Installing' and 'Usage' sections in README

* Added example in 'Usage' section

* Added 'Parsing Results' subsection

* Removed 'Parsing Results' subsection and added to 'Example' code block

* Setup PyPI Publishing from GitHub Actions Workflow (#4)

* Added release workflow to publish to pypi

* Updated version to 0.0.2

* Updated release workflow to only be triggered by pushed to main

* Fixed typo

* Renamed RequestResponse.responseBody -> RequestResponse.body

* uvloop is optional; defaults to asyncio (#9)

* Updated README and reset version to 0.0.1

* Increased version to 0.0.2.alpha

* Updated  workflow to be triggered by releases

* Removed RequestResults

* Removed RequestResults

* Added test server written in python + additional tests

* Removed references to RequestResults

* Commenting tests until GitHub actions integration completed
fullerzz added a commit that referenced this pull request Dec 15, 2023
* project metadata updates

* Refactored Mechanism for Handling Exceptions Raised (#14)

* Setup pre-commit hooks

* Updated path for ruff formatter

* initial readme commit - needs updating

* Updated return object for sendRequests; support for return_exceptions

* initial test setup

* Added tests that interact with test server

* Implemented PUT, PATCH, OPTIONS, DELETE; updated return type to dataclass

* isort formatting

* GitHub Actions + Ruff config

* initial commit of workflow

* Updated import path

* Updated braches config

* Updated RUFF linter config and added to GitHub Actions workflow

* Updated ignore config for Ruff

* Updated type annotations

* Test code formatting fixes

* Added badges to README

* Renamed workflow to CI

* Documentation for Installation and Example Usage in README (#5)

* Created 'Installing' and 'Usage' sections in README

* Added example in 'Usage' section

* Added 'Parsing Results' subsection

* Removed 'Parsing Results' subsection and added to 'Example' code block

* Setup PyPI Publishing from GitHub Actions Workflow (#4)

* Added release workflow to publish to pypi

* Updated version to 0.0.2

* Updated release workflow to only be triggered by pushed to main

* Fixed typo

* Renamed RequestResponse.responseBody -> RequestResponse.body

* uvloop is optional; defaults to asyncio (#9)

* Updated README and reset version to 0.0.1

* Increased version to 0.0.2.alpha

* Updated  workflow to be triggered by releases

* Removed RequestResults

* Removed RequestResults

* Added test server written in python + additional tests

* Removed references to RequestResults

* Commenting tests until GitHub actions integration completed
fullerzz added a commit that referenced this pull request Dec 15, 2023
* project metadata updates

* Refactored Mechanism for Handling Exceptions Raised (#14)

* Setup pre-commit hooks

* Updated path for ruff formatter

* initial readme commit - needs updating

* Updated return object for sendRequests; support for return_exceptions

* initial test setup

* Added tests that interact with test server

* Implemented PUT, PATCH, OPTIONS, DELETE; updated return type to dataclass

* isort formatting

* GitHub Actions + Ruff config

* initial commit of workflow

* Updated import path

* Updated braches config

* Updated RUFF linter config and added to GitHub Actions workflow

* Updated ignore config for Ruff

* Updated type annotations

* Test code formatting fixes

* Added badges to README

* Renamed workflow to CI

* Documentation for Installation and Example Usage in README (#5)

* Created 'Installing' and 'Usage' sections in README

* Added example in 'Usage' section

* Added 'Parsing Results' subsection

* Removed 'Parsing Results' subsection and added to 'Example' code block

* Setup PyPI Publishing from GitHub Actions Workflow (#4)

* Added release workflow to publish to pypi

* Updated version to 0.0.2

* Updated release workflow to only be triggered by pushed to main

* Fixed typo

* Renamed RequestResponse.responseBody -> RequestResponse.body

* uvloop is optional; defaults to asyncio (#9)

* Updated README and reset version to 0.0.1

* Increased version to 0.0.2.alpha

* Updated  workflow to be triggered by releases

* Removed RequestResults

* Removed RequestResults

* Added test server written in python + additional tests

* Removed references to RequestResults

* Commenting tests until GitHub actions integration completed

* Added field to example in README and bumped version to 0.0.3
fullerzz added a commit that referenced this pull request Feb 5, 2024
* 0.0.3 (#16)

* project metadata updates

* Refactored Mechanism for Handling Exceptions Raised (#14)

* Setup pre-commit hooks

* Updated path for ruff formatter

* initial readme commit - needs updating

* Updated return object for sendRequests; support for return_exceptions

* initial test setup

* Added tests that interact with test server

* Implemented PUT, PATCH, OPTIONS, DELETE; updated return type to dataclass

* isort formatting

* GitHub Actions + Ruff config

* initial commit of workflow

* Updated import path

* Updated braches config

* Updated RUFF linter config and added to GitHub Actions workflow

* Updated ignore config for Ruff

* Updated type annotations

* Test code formatting fixes

* Added badges to README

* Renamed workflow to CI

* Documentation for Installation and Example Usage in README (#5)

* Created 'Installing' and 'Usage' sections in README

* Added example in 'Usage' section

* Added 'Parsing Results' subsection

* Removed 'Parsing Results' subsection and added to 'Example' code block

* Setup PyPI Publishing from GitHub Actions Workflow (#4)

* Added release workflow to publish to pypi

* Updated version to 0.0.2

* Updated release workflow to only be triggered by pushed to main

* Fixed typo

* Renamed RequestResponse.responseBody -> RequestResponse.body

* uvloop is optional; defaults to asyncio (#9)

* Updated README and reset version to 0.0.1

* Increased version to 0.0.2.alpha

* Updated  workflow to be triggered by releases

* Removed RequestResults

* Removed RequestResults

* Added test server written in python + additional tests

* Removed references to RequestResults

* Commenting tests until GitHub actions integration completed

* Added field to example in README and bumped version to 0.0.3

* Bump aiohttp from 3.8.6 to 3.9.0 (#17)

Bumps [aiohttp](https://github.com/aio-libs/aiohttp) from 3.8.6 to 3.9.0.
- [Release notes](https://github.com/aio-libs/aiohttp/releases)
- [Changelog](https://github.com/aio-libs/aiohttp/blob/master/CHANGES.rst)
- [Commits](aio-libs/aiohttp@v3.8.6...v3.9.0)

---
updated-dependencies:
- dependency-name: aiohttp
  dependency-type: direct:production
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Bump the pip group across 1 directories with 1 update

Bumps the pip group with 1 update in the /. directory: [aiohttp](https://github.com/aio-libs/aiohttp).


Updates `aiohttp` from 3.9.0 to 3.9.2
- [Release notes](https://github.com/aio-libs/aiohttp/releases)
- [Changelog](https://github.com/aio-libs/aiohttp/blob/master/CHANGES.rst)
- [Commits](aio-libs/aiohttp@v3.9.0...v3.9.2)

---
updated-dependencies:
- dependency-name: aiohttp
  dependency-type: direct:production
  dependency-group: pip-security-group
...

Signed-off-by: dependabot[bot] <support@github.com>

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: Zach Fuller <zach.fuller1222@gmail.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant