diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml new file mode 100644 index 0000000..aa1891a --- /dev/null +++ b/.github/workflows/lint.yml @@ -0,0 +1,31 @@ +name: Lint + +on: + push: + branches: + - master + pull_request: + types: + - opened + - synchronize + +jobs: + lint: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - name: Set up Python + uses: actions/setup-python@v5 + with: + python-version: "3.11" + - uses: actions/cache@v3 + id: cache + with: + path: ${{ env.pythonLocation }} + key: ${{ runner.os }}-python-${{ env.pythonLocation }}-lint + - name: Install Dependencies + if: steps.cache.outputs.cache-hit != 'true' + run: pip install Pillow + - name: Lint + run: | + ruff check . --target-version py38 diff --git a/README.md b/README.md index d4fa456..9cc24f0 100644 --- a/README.md +++ b/README.md @@ -104,8 +104,7 @@ asyncio.run(main()) ``` > [!NOTE] -> Although `generate()`, `scale()` and `raw` are of type `PIL.Image.Image`, suitable for saving a file, it is better to -> use the built-in asynchronous `save` method instead. +> Although the methods `generate()`, `scale()` and the variable `raw` return values of type `PIL.Image.Image`, suitable for saving a file, it's advisable to use the built-in asynchronous save method instead. * Specifying a style @@ -119,7 +118,9 @@ totem.raw.save('totem.png') ``` > [!NOTE] -> The generate() method accepts **kwargs, which will be passed on to the style class. None of the built-in styles support them. +> The `generate()` method accepts **kwargs, which will be passed on to the style class. None of the built-in styles support them. + +> STTStyle taken from https://github.com/UnFamousSoul/STT ## Enum values