YARSAW is an Async Python API Wrapper for the Random Stuff API.

Last update: Mar 27, 2022

Related tags

Overview

Yet Another Random Stuff API Wrapper - YARSAW

YARSAW is an Async Python API Wrapper for the Random Stuff API. This module makes it simpler for you to interact with the API and is easy to implement into your application.

Make sure to get an API Key from here before trying to access this module.

Changes

`1.0`

(stable)

Updated docs
Renamed functions in Client()
- ai -> get_ai_response()
- joke -> get_joke()
- fact -> get_fact()
- waifu -> get_waifu()
- image -> get_image()
- covid -> get_covid_stats()
- weather -> get_weather()
Added new function generate_uid()
Many more changes

Documentation

Make sure to read the docs at https://namantech.me/yarsaw.

Contributing

To contribute, fork the repo, make your changes, then start a Pull Request in the repo.

To-Do

Add docstrings to functions in client

Comments

AIResponse giving wrong age

Bot replies with correct birth year but not the correct age Code:

class AI(commands.Cog):
    def __init__(self, bot):
        self.bot = bot
        self.client = yarsaw.Client("RSA_TOKEN", "RAPID_API_TOKEN")

    @commands.Cog.listener()
    async def on_message(self, msg):
        if msg.author == self.bot.user:
          return
        
        elif msg.channel.id != 934805002499788852:
          return

        resp = await self.client.get_ai_response(message=msg.content, id=str(msg.author.id), bot_name="Chika-chan", bot_gender="female", bot_age="15", bot_birth_year=2006, bot_master="TheUnknown")

        resp = resp.AIResponse+ (" nya-" if random.randint(1,3)==1 else "")
        
        await msg.reply(resp)

good first issue answered api

opened by ghost 2

Bump sphinx from 4.4.0 to 5.3.0
Bumps sphinx from 4.4.0 to 5.3.0.

Release notes

Sourced from sphinx's releases.

v5.3.0

Changelog: https://www.sphinx-doc.org/en/master/changes.html

v5.2.3

Changelog: https://www.sphinx-doc.org/en/master/changes.html

v5.2.2

Changelog: https://www.sphinx-doc.org/en/master/changes.html

v5.2.1

Changelog: https://www.sphinx-doc.org/en/master/changes.html

v5.2.0

Changelog: https://www.sphinx-doc.org/en/master/changes.html

v5.1.1

Changelog: https://www.sphinx-doc.org/en/master/changes.html

v5.1.0

Changelog: https://www.sphinx-doc.org/en/master/changes.html

v5.0.2

Changelog: https://www.sphinx-doc.org/en/master/changes.html

v5.0.1

Changelog: https://www.sphinx-doc.org/en/master/changes.html

v5.0.0

No release notes provided.

v5.0.0b1

Changelog: https://www.sphinx-doc.org/en/master/changes.html

v4.5.0

Changelog: https://www.sphinx-doc.org/en/master/changes.html

Changelog

Sourced from sphinx's changelog.

Release 5.3.0 (released Oct 16, 2022)

#10759: LaTeX: add :confval:latex_table_style and support the 'booktabs', 'borderless', and 'colorrows' styles. (thanks to Stefan Wiehler for initial pull requests #6666, #6671)

#10840: One can cross-reference including an option value like :option:`--module=foobar```, :option:--module[=foobar]``` or ``:option:--module foobar```. Patch by Martin Liska.

#10881: autosectionlabel: Record the generated section label to the debug log.

#10268: Correctly URI-escape image filenames.

#10887: domains: Allow sections in all the content of all object description directives (e.g. :rst:dir:py:function). Patch by Adam Turner

Release 5.2.3 (released Sep 30, 2022)

#10878: Fix base64 image embedding in sphinx.ext.imgmath

#10886: Add :nocontentsentry: flag and global domain table of contents entry control option. Patch by Adam Turner

Release 5.2.2 (released Sep 27, 2022)

#10872: Restore link targets for autodoc modules to the top of content. Patch by Dominic Davis-Foster.

Release 5.2.1 (released Sep 25, 2022)

Bugs fixed

#10861: Always normalise the pycon3 lexer to pycon.

Fix using sphinx.ext.autosummary with modules containing titles in the module-level docstring.

Release 5.2.0.post0 (released Sep 24, 2022)

Recreated source tarballs for Debian maintainers.

Release 5.2.0 (released Sep 24, 2022)

Dependencies

#10356: Sphinx now uses declarative metadata with pyproject.toml to create packages, using PyPA's flit project as a build backend. Patch by

... (truncated)

Commits

c1f2a52 Bump to 5.3.0 final

