https://github.com/quart-addons/quart-extension
Quart Extension development container template using poetry
https://github.com/quart-addons/quart-extension
dev-container github-template python3 quart quart-extension vscode vscode-devcontainer
Last synced: 8 months ago
JSON representation
Quart Extension development container template using poetry
- Host: GitHub
- URL: https://github.com/quart-addons/quart-extension
- Owner: Quart-Addons
- License: mit
- Created: 2023-11-23T23:15:07.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2023-11-26T21:59:35.000Z (about 2 years ago)
- Last Synced: 2025-04-19T13:36:02.070Z (9 months ago)
- Topics: dev-container, github-template, python3, quart, quart-extension, vscode, vscode-devcontainer
- Language: Dockerfile
- Homepage:
- Size: 13.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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.