bitmapmaker - pypi Package Compare versions

Comparing version 1.0.1 to 1.0.2

.gitignore

@@ -6,2 +6,3 @@ **/dist
 **/__pycache__
-**/.venv
+**/.venv
+**/.pytest_cache

PKG-INFO

 Metadata-Version: 2.4
 Name: bitmapmaker
-Version: 1.0.1
+Version: 1.0.2
 Summary: A package for creating your own custom bitmaps from a windows GUI.
@@ -17,5 +17,50 @@ Project-URL: Homepage, https://github.com/Ruxton07/bitmapmaker
 
-This is a package that opens a windows GUI in which you can toggle squares on/off as you please (including bulk area selection). Once you submit, it will show you visually in a 2D array what your resulting bitmap looks like, as well as paste the python 2D array into a terminal which you can copy as needed.
+bitmapmaker is a Python package that allows you to create custom bitmaps using a Windows GUI. You can toggle squares on and off, including bulk area selection, and visualize the resulting bitmap in a 2D array. The generated bitmap is also printed to the terminal for easy copying.
 
-You can use
-[GitHub Page](https://github.com/Ruxton07/bitmapmaker)
+## Features
+
+- Toggle individual squares on and off
+- Bulk area selection
+- Visualize the resulting bitmap in a 2D array
+- Copy the generated bitmap from the terminal
+
+## Installation
+
+To install bitmapmaker, clone the repository and install the required dependencies:
+
+```sh
+git clone https://github.com/Ruxton07/bitmapmaker.git
+cd bitmapmaker
+pip install -r requirements.txt
+```
+
+## Usage
+
+To use bitmapmaker, run the following command and enter the dimensions of the grid when prompted:
+
+```sh
+python -m src.bitmapmaker.bitmapgui
+```
+
+## Example
+
+After running the command, a GUI window will open where you can toggle squares on and off. Once you submit, the generated bitmap will be displayed in a 2D array format and printed to the terminal.
+
+## License
+
+This project is licensed under the MIT License. See the LICENSE file for details.
+
+## Contributing
+ 
+Contributions are welcome! Please open an issue or submit a pull request on the [GitHub Repository](https://github.com/Ruxton07/bitmapmaker), or you can [contact me](##contact)
+
+## Contact
+
+For any questions or inquiries, please contact the author:
+- **Name**: Ryan Kellar
+- **Email**: [e-mail]
+
+### Links
+- [PyPI Homepage](https://pypi.org/project/bitmapmaker/)
+- [GitHub Page](https://github.com/Ruxton07/bitmapmaker)
+- [Issues](https://github.com/Ruxton07/bitmapmaker/issues)

pyproject.toml

@@ -7,3 +7,3 @@ [build-system]
 name = "bitmapmaker"
-version = "1.0.1"
+version = "1.0.2"
 authors = [
@@ -23,2 +23,2 @@ { name="Ryan Kellar", email="[e-mail]" },
 Homepage = "https://github.com/Ruxton07/bitmapmaker"
-Issues = "https://github.com/Ruxton07/bitmapmaker/issues"
+Issues = "https://github.com/Ruxton07/bitmapmaker/issues"

README.md

 # bitmapmaker
 
-This is a package that opens a windows GUI in which you can toggle squares on/off as you please (including bulk area selection). Once you submit, it will show you visually in a 2D array what your resulting bitmap looks like, as well as paste the python 2D array into a terminal which you can copy as needed.
+bitmapmaker is a Python package that allows you to create custom bitmaps using a Windows GUI. You can toggle squares on and off, including bulk area selection, and visualize the resulting bitmap in a 2D array. The generated bitmap is also printed to the terminal for easy copying.
 
-You can use
-[GitHub Page](https://github.com/Ruxton07/bitmapmaker)
+## Features
+
+- Toggle individual squares on and off
+- Bulk area selection
+- Visualize the resulting bitmap in a 2D array
+- Copy the generated bitmap from the terminal
+
+## Installation
+
+To install bitmapmaker, clone the repository and install the required dependencies:
+
+```sh
+git clone https://github.com/Ruxton07/bitmapmaker.git
+cd bitmapmaker
+pip install -r requirements.txt
+```
+
+## Usage
+
+To use bitmapmaker, run the following command and enter the dimensions of the grid when prompted:
+
+```sh
+python -m src.bitmapmaker.bitmapgui
+```
+
+## Example
+
+After running the command, a GUI window will open where you can toggle squares on and off. Once you submit, the generated bitmap will be displayed in a 2D array format and printed to the terminal.
+
+## License
+
+This project is licensed under the MIT License. See the LICENSE file for details.
+
+## Contributing
+ 
+Contributions are welcome! Please open an issue or submit a pull request on the [GitHub Repository](https://github.com/Ruxton07/bitmapmaker), or you can [contact me](##contact)
+
+## Contact
+
+For any questions or inquiries, please contact the author:
+- **Name**: Ryan Kellar
+- **Email**: [e-mail]
+
+### Links
+- [PyPI Homepage](https://pypi.org/project/bitmapmaker/)
+- [GitHub Page](https://github.com/Ruxton07/bitmapmaker)
+- [Issues](https://github.com/Ruxton07/bitmapmaker/issues)

src/bitmapmaker/__init__.py

 import bitmapmaker.bitmapgui as bmg
-import bitmapmaker.bitmap as bmo
+import bitmapmaker.bitmap as bmo

src/bitmapmaker/bitmap.py

@@ -9,2 +9,2 @@ import bitmapmaker.bitmapgui as bmg
         bmg.bitmapgui(self.bmx, self.bmy)
-        return (self.bmx, self.bmy)
+        return (self.bmx, self.bmy)

src/bitmapmaker/bitmapgui.py

@@ -75,2 +75,2 @@ import tkinter as tk
     n, m = int(n), int(m) if n.isdigit() and m.isdigit() else (10, 10)
-    bitmapgui.bitmapgui(int(n), int(m))
+    bitmapgui.bitmapgui(int(n), int(m))

tests/empty_grid_tests.py

@@ -7,2 +7,1 @@ import bitmapmaker.bitmap as bm
     assert (testbm.bmx, testbm.bmy) == (3,3)
-    

Alert delta unavailable

Currently unable to show alert delta for PyPI packages.

Improved metrics

Total package byte prevSize

9206

40.81%

Lines of code

82

3.8%