bite-core 0.1.0__py3-none-any.whl

bite/__init__.py

@@ -0,0 +1,7 @@
+from .bite import Bite
+
+__all__ = [
+	"Bite"
+]
+
+__version__ = "0.1.0"

bite/bite.py

@@ -0,0 +1,102 @@
+class Bite:
+	def __init__(self, structures=None, palettes=None):
+		self.sprites = {}
+		self.palettes = {}
+
+		if structures is not None:
+			for sprite_id, structure in structures.items():
+				self.add_sprite(sprite_id, structure)
+
+		if palettes is not None:
+			for palette_id, colors in palettes.items():
+				self.add_palette(palette_id, **colors)
+
+	def add_sprite(self, sprite_id, structure):
+		if sprite_id in self.sprites:
+			raise ValueError(f"Sprite ID {sprite_id!r} already exists.")
+
+		sprite = Sprite(structure)
+		self.sprites[sprite_id] = sprite
+
+		return sprite
+
+	def get_sprite(self, sprite_id):
+		return self.sprites[sprite_id]
+
+	def add_palette(self, palette_id, foreground="black", background=""):
+		if palette_id in self.palettes:
+			raise ValueError(f"Palette ID {palette_id!r} already exists.")
+
+		palette = Palette(foreground, background)
+		self.palettes[palette_id] = palette
+
+		return palette
+
+	def get_palette(self, palette_id):
+		return self.palettes[palette_id]
+		
+class Sprite:
+	def __init__(self, structure):
+		if not structure or not structure[0]:
+			raise ValueError("The sprite cannot be empty.")
+
+		width = len(structure[0])
+
+		for row in structure:
+			if len(row) != width:
+				raise ValueError("All rows must have the same length.")
+
+			for pixel in row:
+				if type(pixel) is not int or pixel not in (0, 1):
+					raise ValueError("Pixels must be integers: 0 or 1.")
+
+		self.structure = [list(row) for row in structure]
+		self.width = width
+		self.height = len(structure)
+		
+	def to_xbm(self):
+		values = []
+
+		for row in self.structure:
+			for start in range(0, self.width, 8):
+				byte = 0
+
+				for offset, pixel in enumerate(row[start:start + 8]):
+					byte |= pixel << offset
+
+				values.append(f"0x{byte:02x}")
+
+		return (
+			f"#define sprite_width {self.width}\n"
+			f"#define sprite_height {self.height}\n"
+			"static unsigned char sprite_bits[] = {\n"
+			+ ", ".join(values)
+			+ "\n};"
+		)
+		
+	def resize(self, width, height):
+		if type(width) is not int or type(height) is not int:
+			raise ValueError("Width and height must be integers.")
+
+		if width <= 0 or height <= 0:
+			raise ValueError("Width and height must be greater than zero.")
+
+		structure = []
+
+		for y in range(height):
+			source_y = y * self.height // height
+			row = []
+
+			for x in range(width):
+				source_x = x * self.width // width
+				pixel = self.structure[source_y][source_x]
+				row.append(pixel)
+
+			structure.append(row)
+
+		return Sprite(structure)
+		
+class Palette:
+	def __init__(self, foreground="black", background=""):
+		self.foreground = foreground
+		self.background = background

bite_core-0.1.0.dist-info/METADATA

