batframework 1.0.9a10__tar.gz → 1.0.9a12__tar.gz

{batframework-1.0.9a10 → batframework-1.0.9a12}/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) [2023] [TURAN BATURAY]
-
-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
+MIT License
+
+Copyright (c) [2023] [TURAN BATURAY]
+
+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.

{batframework-1.0.9a10 → batframework-1.0.9a12}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: batframework
-Version: 1.0.9a10
+Version: 1.0.9a12
 Summary: Pygame framework for making games easier.
 Author-email: Turan Baturay <baturayturan@gmail.com>
 License: MIT License
@@ -35,30 +35,37 @@ Requires-Dist: pygame-ce
 
 # batFramework
 
-Welcome to the `batFramework`. This README provides an overview of the game framework.
+batFramework is a Python game framework built using Pygame, designed to simplify game development.
 
-## batFramework
+## Purpose and Overview
+The primary objective of batFramework is to streamline game development. It is mainly designed to program small 2D games
 
-The `batFramework` is a Python game development framework based on pygame, designed to streamline the process of creating 2D games. It provides a set of tools and components to handle scenes, transitions, cutscenes, audio, sprites, and more. The framework is built with flexibility in mind, allowing you to focus on game design while abstracting away low-level details.
+## Installation and Setup
+To install batFramework, you can use pip:
+```pip install batFramework```
 
-### Features
+The only dependency required is pygame-ce.
 
-- Scene management
-- Cutscene support
-- Audio management (music and sound effects with volume control)
-- Entity, sprite, and animated sprite handling
-- Transition effects
-- Utility modules (time management, constants, etc.)
-- No external dependency except for pygame
+## Usage Instructions
+To create a basic app using batFramework, here's an example:
 
-###  Explore batFramework
+```python
+import batFramework as bf
 
-1. Install Python (version 3.11 or higher) and the latest stable version of pygame-ce.
-2. Clone or download this repository.
-4. Explore the framework's modules in the `batFramework` directory and integrate them into your own game project.
+# Initialize the framework
+bf.init(resolution=(1280, 720), window_caption="My Amazing Program")
 
-For more detailed information on how to use the framework, refer to the documentation (if available) or explore the source code in the `batFramework` directory.
+# Create a manager and a scene
+bf.Manager(bf.Scene("main")).run()
+```
+In practice, users can inherit bf.Scene to create their own scenes, adding specific behaviors, entities, etc.
 
+## Features and Functionalities
 
+For more detailed information, please refer to the [documentation](https://batframework.github.io/batDocumentation/).
+
+
+# License
+ MIT License
 
 

batframework-1.0.9a12/README.md

@@ -0,0 +1,36 @@
+# batFramework
+
+batFramework is a Python game framework built using Pygame, designed to simplify game development.
+
+## Purpose and Overview
+The primary objective of batFramework is to streamline game development. It is mainly designed to program small 2D games
+
+## Installation and Setup
+To install batFramework, you can use pip:
+```pip install batFramework```
+
+The only dependency required is pygame-ce.
+
+## Usage Instructions
+To create a basic app using batFramework, here's an example:
+
+```python
+import batFramework as bf
+
+# Initialize the framework
+bf.init(resolution=(1280, 720), window_caption="My Amazing Program")
+
+# Create a manager and a scene
+bf.Manager(bf.Scene("main")).run()
+```
+In practice, users can inherit bf.Scene to create their own scenes, adding specific behaviors, entities, etc.
+
+## Features and Functionalities
+
+For more detailed information, please refer to the [documentation](https://batframework.github.io/batDocumentation/).
+
+
+# License
+ MIT License
+
+

{batframework-1.0.9a10 → batframework-1.0.9a12}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "batframework"
-version = "1.0.9a10"
+version = "1.0.9a12"
 license = { file = "LICENSE" }
 authors = [
     { name="Turan Baturay", email="baturayturan@gmail.com" }
@@ -22,4 +22,15 @@ dependencies=[
 ]
 
 [project.urls]
-"Homepage" = "https://github.com/TuranBaturay/batFramework"
+"Homepage" = "https://github.com/TuranBaturay/batFramework"
+
+[tool.commitizen]
+name = "cz_conventional_commits"
+version_provider = "pep621"
+tag_format = "$version"
+update_changelog_on_bump = true
+changelog_file = "CHANGELOG.md"
+version_files = [
+  "pyproject.toml:version",
+  "src/batFramework/__init__.py:__version__"
+]

{batframework-1.0.9a10 → batframework-1.0.9a12}/src/batFramework/__init__.py

@@ -1,3 +1,5 @@
+__version__="1.0.9a12"
+
 import os
 import pygame
 import json