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

Added typing and other small changes #3

Merged
merged 2 commits into from
Jun 17, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
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
162 changes: 161 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,162 @@
._*

# Byte-compiled / optimized / DLL files
__pycache__/
example_*
*.py[cod]
*$py.class

# C extensions
*.so

# Distribution / packaging
.Python
build/
develop-eggs/
dist/
downloads/
eggs/
.eggs/
lib/
lib64/
parts/
sdist/
var/
wheels/
share/python-wheels/
*.egg-info/
.installed.cfg
*.egg
MANIFEST

# PyInstaller
# Usually these files are written by a python script from a template
# before PyInstaller builds the exe, so as to inject date/other infos into it.
*.manifest
*.spec

# Installer logs
pip-log.txt
pip-delete-this-directory.txt

# Unit test / coverage reports
htmlcov/
.tox/
.nox/
.coverage
.coverage.*
.cache
nosetests.xml
coverage.xml
*.cover
*.py,cover
.hypothesis/
.pytest_cache/
cover/

# Translations
*.mo
*.pot

# Django stuff:
*.log
local_settings.py
db.sqlite3
db.sqlite3-journal

# Flask stuff:
instance/
.webassets-cache

# Scrapy stuff:
.scrapy

# Sphinx documentation
docs/_build/

# PyBuilder
.pybuilder/
target/

# Jupyter Notebook
.ipynb_checkpoints

# IPython
profile_default/
ipython_config.py

# pyenv
# For a library or package, you might want to ignore these files since the code is
# intended to run in multiple environments; otherwise, check them in:
# .python-version

# pipenv
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
# However, in case of collaboration, if having platform-specific dependencies or dependencies
# having no cross-platform support, pipenv may install dependencies that don't work, or not
# install all needed dependencies.
#Pipfile.lock

# poetry
# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
# This is especially recommended for binary packages to ensure reproducibility, and is more
# commonly ignored for libraries.
# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
#poetry.lock

# pdm
# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
#pdm.lock
# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
# in version control.
# https://pdm.fming.dev/#use-with-ide
.pdm.toml

# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
__pypackages__/

# Celery stuff
celerybeat-schedule
celerybeat.pid

# SageMath parsed files
*.sage.py

# Environments
.env
.venv
env/
venv/
ENV/
env.bak/
venv.bak/

# Spyder project settings
.spyderproject
.spyproject

# Rope project settings
.ropeproject

# mkdocs documentation
/site

# mypy
.mypy_cache/
.dmypy.json
dmypy.json

# Pyre type checker
.pyre/

# pytype static type analyzer
.pytype/

# Cython debug symbols
cython_debug/

# PyCharm
# JetBrains specific template is maintained in a separate JetBrains.gitignore that can
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
# and can be added to the global gitignore or merged into this file. For a more nuclear
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
#.idea/
23 changes: 23 additions & 0 deletions __main__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
from pysheeter.pysheeter import Sheet as SpriteSheet

# Simple PySheeter CLI
def main():
print("Welcome to the PySheeter CLI")

# Gather parameters from user input
folder = str(input("Enter path to folder of sprites:\n"))
ext = str(input("Enter the file extension of these sprites (without dot, 'png', 'jpg' etc.):\n"))
size = int(input("What width in pixels do you want each sprite to be? (1:1 aspect ratio):\n"))
vertical = not bool(input("Do you want a vertical sprite sheet? [Y,n]:\n"))
dest = str(input("Finally, enter a file name (or path) for the sprite sheet:\n"))

print("Reading sprites from folder...")
sheet = SpriteSheet(folder, ext)

print("Creating sprite sheet...")
sheet.put(dest, (size, size), vertical)

print("Done!")

if __name__ == "__main__":
main()
10 changes: 0 additions & 10 deletions example/example.py

This file was deleted.

Binary file removed example/files/1.png
Binary file not shown.
Binary file removed example/files/2.png
Binary file not shown.
Binary file removed example/files/3.png
Binary file not shown.
Binary file removed example/files/4.png
Binary file not shown.
Binary file removed example/files/5.png
Binary file not shown.
Binary file removed example/files/6.png
Binary file not shown.
Binary file removed example/files/7.png
Binary file not shown.
Binary file removed example/files/8.png
Binary file not shown.
Binary file removed example/files/9.png
Binary file not shown.
68 changes: 0 additions & 68 deletions pysheeter/PySheeter.py

This file was deleted.

Empty file added pysheeter/__init__.py
Empty file.
66 changes: 66 additions & 0 deletions pysheeter/pysheeter.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
from typing import Union
from pathlib import Path

from PIL import Image

# Create new sprite
class Sprite:
def __init__(self, image: str, resize: Union[tuple, list] = None):
self.image = Image.open(image).convert("RGBA")

# Resize image if necessary
if (resize):
self.resize(resize)

# Resize image without maintaining aspect ratio
def resize(self, size: Union[tuple, list], resample = Image.LANCZOS):
self.image = self.image.resize((size[0], size[1]), resample)

# --------------------------------

# Create new sheet of sprites
class Sheet:
def __init__(self, folder: str = None):
self.sprites = []

# Auto-import PNGs from folder
if(folder):
self.path = Path(folder).glob(f"**/*.png")
self.sprites = [x for x in self.path]

# Concatinate sprites vertically
def concat_vertical(self, size: Union[tuple, list]):
sheet_size = (size[0], size[1] * len(self.sprites))
sheet = Image.new("RGBA", sheet_size)

for i, sprite in enumerate(self.sprites):
sheet.paste(Sprite(sprite, size).image, (0, size[1] * i))

return sheet

# Concatinate sprites horizontally
def concat_horizontal(self, size: Union[tuple, list]):
sheet_size = (size[0] * len(self.sprites), size[1])
sheet = Image.new("RGBA", sheet_size)

for i, sprite in enumerate(self.sprites):
sheet.paste(Sprite(sprite, size).image, (size[0] * i, 0))

return sheet

# Add sprite by path
def add(self, path: str):
self.sprites.append(path)

# Remove sprite by path
def remove(self, path: str):
self.sprites.remove(path)

# Create and save spritesheet
def put(self, dest: str, size: Union[tuple, list], vertical: bool = True):
if(vertical):
sheet = self.concat_vertical(size)
else:
sheet = self.concat_horizontal(size)

sheet.save(dest)
2 changes: 2 additions & 0 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# The requirements in setup.py should also be updated when changing this
pillow
13 changes: 13 additions & 0 deletions setup.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
from setuptools import setup, find_packages

setup(
name = "pysheeter",
version = "1.1.0",
description = "Simple python library for creating sprite sheets from images",
author = "Victor Westerlund",
author_email = "[email protected]",
url = "https://github.com/victorwesterlund/reflect-client-python",
packages = ["pysheeter"],
# The requirement.txt file should also be updated when changing this
install_requires = ["pillow"]
)