some fixes

Author: AmaseCocoa

README.md

@@ -1,7 +1,125 @@
 # apmodel
-ActivityStreams 2.0 and nodeinfo 2.0/2.1 implementation for Python.
-## Other ActivityPub Tools
-- [apsig: Signature implementation used in ActivityPub](https://github.com/AmaseCocoa/apsig)
-- [apkit: Powerful Toolkit for ActivityPub Implementations](https://github.com/AmaseCocoa/apkit)
-## Links
-- [Official Fedi Account](https://hollo.amase.cc/@apkit)
+
+[![PyPI version](https://badge.fury.io/py/apmodel.svg)](https://badge.fury.io/py/apmodel)
+[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+
+Pydantic models for ActivityStreams 2.0, NodeInfo, and other Fediverse-related vocabularies.
+
+`apmodel` provides model implementations for:
+- Activity Streams 2.0
+- [NodeInfo](https://nodeinfo.diasporafoundation.org/protocol.html) (2.0 and 2.1)
+- [CryptographicKey](https://w3c-ccg.github.io/security-vocab/contexts/security-v1.jsonld) (Security Vocabulary v1)
+- [Multikey](https://w3c-ccg.github.io/multikey/) and [DataIntegrityProof](https://w3c-ccg.github.io/data-integrity-spec/) (Controlled Identifiers v1.0)
+- [PropertyValue](https://schema.org/PropertyValue) (schema.org)
+
+## Features
+
+- **Type-Safe Models**: Leverages Pydantic for robust and type-safe data validation and manipulation.
+- **Automatic Model Loading**: A `load` function that automatically reads the `type` field from a dictionary and converts it to the correct Pydantic model.
+- **JSON-LD Aware**: Designed to work seamlessly with JSON-LD data, automatically handling expanded formats (e.g., values wrapped in arrays).
+- **Flexible Deserialization**: Handles unknown properties gracefully, allowing you to work with custom extensions in the ActivityPub ecosystem. Extra fields are attached directly to the model object.
+- **Comprehensive Vocabulary**: Includes a wide range of models from the ActivityStreams vocabulary, as well as common extensions used in the Fediverse.
+
+## Installation
+
+```bash
+pip install apmodel
+```
+
+## Usage
+
+### Loading Objects
+
+Use the `apmodel.load()` function to parse a dictionary into a specific ActivityStreams model. The function inspects the `type` field to determine the correct model.
+
+```python
+import apmodel
+
+# Example ActivityStreams Note object as a dictionary
+note_data = {
+    "@context": "https://www.w3.org/ns/activitystreams",
+    "type": "Note",
+    "content": "This is a simple note.",
+    "published": "2025-05-10T12:00:00Z",
+    "to": ["https://www.w3.org/ns/activitystreams#Public"],
+    "cc": ["https://example.com/users/alice/followers"]
+}
+
+# Load the dictionary into a Note object
+note_object = apmodel.load(note_data)
+
+# note_object is now an instance of apmodel.vocab.Note
+print(type(note_object))
+# > <class 'apmodel.vocab.note.Note'>
+
+# You can access attributes with type safety
+print(note_object.content)
+# > This is a simple note.
+
+# The context is also parsed into an LDContext object
+print(note_object.context.to_json())
+# > ["https://www.w3.org/ns/activitystreams"]
+```
+
+### Creating Objects
+
+You can also create objects programmatically.
+
+```python
+from apmodel.vocab import Create
+from apmodel.vocab import Note
+
+note = Note(content="My new note!")
+create_activity = Create(
+    actor="https://example.com/users/bob",
+    object=note,
+)
+
+# The model can be converted back to a dictionary
+# (Note: a dedicated `dump` function is not yet implemented,
+# but you can use Pydantic's `model_dump` for now)
+activity_dict = create_activity.model_dump(by_alias=True, exclude_none=True)
+
+import json
+print(json.dumps(activity_dict, indent=2))
+```
+
+This will output:
+```json
+{
+  "@context": [
+    "https://www.w3.org/ns/activitystreams"
+  ],
+  "@type": "Create",
+  "actor": "https://example.com/users/bob",
+  "object": {
+    "@context": [
+      "https://www.w3.org/ns/activitystreams"
+    ],
+    "@type": "Note",
+    "content": "My new note!"
+  }
+}
+```
+
+## Development
+
+This project uses [Task](https://taskfile.dev/) for running scripts.
+
+### Setup Dev Environment
+
+Installs development dependencies.
+
+```bash
+task
+```
+
+### Run Tests
+
+```bash
+task test
+```
+
+## License
+
+This project is licensed under the MIT License.

pyproject.toml

@@ -46,6 +46,8 @@ version-file = "src/apmodel/_version.py"
 [dependency-groups]
 dev = [
     "git-cliff>=2.10.0",
+    "mkdocs-gen-files>=0.5.0",
+    "mkdocs-material>=9.6.23",
     "pytest>=8.4.1",
 ]
 

src/apmodel/__init__.py

@@ -1,3 +1,4 @@
+from ._initial import _rebuild  # noqa: F401
 from ._version import __version__, __version_tuple__  # noqa: F401
 
 # from .dumper import dump
@@ -38,11 +39,3 @@
     # context
     "LDContext",
 ]
-
-Object.model_rebuild()
-Link.model_rebuild()
-Activity.model_rebuild()
-Collection.model_rebuild()
-OrderedCollection.model_rebuild()
-CollectionPage.model_rebuild()
-OrderedCollectionPage.model_rebuild()

src/apmodel/_version.py

@@ -28,7 +28,7 @@
 commit_id: COMMIT_ID
 __commit_id__: COMMIT_ID
 
-__version__ = version = '0.4.4.post1.dev2+g4ee26c515.d20251102'
-__version_tuple__ = version_tuple = (0, 4, 4, 'post1', 'dev2', 'g4ee26c515.d20251102')
+__version__ = version = '0.4.4.post1.dev4+g83d4bd29c.d20251104'
+__version_tuple__ = version_tuple = (0, 4, 4, 'post1', 'dev4', 'g83d4bd29c.d20251104')
 
 __commit_id__ = commit_id = None

src/apmodel/core/object.py

@@ -2,7 +2,7 @@
 
 from typing import TYPE_CHECKING, Annotated, List, Optional, TypeVar, Union
 
-from pydantic import BeforeValidator, Field
+from pydantic import BeforeValidator, ConfigDict, Field
 
 from apmodel.types.aliases import (
     JSONLD_CONTEXT,
@@ -29,8 +29,13 @@
 
 
 class Object(ActivityPubModel):
+    model_config = ConfigDict(
+        serialize_by_alias=True 
+    )
+    
     context: JSONLD_CONTEXT = Field(
-        alias="@context",
+        validation_alias="@context",
+        serialization_alias="@context",
         kw_only=True,
         default_factory=lambda: LDContext(
             ["https://www.w3.org/ns/activitystreams"]
@@ -39,7 +44,7 @@ class Object(ActivityPubModel):
     id: OPT_STR = Field(
         validation_alias="@id", serialization_alias="@id", default=None
     )
-    type: str = Field(
+    type: Annotated[str, BeforeValidator(get_value_from_array)] = Field(
         alias="@type",
         default="https://www.w3.org/ns/activitystreams#Object",
         kw_only=True,

src/apmodel/extra/emoji.py

@@ -1,18 +1,13 @@
-from typing import Annotated, Optional
+from __future__ import annotations
 
-from pydantic import BeforeValidator, Field
-
-from apmodel.types.aliases import OPT_STR
+from pydantic import Field
 
 from ..core import Object
-from ..helpers import get_value_from_array
 
 
 class Emoji(Object):
-    type: str = (
-        Field(
-            alias="@type",
-            default="http://joinmastodon.org/ns#Emoji",
-            kw_only=True,
-        )
+    type: str = Field(
+        alias="@type",
+        default="http://joinmastodon.org/ns#Emoji",
+        kw_only=True,
     )

src/apmodel/types/aliases.py

@@ -1,9 +1,8 @@
 from datetime import datetime
-from typing import TYPE_CHECKING, Annotated, Optional, Union
+from typing import TYPE_CHECKING, Annotated, Optional, TypeAlias, Union
 
 from cryptography.hazmat.primitives.asymmetric import ed25519, rsa
 from pydantic import AfterValidator, BeforeValidator
-from typing_extensions import TypeAlias
 
 from ..context import LDContext
 from ..helpers import (