hedonic 0.0.4__tar.gz

hedonic-0.0.4/PKG-INFO

@@ -0,0 +1,97 @@
+Metadata-Version: 2.3
+Name: hedonic
+Version: 0.0.4
+Summary: A Python library for hedonic games
+Author: Lucas Lopes Felipe
+Requires-Dist: igraph
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+
+# Hedonic
+
+A Python library for hedonic games.
+
+## Installation
+
+```bash
+pip install hedonic
+```
+
+## Usage
+
+```python
+from hedonic import Game
+
+# Create a new game
+game = Game("My Hedonic Game")
+
+# Add players
+game.add_player("Alice")
+game.add_player("Bob")
+game.add_player("Charlie")
+
+# Get all players
+players = game.get_players()
+print(players)  # ['Alice', 'Bob', 'Charlie']
+
+# Print game info
+print(game)  # Game: My Hedonic Game with 3 players
+```
+
+## Development
+
+This project uses `uv` for dependency management and building.
+
+To set up development environment:
+```bash
+uv venv
+source .venv/bin/activate
+uv sync
+```
+
+To build the package:
+```bash
+uv build
+```
+
+To publish to PyPI:
+```bash
+uv publish --token <your-pypi-token>
+```
+
+## GitHub Actions Publishing
+
+This repository includes GitHub Actions workflows for automated publishing:
+
+- **TestPyPI workflow**: Currently active, publishes to TestPyPI on `v*` tags
+- **PyPI workflow**: Currently disabled (can be re-enabled later)
+- **Automatic publishing** when you push version tags
+- **Manual publishing** from the Actions tab
+- **Secure authentication** using OIDC for TestPyPI
+
+### Quick Release
+
+```bash
+# Bump version and prepare release
+./scripts/release.sh patch  # or minor/major
+
+# Push everything (triggers TestPyPI workflow)
+git push origin main && git push origin v0.0.2
+```
+
+### **Version Types**
+- `patch`: `0.0.1` → `0.0.2` (bug fixes, small changes)
+- `minor`: `0.0.1` → `0.1.0` (new features, backward compatible)  
+- `major`: `0.0.1` → `1.0.0` (breaking changes)
+
+### **Current Status**
+- **TestPyPI**: ✅ Active - publishes on `v*` tags
+- **PyPI**: ❌ Disabled - workflow file is commented out
+
+### **Enabling PyPI Publishing Later**
+When you're ready to publish to PyPI:
+1. Rename `.github/workflows/publish-pypi.yml.disabled` to `publish-pypi.yml`
+2. Add `PYPI_API_TOKEN` secret to your GitHub repository
+3. Both workflows will then be active with different tag patterns
+
+For detailed setup instructions, see [docs/OIDC_SETUP.md](docs/OIDC_SETUP.md).

hedonic-0.0.4/README.md

@@ -0,0 +1,88 @@
+# Hedonic
+
+A Python library for hedonic games.
+
+## Installation
+
+```bash
+pip install hedonic
+```
+
+## Usage
+
+```python
+from hedonic import Game
+
+# Create a new game
+game = Game("My Hedonic Game")
+
+# Add players
+game.add_player("Alice")
+game.add_player("Bob")
+game.add_player("Charlie")
+
+# Get all players
+players = game.get_players()
+print(players)  # ['Alice', 'Bob', 'Charlie']
+
+# Print game info
+print(game)  # Game: My Hedonic Game with 3 players
+```
+
+## Development
+
+This project uses `uv` for dependency management and building.
+
+To set up development environment:
+```bash
+uv venv
+source .venv/bin/activate
+uv sync
+```
+
+To build the package:
+```bash
+uv build
+```
+
+To publish to PyPI:
+```bash
+uv publish --token <your-pypi-token>
+```
+
+## GitHub Actions Publishing
+
+This repository includes GitHub Actions workflows for automated publishing:
+
+- **TestPyPI workflow**: Currently active, publishes to TestPyPI on `v*` tags
+- **PyPI workflow**: Currently disabled (can be re-enabled later)
+- **Automatic publishing** when you push version tags
+- **Manual publishing** from the Actions tab
+- **Secure authentication** using OIDC for TestPyPI
+
+### Quick Release
+
+```bash
+# Bump version and prepare release
+./scripts/release.sh patch  # or minor/major
+
+# Push everything (triggers TestPyPI workflow)
+git push origin main && git push origin v0.0.2
+```
+
+### **Version Types**
+- `patch`: `0.0.1` → `0.0.2` (bug fixes, small changes)
+- `minor`: `0.0.1` → `0.1.0` (new features, backward compatible)  
+- `major`: `0.0.1` → `1.0.0` (breaking changes)
+
+### **Current Status**
+- **TestPyPI**: ✅ Active - publishes on `v*` tags
+- **PyPI**: ❌ Disabled - workflow file is commented out
+
+### **Enabling PyPI Publishing Later**
+When you're ready to publish to PyPI:
+1. Rename `.github/workflows/publish-pypi.yml.disabled` to `publish-pypi.yml`
+2. Add `PYPI_API_TOKEN` secret to your GitHub repository
+3. Both workflows will then be active with different tag patterns
+
+For detailed setup instructions, see [docs/OIDC_SETUP.md](docs/OIDC_SETUP.md).

hedonic-0.0.4/pyproject.toml

@@ -0,0 +1,14 @@
+[project]
+name = "hedonic"
+version = "0.0.4"
+description = "A Python library for hedonic games"
+readme = "README.md"
+authors = [
+    { name = "Lucas Lopes Felipe" }
+]
+requires-python = ">=3.12"
+dependencies = ["igraph"]
+
+[build-system]
+requires = ["uv_build>=0.8.11,<0.9.0"]
+build-backend = "uv_build"

hedonic-0.0.4/src/hedonic/__init__.py

@@ -0,0 +1,33 @@
+from igraph import Graph  # type: ignore
+
+
+class Game(Graph):
+    """A hedonic game represented as an `igraph.Graph`."""
+
+    def __init__(self, graph: Graph | None = None, *args, **kwargs) -> None:
+        super().__init__(*args, **kwargs)
+        if isinstance(graph, Graph):
+            self.add_vertices(graph.vcount())
+            self.add_edges(graph.get_edgelist())
+            for attr in graph.vertex_attributes():
+                self.vs[attr] = graph.vs[attr]
+            for attr in graph.edge_attributes():
+                self.es[attr] = graph.es[attr]
+            for attr in graph.attributes():
+                self[attr] = graph[attr]
+
+    def to_igraph(self) -> Graph:
+        """Convert the `Game` object to a standalone `igraph.Graph` instance."""
+        g = Graph()
+        g.add_vertices(self.vcount())
+        g.add_edges(self.get_edgelist())
+        for attr in self.vertex_attributes():
+            g.vs[attr] = self.vs[attr]
+        for attr in self.edge_attributes():
+            g.es[attr] = self.es[attr]
+        for attr in self.attributes():
+            g[attr] = self[attr]
+        return g
+
+
+__all__ = ["Game"]