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

WIP: First pass at a tutorial #120

Closed
wants to merge 1 commit into from
Closed

WIP: First pass at a tutorial #120

wants to merge 1 commit into from

Conversation

regularfry
Copy link
Contributor

Description

This patch gets as far as running a single-endpoint server and a test, in Docker, using docker-compose and an introduction to the predefined make tasks.

Context

Rather than have example code in the repository which is less representative than we want, and which requires following a pattern we might not want people to use, we can move those examples into a tutorial that walks people through the functionality and gives us a chance to explain the motivation behind some of the choices while clarifying which parts are framework and how the user is intended to interact with it.

Type of changes

  • Refactoring (non-breaking change)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would change existing functionality)
  • Bug fix (non-breaking change which fixes an issue)

Checklist

  • I am familiar with the contributing guidelines
  • I have followed the code style of the project
  • I have added tests to cover my changes
  • I have updated the documentation accordingly
  • This PR is a result of pair or mob programming

Sensitive Information Declaration

To ensure the utmost confidentiality and protect your and others privacy, we kindly ask you to NOT including PII (Personal Identifiable Information) / PID (Personal Identifiable Data) or any other sensitive data in this PR (Pull Request) and the codebase changes. We will remove any PR that do contain any sensitive information. We really appreciate your cooperation in this matter.

  • I confirm that neither PII/PID nor sensitive data are included in this PR and the codebase changes.

This patch gets as far as running a single-endpoint server and a test, in
Docker, using docker-compose and an introduction to the predefined `make`
tasks.
@regularfry regularfry requested a review from stefaniuk September 7, 2023 15:58
@@ -0,0 +1,360 @@
# Repository Template Tutorial
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could we convert this tutorial to use serverless technology, please? Let's consider using AWS Lambda or Azure Functions, or both.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My original plan was to use mangum to just mount the fastapi app as a Lambda event handler, but I'm not sure we should be pointing people at using a v0.17 project. It's been around for a few years - what do you think?

@regularfry
Copy link
Contributor Author

Closing this on the basis that it's since been rewritten.

@regularfry regularfry closed this Oct 18, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants