pykworldsim 0.1.0__tar.gz

pykworldsim-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Kairav Dutta
+
+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.

pykworldsim-0.1.0/PKG-INFO

@@ -0,0 +1,153 @@
+Metadata-Version: 2.4
+Name: pykworldsim
+Version: 0.1.0
+Summary: A python library that simulates a world with people, relationships, and cities
+Author-email: Kairav Dutta <kairavdutta@gmail.com>
+License: MIT License
+        
+        Copyright (c) 2026 Kairav Dutta
+        
+        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.
+Project-URL: Homepage, https://github.com/yourusername/pykworldsim
+Keywords: simulation,world,ai,people,relationships
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# 🌍 PyKWorldSim
+
+> A lightweight Python simulation engine for modeling **people, relationships, cities, and dynamic worlds**.
+
+PyKWorldSim provides a modular framework to simulate interactions between entities such as individuals, locations, jobs, and events — making it useful for experiments in **AI, social simulations, and system modeling**.
+
+---
+
+## 🚀 Features
+
+- 👤 **Person system** — create and manage individuals  
+- 🤝 **Relationships** — model connections between people  
+- 🏙️ **Locations & cities** — simulate environments  
+- 💼 **Jobs & roles** — assign occupations  
+- 🎯 **Goals** — define motivations and behaviors  
+- 📅 **Events** — simulate time-based interactions  
+- 📊 **Reports** — analyze simulation outcomes  
+
+---
+
+## 📦 Installation
+
+### From PyPI (after publishing)
+
+```bash
+pip install pykworldsim
+```
+
+### For local development
+
+```bash
+pip install .
+```
+
+---
+
+## 🧠 Basic Usage
+
+```python
+from pykworldsim.world import World
+from pykworldsim.person import Person
+
+# Create world
+world = World()
+
+# Create people
+alice = Person(Name="Alice")
+bob = Person(Name="Bob")
+
+# Add people to the world
+world.addPerson(alice)
+world.addPerson(bob)
+
+# Run simulation step (example)
+world.Simulate()
+
+# Generate report
+report = world.generate_report()
+print(report)
+```
+
+---
+
+## 📁 Project Structure
+
+```
+pykworldsim/
+│
+├── pykworldsim/
+│   ├── world.py
+│   ├── person.py
+│   ├── relationship.py
+│   ├── goal.py
+│   ├── event.py
+│   ├── job.py
+│   ├── location.py
+│   └── report.py
+│
+├── pyproject.toml
+├── README.md
+└── LICENSE
+```
+
+---
+
+## ⚙️ Requirements
+
+- Python 3.8+
+
+---
+
+
+## 📌 Use Cases
+
+- AI simulations  
+- Social behavior modeling  
+- Game prototyping  
+- Agent-based systems  
+- Experimental world-building  
+
+---
+
+## 📜 License
+
+This project is licensed under the MIT License.
+
+---
+
+## 👤 Author
+
+**Kairav Dutta**
+
+---
+
+## ⭐ Contributing
+
+Contributions, issues, and feature requests are welcome and appreciated!

pykworldsim-0.1.0/README.md

@@ -0,0 +1,117 @@
+# 🌍 PyKWorldSim
+
+> A lightweight Python simulation engine for modeling **people, relationships, cities, and dynamic worlds**.
+
+PyKWorldSim provides a modular framework to simulate interactions between entities such as individuals, locations, jobs, and events — making it useful for experiments in **AI, social simulations, and system modeling**.
+
+---
+
+## 🚀 Features
+
+- 👤 **Person system** — create and manage individuals  
+- 🤝 **Relationships** — model connections between people  
+- 🏙️ **Locations & cities** — simulate environments  
+- 💼 **Jobs & roles** — assign occupations  
+- 🎯 **Goals** — define motivations and behaviors  
+- 📅 **Events** — simulate time-based interactions  
+- 📊 **Reports** — analyze simulation outcomes  
+
+---
+
+## 📦 Installation
+
+### From PyPI (after publishing)
+
+```bash
+pip install pykworldsim
+```
+
+### For local development
+
+```bash
+pip install .
+```
+
+---
+
+## 🧠 Basic Usage
+
+```python
+from pykworldsim.world import World
+from pykworldsim.person import Person
+
+# Create world
+world = World()
+
+# Create people
+alice = Person(Name="Alice")
+bob = Person(Name="Bob")
+
+# Add people to the world
+world.addPerson(alice)
+world.addPerson(bob)
+
+# Run simulation step (example)
+world.Simulate()
+
+# Generate report
+report = world.generate_report()
+print(report)
+```
+
+---
+
+## 📁 Project Structure
+
+```
+pykworldsim/
+│
+├── pykworldsim/
+│   ├── world.py
+│   ├── person.py
+│   ├── relationship.py
+│   ├── goal.py
+│   ├── event.py
+│   ├── job.py
+│   ├── location.py
+│   └── report.py
+│
+├── pyproject.toml
+├── README.md
+└── LICENSE
+```
+
+---
+
+## ⚙️ Requirements
+
+- Python 3.8+
+
+---
+
+
+## 📌 Use Cases
+
+- AI simulations  
+- Social behavior modeling  
+- Game prototyping  
+- Agent-based systems  
+- Experimental world-building  
+
+---
+
+## 📜 License
+
+This project is licensed under the MIT License.
+
+---
+
+## 👤 Author
+
+**Kairav Dutta**
+
+---
+
+## ⭐ Contributing
+
+Contributions, issues, and feature requests are welcome and appreciated!

pykworldsim-0.1.0/pykworldsim/__init__.py