10db540 Allow sections in object description directives (#10919)

0fd4539 Simplify bug report template

b58eb61 Update all GitHub actions workflows to Ubuntu latest

3e04952 Add sphinx-build --bug-report

fa6d425 URI-escape image filenames (#10268)

e008e16 Revert "Fix detection for out of date files (#9360)" (#10908)

cef1a03 Update image for LaTeX job (#10916)

b5ba1ed s/5.2.0/5.3.0 in various code comments as #10759 got merged in 5.3.0

3deb527 Update CHANGES for PR #10759

Additional commits viewable in compare view

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

@dependabot rebase will rebase this PR

@dependabot recreate will recreate this PR, overwriting any edits that have been made to it

@dependabot merge will merge this PR after your CI passes on it

@dependabot squash and merge will squash and merge this PR after your CI passes on it

@dependabot cancel merge will cancel a previously requested merge and block automerging

@dependabot reopen will reopen this PR if it is closed

@dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually

@dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

dependencies
opened by dependabot[bot] 1
Bump furo from 2022.3.4 to 2022.9.29
Bumps furo from 2022.3.4 to 2022.9.29.

Changelog

Sourced from furo's changelog.

Changelog

2022.09.29 -- Quaint Quartz

Add ability to set arbitrary URLs for edit button.

Add support for aligning text in MyST-parser generated tables.

2022.09.15 -- Pragmatic Pistachio

Add a minimum version constraint on pygments.

Add an explicit dependency on sass.

Change right sidebar title from "Contents" to "On this page".

Correctly position sidebars on small screens.

Correctly select only Furo's own svg in related pages nav.

Make numpy-style documentation headers consistent.

Retitle the reference section.

Update npm dependencies.

2022.06.21 -- Opulent Opal

Fix docutils <= 0.17.x compatibility.

Bump to the latest Node.js LTS.

2022.06.04.1 -- Naughty Nickel bugfix

Fix the URL used in the "Edit this page" for Read the Docs builds.

2022.06.04 -- Naughty Nickel

✨ Advertise Sphinx 5 compatibility.

✨ Change to basic-ng as the base theme (from {pypi}sphinx-basic-ng).

Document site-wide announcement banners.

Drop the pin on pygments.

Improve edit button, using basic-ng's edit-this-page component.

Tweak headings to better match what users expect.

Tweak how Sphinx's default HTML is rendered, using docutils post-transforms (this replaces parsing+modifying it with BeautifulSoup).

When built with docutils 0.18, footnotes are rendered differently and stylised differently in Furo.

2022.04.07 -- Magical Mauve

... (truncated)

Commits

1375f9d Prepare release: 2022.09.29

af43607 Update changelog

bc0fe52 Update user-facing documentation for edit button

509c558 Modernise the edit-this-page.html template

5a0ceca Add source_edit_link as a theme configuration parameter (#510)

52fc32f Build documentation in pull requests

149f77b Fix stylesheet for MyST tables

9af2e44 Support MyST table column alignment (#531)

82dd61c Back to development

08e6b38 Prepare release: 2022.09.15

Additional commits viewable in compare view

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

@dependabot rebase will rebase this PR

@dependabot recreate will recreate this PR, overwriting any edits that have been made to it

@dependabot merge will merge this PR after your CI passes on it

@dependabot squash and merge will squash and merge this PR after your CI passes on it

@dependabot cancel merge will cancel a previously requested merge and block automerging

@dependabot reopen will reopen this PR if it is closed

@dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually

@dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

dependencies
opened by dependabot[bot] 1
Bump sphinx from 4.4.0 to 5.2.3
Bumps sphinx from 4.4.0 to 5.2.3.

Release notes

Sourced from sphinx's releases.

v5.2.3

Changelog: https://www.sphinx-doc.org/en/master/changes.html

v5.2.2

Changelog: https://www.sphinx-doc.org/en/master/changes.html

v5.2.1

Changelog: https://www.sphinx-doc.org/en/master/changes.html

v5.2.0

Changelog: https://www.sphinx-doc.org/en/master/changes.html

v5.1.1

Changelog: https://www.sphinx-doc.org/en/master/changes.html

v5.1.0

Changelog: https://www.sphinx-doc.org/en/master/changes.html

v5.0.2

Changelog: https://www.sphinx-doc.org/en/master/changes.html

v5.0.1

Changelog: https://www.sphinx-doc.org/en/master/changes.html

v5.0.0

No release notes provided.

v5.0.0b1

Changelog: https://www.sphinx-doc.org/en/master/changes.html

v4.5.0

Changelog: https://www.sphinx-doc.org/en/master/changes.html

Changelog

Sourced from sphinx's changelog.

Release 5.2.3 (released Sep 30, 2022)

#10878: Fix base64 image embedding in sphinx.ext.imgmath

#10886: Add :nocontentsentry: flag and global domain table of contents entry control option. Patch by Adam Turner

Release 5.2.2 (released Sep 27, 2022)

#10872: Restore link targets for autodoc modules to the top of content. Patch by Dominic Davis-Foster.

Release 5.2.1 (released Sep 25, 2022)

Bugs fixed

#10861: Always normalise the pycon3 lexer to pycon.

Fix using sphinx.ext.autosummary with modules containing titles in the module-level docstring.

Release 5.2.0.post0 (released Sep 24, 2022)

Recreated source tarballs for Debian maintainers.

Release 5.2.0 (released Sep 24, 2022)

Dependencies

#10356: Sphinx now uses declarative metadata with pyproject.toml to create packages, using PyPA's flit project as a build backend. Patch by Adam Turner.

Deprecated

#10843: Support for HTML 4 output. Patch by Adam Turner.

Features added

#10738: napoleon: Add support for docstring types using 'of', like type of type. Example: tuple of int.

#10286: C++, support requires clauses not just between the template parameter lists and the declaration.

... (truncated)

Commits

cbb19d6 Bump to 5.2.3 final

650f63b Finer grained control over domain ToC entries (#10886)

6627618 imgmath: Fix embed mode (#10878)

a651e6b Bump to 5.2.2 final

335f335 Restore anchor links to top of module docstring

19c2783 Correct error in release date for Sphinx 5.2.1

635540c Restore anchor links to top of module docstring

89b4f14 Fix mypy violations for v0.981 (#10875)

e0dbbc5 Bump to 5.2.1 final

15c1cba Fix error in changelog for Sphinx 5.2.0

Additional commits viewable in compare view

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

@dependabot rebase will rebase this PR

@dependabot recreate will recreate this PR, overwriting any edits that have been made to it

@dependabot merge will merge this PR after your CI passes on it

@dependabot squash and merge will squash and merge this PR after your CI passes on it

@dependabot cancel merge will cancel a previously requested merge and block automerging

@dependabot reopen will reopen this PR if it is closed

@dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually

@dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

dependencies
opened by dependabot[bot] 1
Bump sphinx from 4.4.0 to 5.2.2
Bumps sphinx from 4.4.0 to 5.2.2.

Release notes

Sourced from sphinx's releases.

v5.2.2

Changelog: https://www.sphinx-doc.org/en/master/changes.html

v5.2.1

Changelog: https://www.sphinx-doc.org/en/master/changes.html

v5.2.0

Changelog: https://www.sphinx-doc.org/en/master/changes.html

v5.1.1

Changelog: https://www.sphinx-doc.org/en/master/changes.html

v5.1.0

Changelog: https://www.sphinx-doc.org/en/master/changes.html

v5.0.2

Changelog: https://www.sphinx-doc.org/en/master/changes.html

v5.0.1

Changelog: https://www.sphinx-doc.org/en/master/changes.html

v5.0.0

No release notes provided.

v5.0.0b1

Changelog: https://www.sphinx-doc.org/en/master/changes.html

v4.5.0

Changelog: https://www.sphinx-doc.org/en/master/changes.html

Changelog

Sourced from sphinx's changelog.

Release 5.2.2 (released Sep 27, 2022)

#10872: Restore link targets for autodoc modules to the top of content. Patch by Dominic Davis-Foster.

Release 5.2.1 (released Sep 25, 2022)

Bugs fixed

#10861: Always normalise the pycon3 lexer to pycon.

Fix using sphinx.ext.autosummary with modules containing titles in the module-level docstring.

Release 5.2.0.post0 (released Sep 24, 2022)

Recreated source tarballs for Debian maintainers.

Release 5.2.0 (released Sep 24, 2022)

Dependencies

#10356: Sphinx now uses declarative metadata with pyproject.toml to create packages, using PyPA's flit project as a build backend. Patch by Adam Turner.

Deprecated

#10843: Support for HTML 4 output. Patch by Adam Turner.

Features added

#10738: napoleon: Add support for docstring types using 'of', like type of type. Example: tuple of int.

#10286: C++, support requires clauses not just between the template parameter lists and the declaration.

#10755: linkcheck: Check the source URL of raw directives that use the url option.

#10781: Allow :rst:role:ref role to be used with definitions and fields.

#10717: HTML Search: Increase priority for full title and subtitle matches in search results

#10718: HTML Search: Save search result score to the HTML element for debugging

#10673: Make toctree accept 'genindex', 'modindex' and 'search' docnames

... (truncated)

Commits

a651e6b Bump to 5.2.2 final

335f335 Restore anchor links to top of module docstring

19c2783 Correct error in release date for Sphinx 5.2.1

635540c Restore anchor links to top of module docstring

89b4f14 Fix mypy violations for v0.981 (#10875)

e0dbbc5 Bump to 5.2.1 final

15c1cba Fix error in changelog for Sphinx 5.2.0

77cee67 Define extra indent as a class attribute

9ced736 Fix highlighting lexers

cd24c54 Bump to 5.2.0.post0 final

Additional commits viewable in compare view

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

@dependabot rebase will rebase this PR

@dependabot recreate will recreate this PR, overwriting any edits that have been made to it

@dependabot merge will merge this PR after your CI passes on it

@dependabot squash and merge will squash and merge this PR after your CI passes on it

@dependabot cancel merge will cancel a previously requested merge and block automerging

@dependabot reopen will reopen this PR if it is closed

@dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually

@dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

dependencies
opened by dependabot[bot] 1
Bump sphinx from 4.4.0 to 5.2.1
Bumps sphinx from 4.4.0 to 5.2.1.

Release notes

Sourced from sphinx's releases.

v5.2.1

Changelog: https://www.sphinx-doc.org/en/master/changes.html

v5.2.0

Changelog: https://www.sphinx-doc.org/en/master/changes.html

v5.1.1

Changelog: https://www.sphinx-doc.org/en/master/changes.html

v5.1.0

Changelog: https://www.sphinx-doc.org/en/master/changes.html

v5.0.2

Changelog: https://www.sphinx-doc.org/en/master/changes.html

v5.0.1

Changelog: https://www.sphinx-doc.org/en/master/changes.html

v5.0.0

No release notes provided.

v5.0.0b1

Changelog: https://www.sphinx-doc.org/en/master/changes.html

v4.5.0

Changelog: https://www.sphinx-doc.org/en/master/changes.html

Changelog

Sourced from sphinx's changelog.

Release 5.2.1 (released Sep 24, 2022)

Bugs fixed

#10861: Always normalise the pycon3 lexer to pycon.

Fix using sphinx.ext.autosummary with modules containing titles in the module-level docstring.

Release 5.2.0.post0 (released Sep 24, 2022)

Recreated source tarballs for Debian maintainers.

Release 5.2.0 (released Sep 24, 2022)

Dependencies

#10356: Sphinx now uses declarative metadata with pyproject.toml to create packages, using PyPA's flit project as a build backend. Patch by Adam Turner.

Deprecated

#10843: Support for HTML 4 output. Patch by Adam Turner.

Features added

#10738: napoleon: Add support for docstring types using 'of', like type of type. Example: tuple of int.

#10286: C++, support requires clauses not just between the template parameter lists and the declaration.

#10755: linkcheck: Check the source URL of raw directives that use the url option.

#10781: Allow :rst:role:ref role to be used with definitions and fields.

#10717: HTML Search: Increase priority for full title and subtitle matches in search results

#10718: HTML Search: Save search result score to the HTML element for debugging

#10673: Make toctree accept 'genindex', 'modindex' and 'search' docnames

#6316, #10804: Add domain objects to the table of contents. Patch by Adam Turner

#6692: HTML Search: Include explicit :rst:dir:index directive index entries in the search index and search results. Patch by Adam Turner

#10816: imgmath: Allow embedding images in HTML as base64

#10854: HTML Search: Use browser localstorage for highlight control, stop storing highlight parameters in URL query strings. Patch by Adam Turner.

... (truncated)

Commits

e0dbbc5 Bump to 5.2.1 final

15c1cba Fix error in changelog for Sphinx 5.2.0

77cee67 Define extra indent as a class attribute

9ced736 Fix highlighting lexers

cd24c54 Bump to 5.2.0.post0 final

911a5fe Bump to 5.2.0 final

bc59a1d Merge 5.1.2 CHANGES into 5.2.0

2f2bd55 Merge pull request #10859 from jfbu/latex_doc_tableofcontentshook

89a656d LaTeX: improved doc of \sphinxtableofcontents (closes #10858)

6508121 Docstring clarifications (#9877)

Additional commits viewable in compare view

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

@dependabot rebase will rebase this PR

@dependabot recreate will recreate this PR, overwriting any edits that have been made to it

@dependabot merge will merge this PR after your CI passes on it

@dependabot squash and merge will squash and merge this PR after your CI passes on it

@dependabot cancel merge will cancel a previously requested merge and block automerging

@dependabot reopen will reopen this PR if it is closed

@dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually

@dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

dependencies
opened by dependabot[bot] 1
Bump furo from 2022.3.4 to 2022.9.15
Bumps furo from 2022.3.4 to 2022.9.15.

Changelog

Sourced from furo's changelog.

Changelog

2022.09.15 -- Pragmatic Pistachio

Add a minimum version constraint on pygments.

Add an explicit dependency on sass.

Change right sidebar title from "Contents" to "On this page".

Correctly position sidebars on small screens.

Correctly select only Furo's own svg in related pages nav.

Make numpy-style documentation headers consistent.

Retitle the reference section.

Update npm dependencies.

2022.06.21 -- Opulent Opal

Fix docutils <= 0.17.x compatibility.

Bump to the latest Node.js LTS.

2022.06.04.1 -- Naughty Nickel bugfix

Fix the URL used in the "Edit this page" for Read the Docs builds.

2022.06.04 -- Naughty Nickel

✨ Advertise Sphinx 5 compatibility.

✨ Change to basic-ng as the base theme (from {pypi}sphinx-basic-ng).

Document site-wide announcement banners.

Drop the pin on pygments.

Improve edit button, using basic-ng's edit-this-page component.

Tweak headings to better match what users expect.

Tweak how Sphinx's default HTML is rendered, using docutils post-transforms (this replaces parsing+modifying it with BeautifulSoup).

When built with docutils 0.18, footnotes are rendered differently and stylised differently in Furo.

2022.04.07 -- Magical Mauve

✨ Make sphinx-copybutton look better.

Add margin to indentations in line blocks.

Add styling for non-arabic list styles

Add support for html_baseurl.

... (truncated)

Commits

08e6b38 Prepare release: 2022.09.15

9de7613 Update changelog

a064929 Tweak changelog content style

46f4adc Revert "Add initial theme.conf content for eventual ablog support"

45b839b Set a minimum constraint on pygments

a4af988 [pre-commit.ci] pre-commit autoupdate (#518)

a72186f [pre-commit.ci] pre-commit autoupdate (#504)

9f41ee6 Add initial theme.conf content for eventual ablog support

75e0361 Make numpy-style documentation headers consistent

9d280e6 [pre-commit.ci] pre-commit autoupdate (#487)

Additional commits viewable in compare view

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

@dependabot rebase will rebase this PR

@dependabot recreate will recreate this PR, overwriting any edits that have been made to it

@dependabot merge will merge this PR after your CI passes on it

@dependabot squash and merge will squash and merge this PR after your CI passes on it

@dependabot cancel merge will cancel a previously requested merge and block automerging

@dependabot reopen will reopen this PR if it is closed

@dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually

@dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

dependencies
opened by dependabot[bot] 1
Bump sphinx from 4.4.0 to 5.1.1
Bumps sphinx from 4.4.0 to 5.1.1.

Release notes

Sourced from sphinx's releases.

v5.1.1

Changelog: https://www.sphinx-doc.org/en/master/changes.html

v5.1.0

Changelog: https://www.sphinx-doc.org/en/master/changes.html

v5.0.2

Changelog: https://www.sphinx-doc.org/en/master/changes.html

v5.0.1

Changelog: https://www.sphinx-doc.org/en/master/changes.html

v5.0.0

No release notes provided.

v5.0.0b1

Changelog: https://www.sphinx-doc.org/en/master/changes.html

v4.5.0

Changelog: https://www.sphinx-doc.org/en/master/changes.html

Changelog

Sourced from sphinx's changelog.

Release 5.1.1 (released Jul 26, 2022)

Bugs fixed

#10701: Fix ValueError in the new deque based sphinx.ext.napolean iterator implementation.

#10702: Restore compatability with third-party builders.

Release 5.1.0 (released Jul 24, 2022)

Dependencies

#10656: Support Docutils 0.19_. Patch by Adam Turner.

.. _Docutils 0.19: https://docutils.sourceforge.io/RELEASE-NOTES.html#release-0-19-2022-07-05

Deprecated

#10467: Deprecated sphinx.util.stemmer in favour of snowballstemmer. Patch by Adam Turner.

#9856: Deprecated sphinx.ext.napoleon.iterators.

Features added

#10444: html theme: Allow specifying multiple CSS files through the stylesheet setting in theme.conf or by setting html_style to an iterable of strings.

#10366: std domain: Add support for emphasising placeholders in :rst:dir:option directives through a new :confval:option_emphasise_placeholders configuration option.

#10439: std domain: Use the repr of some variables when displaying warnings, making whitespace issues easier to identify.

#10571: quickstart: Reduce content in the generated conf.py file. Patch by Pradyun Gedam.

#10648: LaTeX: CSS-named-alike additional :ref:'sphinxsetup' <latexsphinxsetup> keys allow to configure four separate border-widths, four paddings, four corner radii, a shadow (possibly inset), colours for border, background, shadow for each of the code-block, topic, attention, caution, danger, error and warning directives.

#10655: LaTeX: Explain non-standard encoding in LatinRules.xdy

#10599: HTML Theme: Wrap consecutive footnotes in an <aside> element when using Docutils 0.18 or later, to allow for easier styling. This matches the behaviour introduced in Docutils 0.19. Patch by Adam Turner.

#10518: config: Add include_patterns as the opposite of exclude_patterns. Patch by Adam Turner.

... (truncated)

Commits

e712eae Bump to 5.1.1 final

0555345 Fix ValueError popping out in sphinx.ext.napoleon (#10709)

9845500 Improve support for deprecated builders without env arg (#10702)

cc1f6cb Bump to 5.1.0 final

8effd15 Update message catalogs (#10698)

e3337c7 Update include_patterns implementation (#10680)

89db13d Merge pull request #10676 from AA-Turner/authors

40caf0c Merge pull request #10696 from jfbu/latex_fix_for_old_latex

d1b4a75 LaTeX: fix another incompatibility with old pict2e LaTeX

faccc21 Fix #10695: old LaTeX does not allow @ifpackageloaded usage in body

Additional commits viewable in compare view

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

@dependabot rebase will rebase this PR

@dependabot recreate will recreate this PR, overwriting any edits that have been made to it

@dependabot merge will merge this PR after your CI passes on it

@dependabot squash and merge will squash and merge this PR after your CI passes on it

@dependabot cancel merge will cancel a previously requested merge and block automerging

@dependabot reopen will reopen this PR if it is closed

@dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually

@dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

dependencies
opened by dependabot[bot] 1
Bump sphinx from 4.4.0 to 5.1.0
Bumps sphinx from 4.4.0 to 5.1.0.

Release notes

Sourced from sphinx's releases.

v5.1.0

Changelog: https://www.sphinx-doc.org/en/master/changes.html

v5.0.2

Changelog: https://www.sphinx-doc.org/en/master/changes.html

v5.0.1

Changelog: https://www.sphinx-doc.org/en/master/changes.html

v5.0.0

No release notes provided.

v5.0.0b1

Changelog: https://www.sphinx-doc.org/en/master/changes.html

v4.5.0

Changelog: https://www.sphinx-doc.org/en/master/changes.html

Changelog

Sourced from sphinx's changelog.

Release 5.1.0 (released Jul 24, 2022)

Dependencies

#10656: Support Docutils 0.19_. Patch by Adam Turner.

.. _Docutils 0.19: https://docutils.sourceforge.io/RELEASE-NOTES.html#release-0-19-2022-07-05

Deprecated

#10467: Deprecated sphinx.util.stemmer in favour of snowballstemmer. Patch by Adam Turner.

#9856: Deprecated sphinx.ext.napoleon.iterators.

Features added

#10444: html theme: Allow specifying multiple CSS files through the stylesheet setting in theme.conf or by setting html_style to an iterable of strings.

#10366: std domain: Add support for emphasising placeholders in :rst:dir:option directives through a new :confval:option_emphasise_placeholders configuration option.

#10439: std domain: Use the repr of some variables when displaying warnings, making whitespace issues easier to identify.

#10571: quickstart: Reduce content in the generated conf.py file. Patch by Pradyun Gedam.

#10648: LaTeX: CSS-named-alike additional :ref:'sphinxsetup' <latexsphinxsetup> keys allow to configure four separate border-widths, four paddings, four corner radii, a shadow (possibly inset), colours for border, background, shadow for each of the code-block, topic, attention, caution, danger, error and warning directives.

#10655: LaTeX: Explain non-standard encoding in LatinRules.xdy

#10599: HTML Theme: Wrap consecutive footnotes in an <aside> element when using Docutils 0.18 or later, to allow for easier styling. This matches the behaviour introduced in Docutils 0.19. Patch by Adam Turner.

#10518: config: Add include_patterns as the opposite of exclude_patterns. Patch by Adam Turner.

Bugs fixed

#10594: HTML Theme: field term colons are doubled if using Docutils 0.18+

#10596: Build failure if Docutils version is 0.18 (not 0.18.1) due to missing Node.findall()

#10506: LaTeX: build error if highlighting inline code role in figure caption (refs: #10251)

#10634: Make -P (pdb) option work better with exceptions triggered from events

... (truncated)

Commits

cc1f6cb Bump to 5.1.0 final

8effd15 Update message catalogs (#10698)

e3337c7 Update include_patterns implementation (#10680)

89db13d Merge pull request #10676 from AA-Turner/authors

40caf0c Merge pull request #10696 from jfbu/latex_fix_for_old_latex

d1b4a75 LaTeX: fix another incompatibility with old pict2e LaTeX

faccc21 Fix #10695: old LaTeX does not allow @ifpackageloaded usage in body

afac558 Merge branch '5.0.x' into 5.x

94f62e7 Merge pull request #10693 from tk0miya/mypy-0.971

5b89c39 Fix mypy violations (with mypy-0.971)

Additional commits viewable in compare view

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

@dependabot rebase will rebase this PR

@dependabot recreate will recreate this PR, overwriting any edits that have been made to it

@dependabot merge will merge this PR after your CI passes on it

@dependabot squash and merge will squash and merge this PR after your CI passes on it

@dependabot cancel merge will cancel a previously requested merge and block automerging

@dependabot reopen will reopen this PR if it is closed

@dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually

@dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

dependencies
opened by dependabot[bot] 1
Bump furo from 2022.3.4 to 2022.6.21
Bumps furo from 2022.3.4 to 2022.6.21.

Changelog

Sourced from furo's changelog.

Changelog

2022.06.21 -- Opulent Opal

Fix docutils <= 0.17.x compatibility

Bump to the latest Node.js LTS

2022.06.04.1 -- Naughty Nickel bugfix

Fix the URL used in the "Edit this page" for Read the Docs builds.

2022.06.04 -- Naughty Nickel

✨ Advertise Sphinx 5 compatibility.

✨ Change to basic-ng as the base theme (from {pypi}sphinx-basic-ng).

Document site-wide announcement banners.

Drop the pin on pygments.

Improve edit button, using basic-ng's edit-this-page component.

Tweak headings to better match what users expect.

Tweak how Sphinx's default HTML is rendered, using docutils post-transforms (this replaces parsing+modifying it with BeautifulSoup).

When built with docutils 0.18, footnotes are rendered differently and stylised differently in Furo.

2022.04.07 -- Magical Mauve

✨ Make sphinx-copybutton look better.

Add margin to indentations in line blocks.

Add styling for non-arabic list styles

Add support for html_baseurl.

Improve "Edit this page" icon to be more accessible.

Improve html_sidebars example.

Tweak positioning of back to top on desktop.

2022.03.04 -- Lucent Lilac

Improve support for print media.

Reduce heading sizes for h3 and below.

Don't allow selecting headerlink content.

Improve how overflow wrapping is handled.

Add a reference from the configuration variables to the color customisation page.

2022.02.23 -- Keen Kobi

... (truncated)

Commits

a2e8f42 Prepare release: 2022.06.21

d4967e5 Update changelog

2969c23 [pre-commit.ci] pre-commit autoupdate (#455)

2365493 Use findall from docutils only if it's available

bb3c355 Merge pull request #450 from polyzen/patch-1

4fb1a74 Bump to the latest Node.js LTS

9970aac Back to development

1142fad Prepare release: 2022.06.04.1

211abb4 Update changelog

06cdba6 Fix the edit this page URL

Additional commits viewable in compare view

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

@dependabot rebase will rebase this PR

@dependabot recreate will recreate this PR, overwriting any edits that have been made to it

@dependabot merge will merge this PR after your CI passes on it

@dependabot squash and merge will squash and merge this PR after your CI passes on it

@dependabot cancel merge will cancel a previously requested merge and block automerging

@dependabot reopen will reopen this PR if it is closed

@dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually

@dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

dependencies
opened by dependabot[bot] 1
Bump sphinx from 4.4.0 to 5.0.2
Bumps sphinx from 4.4.0 to 5.0.2.

Release notes

Sourced from sphinx's releases.

v5.0.2

Changelog: https://www.sphinx-doc.org/en/master/changes.html

v5.0.1

Changelog: https://www.sphinx-doc.org/en/master/changes.html

v5.0.0

No release notes provided.

v5.0.0b1

Changelog: https://www.sphinx-doc.org/en/master/changes.html

v4.5.0

Changelog: https://www.sphinx-doc.org/en/master/changes.html

Changelog

Sourced from sphinx's changelog.

Release 5.0.2 (released Jun 17, 2022)

Features added

#10523: HTML Theme: Expose the Docutils's version info tuple as a template variable, docutils_version_info. Patch by Adam Turner.

Bugs fixed

#10538: autodoc: Inherited class attribute having docstring is documented even if :confval:autodoc_inherit_docstring is disabled

#10509: autosummary: autosummary fails with a shared library

#10497: py domain: Failed to resolve strings in Literal. Patch by Adam Turner.

#10523: HTML Theme: Fix double brackets on citation references in Docutils 0.18+. Patch by Adam Turner.

#10534: Missing CSS for nav.contents in Docutils 0.18+. Patch by Adam Turner.

Release 5.0.1 (released Jun 03, 2022)

Bugs fixed

#10498: gettext: TypeError is raised when sorting warning messages if a node has no line number. Patch by Adam Turner.

#10493: HTML Theme: :rst:dir:topic directive is rendered incorrectly with Docutils 0.18. Patch by Adam Turner.

#10495: IndexError is raised for a :rst:role:kbd role having a separator. Patch by Adam Turner.

Release 5.0.0 (released May 30, 2022)

Dependencies

5.0.0 b1

#10164: Support Docutils 0.18_. Patch by Adam Turner.

.. _Docutils 0.18: https://docutils.sourceforge.io/RELEASE-NOTES.html#release-0-18-2021-10-26

Incompatible changes

5.0.0 b1

... (truncated)

Commits

907d27d Bump to 5.0.2 final

ed69703 Update CHANGES for PR #10535

377d866 Merge pull request #10535 from AA-Turner/css-nav-contents

7096024 Update CHANGES for PR #10539

d045227 Merge pull request #10539 from AA-Turner/fix-inherited-attrs

29edce9 test: Add testcase for autodoc_inherit_docstring and attributes (refs: #10539)

3956cf2 Fix documenting inherited attributes

27f0532 Move aside.topic into the conditional blocks

5806f0a Add nav.contents everywhere that div.topic is used

8da2efb Rename CSS files to CSS template files

Additional commits viewable in compare view

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

@dependabot rebase will rebase this PR

@dependabot recreate will recreate this PR, overwriting any edits that have been made to it

@dependabot merge will merge this PR after your CI passes on it

@dependabot squash and merge will squash and merge this PR after your CI passes on it

@dependabot cancel merge will cancel a previously requested merge and block automerging

@dependabot reopen will reopen this PR if it is closed

@dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually

@dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

dependencies
opened by dependabot[bot] 1
Bump sphinx from 4.4.0 to 6.0.0
Bumps sphinx from 4.4.0 to 6.0.0.

Release notes

Sourced from sphinx's releases.

v6.0.0

Changelog: https://www.sphinx-doc.org/en/master/changes.html

v6.0.0b2

Changelog: https://www.sphinx-doc.org/en/master/changes.html

v6.0.0b1

Changelog: https://www.sphinx-doc.org/en/master/changes.html

v5.3.0

Changelog: https://www.sphinx-doc.org/en/master/changes.html

v5.2.3

Changelog: https://www.sphinx-doc.org/en/master/changes.html

v5.2.2

Changelog: https://www.sphinx-doc.org/en/master/changes.html

v5.2.1

Changelog: https://www.sphinx-doc.org/en/master/changes.html

v5.2.0

Changelog: https://www.sphinx-doc.org/en/master/changes.html

v5.1.1

Changelog: https://www.sphinx-doc.org/en/master/changes.html

v5.1.0

Changelog: https://www.sphinx-doc.org/en/master/changes.html

v5.0.2

Changelog: https://www.sphinx-doc.org/en/master/changes.html

v5.0.1

Changelog: https://www.sphinx-doc.org/en/master/changes.html

v5.0.0

No release notes provided.

v5.0.0b1

Changelog: https://www.sphinx-doc.org/en/master/changes.html

v4.5.0

Changelog: https://www.sphinx-doc.org/en/master/changes.html

Changelog

Sourced from sphinx's changelog.

Release 6.0.0 (released Dec 29, 2022)

Dependencies

#10468: Drop Python 3.6 support

#10470: Drop Python 3.7, Docutils 0.14, Docutils 0.15, Docutils 0.16, and Docutils 0.17 support. Patch by Adam Turner

Incompatible changes

#7405: Removed the jQuery and underscore.js JavaScript frameworks.

These frameworks are no longer be automatically injected into themes from Sphinx 6.0. If you develop a theme or extension that uses the jQuery, $, or $u global objects, you need to update your JavaScript to modern standards, or use the mitigation below.

The first option is to use the sphinxcontrib.jquery_ extension, which has been developed by the Sphinx team and contributors. To use this, add sphinxcontrib.jquery to the extensions list in conf.py, or call app.setup_extension("sphinxcontrib.jquery") if you develop a Sphinx theme or extension.

The second option is to manually ensure that the frameworks are present. To re-add jQuery and underscore.js, you will need to copy jquery.js and underscore.js from the Sphinx repository_ to your static directory, and add the following to your layout.html:

.. code-block:: html+jinja

{%- block scripts %} {{ super() }} {%- endblock %}

.. _sphinxcontrib.jquery: https://github.com/sphinx-contrib/jquery/

Patch by Adam Turner.

#10471, #10565: Removed deprecated APIs scheduled for removal in Sphinx 6.0. See :ref:dev-deprecated-apis for details. Patch by Adam Turner.

#10901: C Domain: Remove support for parsing pre-v3 style type directives and roles. Also remove associated configuration variables c_allow_pre_v3 and c_warn_on_allowed_pre_v3. Patch by Adam Turner.

Features added

... (truncated)

Commits

5b56a23 Bump to 6.0.0 final

f1d1e9c Update coverage workflow for Tox 4

66a738c Update coverage workflow for new configuration location

041e5f8 Add test coverage for 'today_fmt' reference substitution (#10980)

da25145 Remove unnecessary conditional import in sphinx.ext.napoleon (#11043)

45a0ea9 Migrate coveragepy config into pyproject.toml (#11025)

3ec54f1 Create a pydata_sphinx_theme section in usage examples (#11046)

32bce8f Copy edit the tutorial (#11049)

9844162 Fix example using add_config_value (#10937)

bf4a626 RTD builder: add graphviz depedendency (#11040)

Additional commits viewable in compare view

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

@dependabot rebase will rebase this PR

@dependabot recreate will recreate this PR, overwriting any edits that have been made to it

@dependabot merge will merge this PR after your CI passes on it

@dependabot squash and merge will squash and merge this PR after your CI passes on it

@dependabot cancel merge will cancel a previously requested merge and block automerging

@dependabot reopen will reopen this PR if it is closed

@dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually

@dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

dependencies
opened by dependabot[bot] 0
Bump furo from 2022.3.4 to 2022.12.7
Bumps furo from 2022.3.4 to 2022.12.7.

Changelog

Sourced from furo's changelog.

Changelog

2022.12.07 -- Reverent Raspberry

✨ Add support for Sphinx 6.

✨ Improve footnote presentation with docutils 0.18+.

Drop support for Sphinx 4.

Improve documentation about what the edit button does.

Improve handling of empty-flexboxes for better print experience on Chrome.

Improve styling for inline signatures.

Replace the meta generator tag with a comment.

Tweak labels with icons to prevent users selecting icons as text on touch.

2022.09.29 -- Quaint Quartz

Add ability to set arbitrary URLs for edit button.

Add support for aligning text in MyST-parser generated tables.

2022.09.15 -- Pragmatic Pistachio

Add a minimum version constraint on pygments.

Add an explicit dependency on sass.

Change right sidebar title from "Contents" to "On this page".

Correctly position sidebars on small screens.

Correctly select only Furo's own svg in related pages nav.

Make numpy-style documentation headers consistent.

Retitle the reference section.

Update npm dependencies.

2022.06.21 -- Opulent Opal

Fix docutils <= 0.17.x compatibility.

Bump to the latest Node.js LTS.

2022.06.04.1 -- Naughty Nickel bugfix

Fix the URL used in the "Edit this page" for Read the Docs builds.

2022.06.04 -- Naughty Nickel

... (truncated)

Commits

1034267 Prepare release: 2022.12.07

239e69f Update changelog

8faac34 Remove the no-longer-useful gh-pages workflow

faa27fb Fix the hyperlink warning

9849ec0 Forward the arguments to stb serve

e0dc9b8 [pre-commit.ci] pre-commit autoupdate (#588)

9842e25 Clarify what the edit button does (#587)

0d2cf0b [pre-commit.ci] pre-commit autoupdate (#578)

b7d8866 Revert "Document that GCC is using Furo! (#575)" (#577)

0ab12bb Improve footnote presentation with docutils 0.18+ (#576)

Additional commits viewable in compare view

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

@dependabot rebase will rebase this PR

@dependabot recreate will recreate this PR, overwriting any edits that have been made to it

@dependabot merge will merge this PR after your CI passes on it

@dependabot squash and merge will squash and merge this PR after your CI passes on it

@dependabot cancel merge will cancel a previously requested merge and block automerging

@dependabot reopen will reopen this PR if it is closed

@dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually

@dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

dependencies
opened by dependabot[bot] 0
Bump sphinx-copybutton from 0.5.0 to 0.5.1
Bumps sphinx-copybutton from 0.5.0 to 0.5.1.

Release notes

Sourced from sphinx-copybutton's releases.

v0.5.1

(full changelog)

ENH: Unselectable text is now also not highlighted when you manually highlight a code cell. Exclude unselectable text from being copied (update) #178 (@rkdarst)

ENH: After copying, the copybutton will disappear before the icon changes back if you are no longer hovering on the code cell. FIX: Make copybutton remain for a second during success #176 (@choldgraf)

MAINT: Add support for Python 3.10 #174 (@hugovk)

Changelog

Sourced from sphinx-copybutton's changelog.

v0.5.1 - 2022-11-15

(full changelog)

ENH: Unselectable text is now also not highlighted when you manually highlight a code cell. Exclude unselectable text from being copied (update) #178 (@rkdarst)

ENH: After copying, the copybutton will disappear before the icon changes back if you are no longer hovering on the code cell. FIX: Make copybutton remain for a second during success #176 (@choldgraf)

MAINT: Add support for Python 3.10 #174 (@hugovk)

Commits

4345c48 MAINT: Fix workflow trigger (#184)

a876d5f MAINT: Add workflow call so publishing works (#182)

66cfefe RLS: v0.5.1 and move Publish to PyPI action to dedicated file (#180)

e529aa0 FIX: Make copybutton remain for a second during success (#176)

403f289 [pre-commit.ci] pre-commit autoupdate (#177)

cd2440f ENH: Exclude unselectable text from being copied (update) (#178)

6599429 [pre-commit.ci] pre-commit autoupdate (#173)

3f45a0f MAINT: Add support for Python 3.10 (#174)

1fd5ca4 [pre-commit.ci] pre-commit autoupdate (#172)

f84c001 ⬆️ Bump ansi-regex from 3.0.0 to 3.0.1 (#171)

Additional commits viewable in compare view

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

@dependabot rebase will rebase this PR

@dependabot recreate will recreate this PR, overwriting any edits that have been made to it

@dependabot merge will merge this PR after your CI passes on it

@dependabot squash and merge will squash and merge this PR after your CI passes on it

@dependabot cancel merge will cancel a previously requested merge and block automerging

@dependabot reopen will reopen this PR if it is closed

@dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually

@dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

dependencies
opened by dependabot[bot] 0
Bump aiohttp from 3.8.1 to 3.8.3
Bumps aiohttp from 3.8.1 to 3.8.3.

Release notes

Sourced from aiohttp's releases.

3.8.3

.. attention::

This is the last :doc:aiohttp <index> release tested under Python 3.6. The 3.9 stream is dropping it from the CI and the distribution package metadata.

Bugfixes

Increased the upper boundary of the :doc:multidict:index dependency to allow for the version 6 -- by :user:hugovk.

It used to be limited below version 7 in :doc:aiohttp <index> v3.8.1 but was lowered in v3.8.2 via :pr:6550 and never brought back, causing problems with dependency pins when upgrading. :doc:aiohttp <index> v3.8.3 fixes that by recovering the original boundary of < 7. (#6950)

3.8.2 (2022-09-20, subsequently yanked on 2022-09-21)

.. note::

This release has some compatibility fixes for Python 3.11 but it may still have some quirks. Some tests are still flaky in the CI.

.. caution::

This release has been yanked from PyPI. Modern pip will not pick it up automatically. The reason is that is has multidict < 6 set in the distribution package metadata (see :pr:6950). Please, use aiohttp ~= 3.8.3, != 3.8.1 instead, if you can.

Bugfixes

Added support for registering :rfc:OPTIONS <9110#OPTIONS> HTTP method handlers via :py:class:~aiohttp.web.RouteTableDef. (#4663)

Started supporting :rfc:authority-form <9112#authority-form> and :rfc:absolute-form <9112#absolute-form> URLs on the server-side. (#6227)

Fixed Python 3.11 incompatibilities by using Cython 0.29.25. (#6396)

Extended the sock argument typing declaration of the

... (truncated)

Changelog

Sourced from aiohttp's changelog.

3.8.3 (2022-09-21)

.. attention::

This is the last :doc:aiohttp <index> release tested under Python 3.6. The 3.9 stream is dropping it from the CI and the distribution package metadata.

Bugfixes

Increased the upper boundary of the :doc:multidict:index dependency to allow for the version 6 -- by :user:hugovk.

It used to be limited below version 7 in :doc:aiohttp <index> v3.8.1 but was lowered in v3.8.2 via :pr:6550 and never brought back, causing problems with dependency pins when upgrading. :doc:aiohttp <index> v3.8.3 fixes that by recovering the original boundary of < 7. [#6950](https://github.com/aio-libs/aiohttp/issues/6950) <https://github.com/aio-libs/aiohttp/issues/6950>_

3.8.2 (2022-09-20, subsequently yanked on 2022-09-21)

Bugfixes

Support registering OPTIONS HTTP method handlers via RouteTableDef. [#4663](https://github.com/aio-libs/aiohttp/issues/4663) <https://github.com/aio-libs/aiohttp/issues/4663>_

Started supporting authority-form and absolute-form URLs on the server-side. [#6227](https://github.com/aio-libs/aiohttp/issues/6227) <https://github.com/aio-libs/aiohttp/issues/6227>_

Fix Python 3.11 alpha incompatibilities by using Cython 0.29.25 [#6396](https://github.com/aio-libs/aiohttp/issues/6396) <https://github.com/aio-libs/aiohttp/issues/6396>_

Remove a deprecated usage of pytest.warns(None) [#6663](https://github.com/aio-libs/aiohttp/issues/6663) <https://github.com/aio-libs/aiohttp/issues/6663>_

Fix regression where asyncio.CancelledError occurs on client disconnection. [#6719](https://github.com/aio-libs/aiohttp/issues/6719) <https://github.com/aio-libs/aiohttp/issues/6719>_

Export :py:class:~aiohttp.web.PrefixedSubAppResource under :py:mod:aiohttp.web -- by :user:Dreamsorcerer.

This fixes a regression introduced by :pr:3469. [#6889](https://github.com/aio-libs/aiohttp/issues/6889) <https://github.com/aio-libs/aiohttp/issues/6889>_

Dropped the :class:object type possibility from the :py:attr:aiohttp.ClientSession.timeout property return type declaration. [#6917](https://github.com/aio-libs/aiohttp/issues/6917) <https://github.com/aio-libs/aiohttp/issues/6917>_,

... (truncated)

Commits

30b7a4e Add a yanking caution message to v3.8.2 changelog

1827944 Stop including an empty changelog draft in Sphinx

58a4733 Mention that v3.8.2 has been yanked

13f50f9 Move the Python 3.6 attention box to v3.8.3

cb20fd2 Bump aiohttp to v3.8.3

50203c4 Increase the upper boundary of the multidict dependency allowing v6

ee5e951 Merge branch 'release/v3.8.2' into 3.8

3ef9cab Bump the hardcoded version to v3.8.2.post0.dev0

99c8d0d Brush up the changelog wording for v3.8.2

a56b31c Add a note about Python 3.6 in the changelog

Additional commits viewable in compare view

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

@dependabot rebase will rebase this PR

@dependabot recreate will recreate this PR, overwriting any edits that have been made to it

@dependabot merge will merge this PR after your CI passes on it

@dependabot squash and merge will squash and merge this PR after your CI passes on it

@dependabot cancel merge will cancel a previously requested merge and block automerging

@dependabot reopen will reopen this PR if it is closed

@dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually

@dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

dependencies
opened by dependabot[bot] 0

Releases(v2.1.0)

v2.1.0(Mar 27, 2022)
Hello! This new amazing release sets up the stage for the next major release - v3.0! v3.0 will come with a sync client, so hope you are excited. The code will become better and more readable too. Anyways, enough about the next release. This release brings ...

Changelog

Updated get_anime_gif() and get_joke() to accommodate the latest changes in the API. With this, YARSAW supports all 8 endpoints again!

Removed get_safe_joke(). You may blacklist tags instead.

Remove nested return type from get_animal_image() and get_anime_gif()

Edit dataclasses.

Dataclasses now have more pythonic parameters for ease of use.

Replaced headers with APIInfo, a nested dataclass with information about the response.

Various code changes and refactors.

Full Changelog: https://github.com/BruceCodesGithub/yarsaw/compare/v2.0.1...v2.1.0
Source code(tar.gz)
Source code(zip)
v2.0.1(Jan 27, 2022)
This is a small release with minor changes

Changes

Added support for /weather

Parameter base was removed from class Client

Error handling for incorrect API keys was improved

Source code(tar.gz)
Source code(zip)
2.0(Jan 8, 2022)
This is a major change! As many of you might know, Random Stuff API went though a major change - including shifting completely to RapidAPI to make payment and development easier. However, YARSAW updated its build accordingly to welcome the change. And now, working with YARSAW is better than ever because otherwise, working with the API would be very hard.

Changes

Aside from the functions being rewritten, some more changes are:

Docs were updated

Uses the ReadTheDocs theme for documentation

The documentation is no longer a single page, but a collection of pages.

Since the API now has more use of headers than ever (it returns the number of daily requests left), all methods return headers along with other data.

The Client class has one for initial parameter for the RapidAPI Key,

The generate_uid and format_joke methods are no longer async - them being async was useless.

New Docstrings and comments

RawClient was terminated.

And much more!

Full Changelog: https://github.com/BruceCodesGithub/yarsaw/compare/1.3...2.0
Source code(tar.gz)
Source code(zip)
1.3(Dec 12, 2021)
Changes

The Client class now returns objects which are easier to work with.

RawClient class can be used to return the raw JSON response from the API.

This is a major release because it uses dataclasses and objects and makes working with the API way easier. Also fixes a lot of mistakes.
Source code(tar.gz)
Source code(zip)
1.2(Nov 14, 2021)
1.2

A new stable version for YARSAW

Changes

Updated Docs - now view it here

Uses ReadTheDocs.

Uses Sphinx instead of MKDocs

Updated the docs to be more readable.

Is updated automatically with docstrings.

Covers all the methods. Fixed minor mistakes.

Created a Utils class, added format_joke() and generate_uid() to the Utils.

Added docstrings to all the methods.

Better code style.

Updated many other things.

Full Changelog: https://github.com/BruceCodesGithub/yarsaw/compare/1.0.1...1.2
Source code(tar.gz)
Source code(zip)
1.0.1(Nov 9, 2021)
Backend changes

(No need to update docs)

Moved constants to utils.py

Make a single client session in HTTPClient

Fixed mistake - said "yes" when API key was not provided

Renamed private vars from __var__ format to _var format.

Readme.md updates

Source code(tar.gz)
Source code(zip)
stable(Nov 9, 2021)

The first stable release of YARSAW.
Source code(tar.gz)
Source code(zip)