twisted / twisted/klein

add tutorial showing how to build something useful with Twisted Klein

Open
#142 8 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

documentation
Dominant language
Python
Stars
838
Forks
123
Avg merge
7h 58m
Merged PRs (30d)
12

Description

Flask or Django have nice tutorials that guide users through building some simple web application. It should be rather simple to write something like this for Twisted Klein. It should show some basic functionality: handling requests, connecting to database, using html templates, returning error codes etc. It should also demonstrate how to use deferreds and async code in real life practical scenarios.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

No file, test, or documentation entry point is named in the issue. Start by locating the existing Klein documentation and examples, then outline a tutorial covering request handling, database access, HTML templates, error responses, and Deferred-based asynchronous code. Done means a complete practical tutorial demonstrates these requested scenarios.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation, web-dev
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.