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!