@@ -0,0 +1,10 @@
+from .world import World
+from .person import Person
+from .relationship import Relationship
+from .goal import Goal
+from .event import Event
+from .location import Location
+from .job import Job
+
+__all__ = ["World", "Person", "Relationship", "Goal", "Event", "Location", "Job"]
+__version__ = "1.0.0"

pykworldsim-0.1.0/pykworldsim/event.py

@@ -0,0 +1,28 @@
+import random
+from dataclasses import dataclass
+from typing import Optional, Callable
+
+
+@dataclass
+class Event:
+    """A world event that fires probabilistically or on demand."""
+    Name: str
+    Probability: float = 0.05          # per-year probability
+    Effect: Optional[Callable] = None  # fn(world, year) → None
+    Description: str = ""
+    IsGlobal: bool = True              # True = affects everyone; False = individual
+
+    def ShouldTrigger(self) -> bool:
+        return random.random() < self.Probability
+
+    def Fire(self, World, Year: int):
+        Msg = f"[Year {Year}] EVENT: {self.Name}"
+        if self.Description:
+            Msg += f" — {self.Description}"
+        World.Log.append(Msg)
+        if self.Effect:
+            self.Effect(World, Year)
+
+    def __str__(self):
+        Scope = "Global" if self.IsGlobal else "Local"
+        return f"Event: {self.Name} ({self.Probability*100:.1f}%) - {Scope}"

pykworldsim-0.1.0/pykworldsim/goal.py

@@ -0,0 +1,34 @@
+class Goal:
+    """Represents a personal goal with a type and priority."""
+
+    ValidGoalTypes = {
+        "GetJob", "GetPromotion", "MakeFriends", "FindPartner",
+        "ImproveSkills", "EarnMoney", "IncreaseStatus", "MoveCity",
+        "StartFamily", "BuildBusiness", "SocializeMore", "FindPurpose"
+    }
+
+    def __init__(self, GoalType: str, Priority: float = 0.5):
+        if GoalType not in self.ValidGoalTypes:
+            raise ValueError(f"GoalType '{GoalType}' is not valid. Choose from: {sorted(self.ValidGoalTypes)}")
+        if not (0.0 <= Priority <= 1.0):
+            raise ValueError("Priority must be between 0.0 and 1.0")
+        self.GoalType = GoalType
+        self.Priority = Priority
+        self.Progress = 0.0
+        self.Achieved = False
+        self.YearAchieved = None
+
+    def UpdateProgress(self, Delta: float):
+        self.Progress = max(0.0, min(1.0, self.Progress + Delta))
+        if self.Progress >= 1.0 and not self.Achieved:
+            self.Achieved = True
+            return True
+        return False
+
+    def __repr__(self):
+        Status = "✓" if self.Achieved else f"{self.Progress:.0%}"
+        return f"Goal({self.GoalType}, priority={self.Priority:.1f}, progress={Status})"
+
+    def __str__(self):
+        Status = "Achieved" if self.Achieved else f"{self.Progress:.0%} Complete"
+        return f"Goal: {self.GoalType} ({Status})"

pykworldsim-0.1.0/pykworldsim/job.py

@@ -0,0 +1,34 @@
+class Job:
+    """A job that can be held by a person."""
+
+    def __init__(self, Role: str, Salary: float = 50000,
+                 Prestige: float = 0.5, StressLevel: float = 0.4,
+                 SkillRequired: float = 0.3, Industry: str = "general"):
+        self.Role = Role
+        self.Salary = Salary
+        self.Prestige = max(0.0, min(1.0, Prestige))
+        self.StressLevel = max(0.0, min(1.0, StressLevel))
+        self.SkillRequired = max(0.0, min(1.0, SkillRequired))
+        self.Industry = Industry
+        self.Holder = None
+        self.Location = None
+
+    def IsAvailable(self) -> bool:
+        return self.Holder is None
+
+    def Assign(self, Person):
+        self.Holder = Person
+
+    def Vacate(self):
+        self.Holder = None
+
+    def AnnualSalary(self, Year: int = 0) -> float:
+        """Salary grows slightly with experience."""
+        return self.Salary * (1.02 ** Year)
+
+    def __repr__(self):
+        Status = f"held by {self.Holder.Name}" if self.Holder else "available"
+        return f"Job({self.Role}, salary={self.Salary:,.0f}, {Status})"
+
+    def __str__(self):
+        return f"{self.Role} (${self.Salary:,.0f}/yr) - {'Available' if not self.Holder else f'Held by {self.Holder.Name}'}"

pykworldsim-0.1.0/pykworldsim/location.py

@@ -0,0 +1,31 @@
+class Location:
+    """A place in the world where people live, work, and interact."""
+
+    def __init__(self, Name: str, LocationType: str = "city",
+                 OpportunityLevel: float = 0.5,
+                 CostOfLiving: float = 0.5,
+                 PopulationDensity: float = 0.5):
+        self.Name = Name
+        self.LocationType = LocationType  # city, suburb, rural, campus
+        self.OpportunityLevel = max(0.0, min(1.0, OpportunityLevel))
+        self.CostOfLiving = max(0.0, min(1.0, CostOfLiving))
+        self.PopulationDensity = max(0.0, min(1.0, PopulationDensity))
+        self.Residents: list = []
+        self.Jobs: list = []
+
+    def AddResident(self, Person):
+        if Person not in self.Residents:
+            self.Residents.append(Person)
+
+    def RemoveResident(self, Person):
+        if Person in self.Residents:
+            self.Residents.remove(Person)
+
+    def AddJob(self, Job):
+        self.Jobs.append(Job)
+
+    def __repr__(self):
+        return f"Location({self.Name}, type={self.LocationType}, residents={len(self.Residents)})"
+
+    def __str__(self):
+        return f"{self.Name} ({self.LocationType.title()}) - Population: {len(self.Residents)}"