Skip to content

Commit

Permalink
update dev deps
Browse files Browse the repository at this point in the history
  • Loading branch information
FredHappyface committed Mar 17, 2024
1 parent 51095c7 commit bb6d220
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 14 deletions.
39 changes: 26 additions & 13 deletions documentation/reference/pylsr/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,14 +14,15 @@
- [LSRLayer().offsets](#lsrlayer()offsets)
- [flattenAll](#flattenall)
- [flattenTwoLayers](#flattentwolayers)
- [jsonLoadsFromArchive](#jsonloadsfromarchive)
- [rasterImageOffset](#rasterimageoffset)
- [read](#read)
- [renderImageOffset](#renderimageoffset)
- [write](#write)

## LSRImage

[Show source in __init__.py:15](../../../pylsr/__init__.py#L15)
[Show source in __init__.py:17](../../../pylsr/__init__.py#L17)

LSRImage contains data on the overall size, the layers and the name of the lsr image.

Expand All @@ -31,12 +32,12 @@ LSRImage contains data on the overall size, the layers and the name of the lsr i
class LSRImage:
def __init__(
self, size: tuple[int, int], name: str, layers: list[LSRLayer] | None = None
): ...
) -> None: ...
```

### LSRImage().flatten

[Show source in __init__.py:23](../../../pylsr/__init__.py#L23)
[Show source in __init__.py:25](../../../pylsr/__init__.py#L25)

Flatten all of the layers.

Expand All @@ -50,7 +51,7 @@ def flatten(self) -> Image.Image: ...

## LSRImageData

[Show source in __init__.py:67](../../../pylsr/__init__.py#L67)
[Show source in __init__.py:69](../../../pylsr/__init__.py#L69)

LSRImageData stores the PIL Image along with the name, scale of the image and the idiom.

Expand All @@ -65,12 +66,12 @@ class LSRImageData:
scale: str = "1x",
idiom: str = "universal",
offsets: tuple[int, int] = (0, 0),
): ...
) -> None: ...
```

### LSRImageData().scaledImage

[Show source in __init__.py:84](../../../pylsr/__init__.py#L84)
[Show source in __init__.py:86](../../../pylsr/__init__.py#L86)

Get the scaled image.

Expand All @@ -88,7 +89,7 @@ def scaledImage(self): ...

## LSRLayer

[Show source in __init__.py:31](../../../pylsr/__init__.py#L31)
[Show source in __init__.py:33](../../../pylsr/__init__.py#L33)

LSRLayer contains data on the layer such as the list of images, the name,
the size and the centre offset.
Expand All @@ -103,7 +104,7 @@ class LSRLayer:
name: str,
size: tuple[int, int],
center: tuple[int, int],
): ...
) -> None: ...
```

#### See also
Expand All @@ -112,7 +113,7 @@ class LSRLayer:

### LSRLayer().flatten

[Show source in __init__.py:62](../../../pylsr/__init__.py#L62)
[Show source in __init__.py:64](../../../pylsr/__init__.py#L64)

Flatten all of the layers.

Expand All @@ -124,7 +125,7 @@ def flatten(self) -> Image.Image: ...

### LSRLayer().offsets

[Show source in __init__.py:48](../../../pylsr/__init__.py#L48)
[Show source in __init__.py:50](../../../pylsr/__init__.py#L50)

Calculate the x, y offset for the top left corner.

Expand Down Expand Up @@ -207,11 +208,23 @@ def flattenTwoLayers(



## jsonLoadsFromArchive

[Show source in __init__.py:13](../../../pylsr/__init__.py#L13)

#### Signature

```python
def jsonLoadsFromArchive(x): ...
```



## rasterImageOffset

[Show source in __init__.py:275](../../../pylsr/__init__.py#L275)

Render an image with offset to a given size. (deprecated, use renderImageOffset)
Render an image with offset to a given size. (deprecated, use renderImageOffset).

#### Signature

Expand All @@ -226,7 +239,7 @@ def rasterImageOffset(

## read

[Show source in __init__.py:96](../../../pylsr/__init__.py#L96)
[Show source in __init__.py:98](../../../pylsr/__init__.py#L98)

Read an lsr file.

Expand Down Expand Up @@ -283,7 +296,7 @@ Write an lsr image to disk.
#### Signature

```python
def write(filename: str, lsrImage: LSRImage): ...
def write(filename: str, lsrImage: LSRImage) -> None: ...
```

#### See also
Expand Down
3 changes: 2 additions & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,10 @@ deprecation = "<3,>=2.1.0"
[tool.poetry.group.dev.dependencies]
imgcompare = "^2.0.1"
pytest = "^8.1.1"
pylint = "^3.1.0"
handsdown = "^2.1.0"
coverage = "^7.4.4"
ruff = "^0.3.3"
pyright = "^1.1.354"

[build-system]
requires = ["poetry-core"]
Expand Down

0 comments on commit bb6d220

Please sign in to comment.