Skip to content

Quart Extension development container template using poetry

License

Notifications You must be signed in to change notification settings

Quart-Addons/quart-extension

Repository files navigation

Quart Extension Repository Template

This repoistory is used as a template to build new Quart extensions using VS Code, Dev Containers, and Poetry.

Project Required Changes

quart_ext folder

There is currently a dummy quart extension package folder named quart_ext with an init.py file. This is just for testing the dev container with Poetry. Please rename for your extension.

Make sure you read the edits required under the Poetry section to see what you need to change in your pyproject.toml file for your quart extension package folder.

Poetry - pyproject.toml

There is already a pyproject.toml file created as part of this repository template. All you need to do is add your dependencies for your extension. Also, make sure you add your required development dependencies as well.

You will also need to change/edit the following in pyproject.toml file:

  • tool.poetry
    • name: To match your extension name
    • version: To match the current version of your extension.
    • description: The description of your extension.
    • authors: The author(s) of your extension.
    • license: The license you use.
  • tool.isort
    • known_first_party: You need to change quart_ext to match your package.
  • tool.poetry.dependencies: Only quart is included.
  • tool.poetry.group.dependencies: The following are already included.
    • pytest
    • pytest-asyncio
    • sphinx
    • pydata-sphinx-theme - Remove this if not using this template. Make sure to change docs/requirements.txt file to reflect this change as well.

Sphinx docs

There is already a docs folder setup with a requirements.txt file included. Make changes that you require for your extension.

Also, in the root of the repository there is .readthedocs.yml file for readthedocs. Change to fit your needs as well.

Logo Folder

There is a logo folder setup in the root of the repository. We use this to store the logo image files for the extension. You can delete this if you don't need it.