-
Notifications
You must be signed in to change notification settings - Fork 1
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
add index page for docs #14
Changes from 3 commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,24 @@ | ||
header { | ||
border-bottom: 4px solid var(--md-accent-fg-color); | ||
} | ||
|
||
.md-copyright { | ||
width: 100%; | ||
} | ||
|
||
|
||
.md-copyright .made-with-love{ | ||
float: right; | ||
line-height: 24px; | ||
} | ||
|
||
.md-copyright .made-with-love .footer_mirumee_logo{ | ||
height: 24px; | ||
vertical-align: top; | ||
opacity: 0.7; | ||
} | ||
|
||
|
||
.md-copyright .made-with-love:hover .footer_mirumee_logo{ | ||
opacity: 1; | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,30 @@ | ||
# Introduction | ||
|
||
TDB... | ||
Saleor SDK Python is a Python library which purpose is to contain code that is repeated in different Saleor applications. | ||
KarolJagodzinski marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
You should read [Saleor's Documentation](https://docs.saleor.io/docs/3.x/developer/extending/overview) on the topic to get a grasp on the concepts of the "app framework" Saleor comes with. | ||
KarolJagodzinski marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
This SDK is agnostic of any framework, which makes it possible to use in all sorts of web (or otherwise) frameworks and even scripts. | ||
KarolJagodzinski marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
## What about Python App Framework? | ||
KarolJagodzinski marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
The old [saleor-app-framework-python](https://github.com/mirumee/saleor-app-framework-python) was very opinionated on how an application should be crated. It required FastAPI and in a specific version of it. | ||
KarolJagodzinski marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
## Installation | ||
|
||
``` | ||
pip install saleor-sdk-python | ||
``` | ||
|
||
## Key features | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I would consider dropping this part and moving 2-3 most important things from this to "introduction". There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Decided to keep it here. |
||
|
||
- CLI tools automating common development tasks: testing, linting and publication. | ||
- CLI utility for deserializing Saleor's GraphQL IDs values to reveal type names and their database IDs - helpful in debugging and local development. | ||
- | ||
- Crypto module helping with Saleor authentication, both JWT verification and webhook signature verification - provides a way to manage Saleor issued signatures | ||
- Marina module - more on that in a later time... | ||
|
||
## Best served with | ||
|
||
- https://ariadnegraphql.org/ | ||
- https://github.com/mirumee/ariadne-codegen |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
{#- | ||
This file was automatically generated - do not edit | ||
-#} | ||
<div class="md-copyright"> | ||
{% if config.copyright %} | ||
<div class="md-copyright__highlight"> | ||
{{ config.copyright }} | ||
</div> | ||
{% endif %} | ||
{% if not config.extra.generator == false %} | ||
Made with | ||
<a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener"> | ||
Material for MkDocs | ||
</a> | ||
{% endif %} | ||
<div class="md-copyright__highlight made-with-love"> | ||
<a href="https://mirumee.com">Saleor SDK Python is crafted with love by <img class="footer_mirumee_logo" src="/assets/mirumee.png" alt="Mirumee"></a> | ||
</div> | ||
</div> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This quite a busy sentence. Lets split it into two: