Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ Create a simple ActivityPub actor and serve it:

```python
from apkit.models import Person
from apkit.server import ActivityPubServer
from apkit.server.app import ActivityPubServer
from apkit.server.responses import ActivityResponse

app = ActivityPubServer()
Expand Down
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ Create a simple ActivityPub actor and serve it:

```python
from apkit.models import Person
from apkit.server import ActivityPubServer
from apkit.server.app import ActivityPubServer
from apkit.server.responses import ActivityResponse

app = ActivityPubServer()
Expand Down
6 changes: 4 additions & 2 deletions docs/tutorial.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,8 @@ from fastapi.responses import JSONResponse
from cryptography.hazmat.primitives.asymmetric import rsa
from cryptography.hazmat.primitives import serialization as crypto_serialization

from apkit.server import ActivityPubServer, SubRouter
from apkit.server.app import ActivityPubServer
from apkit.server.subrouter import SubRouter
Comment on lines +31 to +32
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

While these imports are correct after the refactoring, this change highlights that imports from apkit.server are now spread across multiple submodules (app, subrouter, types, responses). To provide a cleaner public API for library users, consider exporting the main classes from the apkit.server package itself. This can be achieved by adding the relevant imports to src/apkit/server/__init__.py.

For example, in src/apkit/server/__init__.py:

from .app import ActivityPubServer
from .subrouter import SubRouter
from .types import Context, ActorKey
from .responses import ActivityResponse

This would allow users to write a single, cleaner import statement, improving the developer experience.

from apkit.server.types import Context, ActorKey
from apkit.server.responses import ActivityResponse
from apkit.models import (
Expand Down Expand Up @@ -211,7 +212,8 @@ from fastapi.responses import JSONResponse
from cryptography.hazmat.primitives.asymmetric import rsa
from cryptography.hazmat.primitives import serialization as crypto_serialization

from apkit.server import ActivityPubServer, SubRouter
from apkit.server.app import ActivityPubServer
from apkit.server.subrouter import SubRouter
from apkit.server.types import Context, ActorKey
from apkit.server.responses import ActivityResponse
from apkit.models import (
Expand Down
2 changes: 1 addition & 1 deletion examples/minimal_server.py
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
OrderedCollectionPage,
Person,
)
from apkit.server import ActivityPubServer
from apkit.server.app import ActivityPubServer
from apkit.server.responses import ActivityResponse
from apkit.server.types import ActorKey, Context, Outbox

Expand Down