https://github.com/mirumee/saleor-sdk-python
https://github.com/mirumee/saleor-sdk-python
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/mirumee/saleor-sdk-python
- Owner: mirumee
- License: bsd-3-clause
- Created: 2023-02-13T18:41:02.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-09-03T22:34:04.000Z (about 1 year ago)
- Last Synced: 2025-06-24T00:11:49.602Z (4 months ago)
- Language: Python
- Homepage: https://mirumee.github.io/saleor-sdk-python/examples/simple/
- Size: 587 KB
- Stars: 4
- Watchers: 4
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Saleor SDK Python
A set of tools that help Python developers work with Saleor. This is a very early stage in the life of this library and many things are not yet figured out.
Documentation, contribution rules, process and the code itself (this includes the APIs) are expected to change rapidly.
## Installation
```
pip install saleor-sdk-python
```
## Tooling
This library provides a CLI that contains a growing set of commands that are useful in day-to-day development around Saleor.
There are two entrypoints (here is a [good article](https://snarky.ca/why-you-should-use-python-m-pip/) on why this is important):
```sh
python -m saleor_sdk tools
saleor_sdk tools
```
### Saleor ID encoding
```sh
saleor-sdk tools decode-id VXNlcjoyMg==
saleor-sdk tools encode-id User 22
```
## Development
To contribute to this repository you will need Hatch to setup a local development environment.
Install [Hatch](https://hatch.pypa.io/latest/install/#pipx).
### Documentation
1. Run the below command to start a dev server with the documentation site:
```
hatch run docs:serve
```
Dev server provides a live reload on changes and lets you preview the site after it's published
and navigate to http://127.0.0.1:8000
### Tests
To run tests suite use the following command:
```
hatch run test
```
### Code style and linters
Use the following commands to format the code and lint it for issues:
```
hatch run lint:fmt
hatch run lint:all
```
### Build and deploy
To publish a new version to PyPI, update it's version number in the `pyproject/toml` file and create new github release.
In case whe you need to make a new release without GitHub workflow, use following `hatch` commands:
```
hatch build -c
hatch publish
```