philippabele / pythonic-api-design Goto Github PK

Split up your Readme

Your (main) readme.md file in ./readme.md should only contain a table of content

Please provide detailed information in the corresponding sub folder of your example.

A possible path to a detailed readme for the elastic example could look like this

• pythonic-api-design/02_simple_elastic_logging/readme.md

Create a simple model and make CRUD operations available at the API.

Persist the data at a postgreSQL db.

• Hint1
• Hint2

This site describes how to work with feature branches. Try it out on your own and send me your first pull request (PR).

I accepted your 3 PRs

• #22
• #24
• #23

There are now some merge conflicts. Please take care of them and resolve the conflicts.

Create a Github Actions Workflow in order to automatically build a documentation for the entire project.

This example could help you to set it up

https://github.com/philippabele/developers-guide-to-linux/blob/main/.github/workflows/compile-latex.yml

create a Markdown file with a list of interesting books

In order to make each single example isolated runable, it is necessary to split up the docker-compose file.

For developers looking for a distinct example, it is confusing to switch between the example directory and the root directory of this project.

Please provide for each single example an own detached docker compose file, which is independet from other examples.

This blog post helps to understand and use the concept of virtual environments and requirements.txt files.

Follow this tutorial to run the first test.

Follow this steps to init the project.

Good examples containt lots of comments.

Please comment your code to make it comprehensible

# Describe with simple words your code

This site will give you a first impression about what to do :)

add a very simple example.

just plain fastAPI to explain the structure of a project and to see how simple it is.

https://towardsdatascience.com/getting-started-with-elasticsearch-in-python-c3598e718380

pythonic-api-design/01_simple_crud_sql/readme.md is missing

https://medium.com/swlh/fastapi-microservice-patterns-application-monitoring-49fcb7341d9a

Expand your Readme by following a pattern for each readme:

• What is this example about? Describe the use case.
• How does the architecture of the example? Describe the microservices as well as their function
• How could one use your example? Describe how to set up and apply this example.

One of the main advantages of fastAPI is its capabilties of running concurrent code.

Mention in your example.md a good source for further reading, like this https://christophergs.com/tutorials/ultimate-fastapi-tutorial-pt-9-asynchronous-performance-basics/ on.

Get access to the eBook library and create a Markdown file with a list of interesting books.

https://fastapi.tiangolo.com/features/#pydantic-features

https://fastapi.tiangolo.com/python-types/?h=type+hint

The classic example for a REST api is a pet store.

Expand your example to become a pet store like this https://petstore.swagger.io/#/ on. But focus on CRUD functions for pets. Ignore store and user routes like on the mentioned swagger.io site.

Use black as the Python code formatter for this project.