@@ -0,0 +1,217 @@
+Metadata-Version: 2.4
+Name: bite-core
+Version: 0.1.0
+Summary: A lightweight library for managing binary sprites, palettes, resizing, and XBM conversion.
+Author: Brianna Ladson
+Keywords: bitmap,sprite,xbm,tkinter,pixel-art
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Multimedia :: Graphics
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# Bite v0.1.0
+
+Bite is a lightweight Python library for managing binary sprites and color palettes, resizing sprites, and converting them into XBM data for use with Tkinter.
+
+Define your sprites using 2D arrays of `0`s and `1`s, store them under unique IDs, and resize them to fit the pixel space you need.
+
+## Features
+
+- Store multiple sprites under unique IDs.
+- Define sprites using 2D arrays of binary integers.
+- Store reusable foreground and background palettes.
+- Resize sprites to an exact width and height using nearest-neighbor sampling.
+- Convert sprite structures into XBM strings without writing XBM files.
+- No third-party dependencies or Tkinter imports inside Bite.
+
+Bite handles data. Your application creates and displays the images.
+
+## Setup
+
+Place the package folder alongside your application:
+
+- `bite/__init__.py`
+- `bite/bite.py`
+- `main.py`
+
+Then import Bite:
+
+```python
+from bite import Bite
+```
+
+Bite itself uses standard Python features and requires no additional packages. The example below requires a Python installation with Tkinter available.
+
+## Quick Start
+
+```python
+from bite import Bite
+
+sprite_manager = Bite(
+	structures={
+		"house": [
+			[0, 0, 1, 0, 0],
+			[0, 1, 1, 1, 0],
+			[1, 1, 1, 1, 1],
+			[0, 1, 0, 1, 0],
+			[0, 1, 1, 1, 0],
+		],
+	},
+	palettes={
+		"parchment": {
+			"foreground": "#69432b",
+			"background": "#f3dfac",
+		},
+	},
+)
+
+sprite = sprite_manager.get_sprite("house")
+palette = sprite_manager.get_palette("parchment")
+
+resized_sprite = sprite.resize(width=150, height=150)
+bitmap_data = resized_sprite.to_xbm()
+```
+
+## Using Bite with Tkinter
+
+This complete example creates a sprite, applies a palette, and displays a resized bitmap on a canvas.
+
+```python
+from tkinter import Tk, Canvas, BitmapImage, BOTH
+from bite import Bite
+
+root = Tk()
+root.title("Bite Demo")
+
+canvas = Canvas(root, width=500, height=500)
+canvas.pack(fill=BOTH, expand=True)
+
+sprite_manager = Bite()
+
+sprite_manager.add_sprite("house", [
+	[0, 0, 1, 0, 0],
+	[0, 1, 1, 1, 0],
+	[1, 1, 1, 1, 1],
+	[0, 1, 0, 1, 0],
+	[0, 1, 1, 1, 0],
+])
+
+sprite_manager.add_palette(
+	"parchment",
+	foreground="#69432b",
+	background="#f3dfac",
+)
+
+sprite = sprite_manager.get_sprite("house")
+palette = sprite_manager.get_palette("parchment")
+resized_sprite = sprite.resize(150, 150)
+
+image = BitmapImage(
+	master=root,
+	data=resized_sprite.to_xbm(),
+	foreground=palette.foreground,
+	background=palette.background,
+)
+
+canvas.create_image(250, 250, image=image)
+
+root.mainloop()
+```
+
+Keep a Python reference to each `BitmapImage` while it is displayed. For multiple images, you can store references in a list or dictionary.
+
+## Sprite Structures
+
+Each inner list represents one row. All rows must have the same length, and every value must be the integer `0` or `1`.
+
+- `1` uses the image's foreground color.
+- `0` uses the image's background color.
+
+Empty structures, uneven rows, and values other than integer `0` or `1` raise `ValueError`.
+
+Bite copies the supplied rows when creating a sprite, so later changes to the original input array do not change the stored sprite.
+
+## Palettes
+
+Palettes store color strings independently of sprites. The same sprite can be displayed with multiple palettes, and the same palette can be used with multiple sprites.
+
+```python
+sprite_manager.add_palette(
+	"night",
+	foreground="lightblue",
+	background="midnightblue",
+)
+
+sprite_manager.add_palette(
+	"transparent",
+	foreground="darkgreen",
+	background="",
+)
+```
+
+Use an empty background string for transparent `0` pixels in Tkinter. Colors are passed through unchanged; Tkinter validates them when they are applied to an image.
+
+To change an existing Tkinter image's palette:
+
+```python
+palette = sprite_manager.get_palette("night")
+
+image.configure(
+	foreground=palette.foreground,
+	background=palette.background,
+)
+```
+
+Palette colors are supplied separately to `BitmapImage`; they are not embedded in the XBM string. Changing a stored palette does not automatically update existing images.
+
+## Resizing
+
+```python
+sprite = sprite_manager.get_sprite("house")
+resized_sprite = sprite.resize(width=200, height=100)
+```
+
+`resize()` returns a new sprite and leaves the original unchanged. Width and height must be positive integers.
+
+The sprite is stretched to exactly the requested dimensions. Each axis scales independently, so the original aspect ratio is not automatically preserved. Nearest-neighbor sampling keeps all pixels binary, although shrinking can remove small details.
+
+For repeated resizing, start from the original sprite rather than a previously resized version.
+
+## API Reference
+
+### Bite
+
+| Method | Description |
+| --- | --- |
+| `Bite(structures=None, palettes=None)` | Create a manager, optionally with dictionaries of sprite structures and palette settings. |
+| `add_sprite(sprite_id, structure)` | Create, store, and return a sprite. |
+| `get_sprite(sprite_id)` | Return a stored sprite. |
+| `add_palette(palette_id, foreground="black", background="")` | Create, store, and return a palette. |
+| `get_palette(palette_id)` | Return a stored palette. |
+
+Sprite IDs must be unique within `sprites`; palette IDs must be unique within `palettes`. The same ID can appear in both collections. Duplicate IDs raise `ValueError`; requesting a missing ID raises `KeyError`.
+
+### Sprite
+
+Sprite objects are created and returned by Bite.
+
+| Attribute or method | Description |
+| --- | --- |
+| `structure` | The stored 2D array of binary pixels. |
+| `width` | Width of the sprite in pixels. |
+| `height` | Height of the sprite in pixels. |
+| `resize(width, height)` | Return a new sprite at the requested dimensions. |
+| `to_xbm()` | Return an XBM-formatted string for the sprite. |
+
+### Palette
+
+Palette objects are created and returned by Bite.
+
+| Attribute | Description |
+| --- | --- |
+| `foreground` | Color used for `1` pixels. Defaults to `"black"`. |
+| `background` | Color used for `0` pixels. Defaults to `""`. |

bite_core-0.1.0.dist-info/RECORD

@@ -0,0 +1,7 @@
+bite/__init__.py,sha256=XRwgDss8fY_Uz0B9qNqFyPK9EWAJdsc7BMqgJliJLp4,74
+bite/bite.py,sha256=bQNtTByxxByPBGiLZ3_i1CXkVBHfvOfTyHLWZDj1a-0,2702
+bite_core-0.1.0.dist-info/licenses/LICENSE,sha256=zVxpmR7YCpe1B2Z4rb9TdaHHM1SG_OJgRwexIcxJWfo,1071
+bite_core-0.1.0.dist-info/METADATA,sha256=njO8XLNd5M-YkdRYHrfrQD9DJ8HTSEraBQRErGezbbw,6660
+bite_core-0.1.0.dist-info/WHEEL,sha256=mOdXR9C3wMVov7cSY8PY-XCzo3SmmWCHvGQr5csJoao,91
+bite_core-0.1.0.dist-info/top_level.txt,sha256=IT7j9yoYj5TGqEkIDx1s46OPJzrQsLtd42Hy66J6ybQ,5
+bite_core-0.1.0.dist-info/RECORD,,

bite_core-0.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (84.2.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

bite_core-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Brianna Ladson
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

bite_core-0.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+bite