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

add index page for docs #14

Merged
merged 4 commits into from
Feb 7, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 11 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,9 @@ Documentation, contribution rules, process and the code itself (this includes th

## Installation

Install [Hatch](https://hatch.pypa.io/latest/install/#pipx).
```
pip install saleor-sdk-python
```

## Tooling

Expand All @@ -26,28 +28,32 @@ saleor-sdk tools decode-id VXNlcjoyMg==
saleor-sdk tools encode-id User 22
```

## Documentation
## Development

Install [Hatch](https://hatch.pypa.io/latest/install/#pipx).

### Documentation

```
hatch run docs:serve
```

and navigate to http://127.0.0.1:8000

## Tests
### Tests

```
hatch run test
```

## Build and deploy
### Build and deploy

```
hatch build -c
hatch publish
```

## Code style
### Code style

```
hatch run lint:fmt
Expand Down
105 changes: 105 additions & 0 deletions docs/assets/marina_logo.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
25 changes: 25 additions & 0 deletions docs/assets/marina_logo_black.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
26 changes: 26 additions & 0 deletions docs/assets/marina_logo_white.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/mirumee.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
21 changes: 21 additions & 0 deletions docs/css/extra.css
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;
}
27 changes: 26 additions & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,28 @@
# 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
Copy link
Contributor

Choose a reason for hiding this comment

The 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".

Copy link
Contributor

Choose a reason for hiding this comment

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

Decided to keep it here.
However when we will introduce docs for marina then we will decide to move it to introduction


- CLI with tooling that helps to decode Saleor IDs
- Crypto module helping with Saleor authentication, both JWT verification and webhook signature verification
- Marina module - more on that in a later time...

## Best served with

- https://ariadnegraphql.org/
- https://github.com/mirumee/ariadne-codegen
19 changes: 19 additions & 0 deletions docs/overrides/partials/copyright.html
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>
4 changes: 4 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -1,9 +1,13 @@
site_name: Saleor SDK Python
repo_url: https://github.com/mirumee/saleor-sdk-python
edit_uri: edit/main/docs/
copyright: Copyright &copy; 2024 - Mirumee Software

theme:
logo: /assets/marina_logo_white.svg
favicon: /assets/marina_logo.svg
name: material
custom_dir: docs/overrides
palette:
# Palette toggle for light mode
- media: "(prefers-color-scheme: light)"
Expand Down