diff --git a/README.md b/README.md index a988ebbf..63a686ef 100644 --- a/README.md +++ b/README.md @@ -2,4 +2,6 @@ This is an example Pack for [Royalnet](https://github.com/Steffo99/royalnet)! -> To be updated with more info on how to create your own pack. \ No newline at end of file +To create your own pack, [read the documentation](https://gh.steffo.eu/royalnet/html/packs/pack.html)! + + diff --git a/examplepack/commands/example.py b/examplepack/commands/example.py index f98652ba..ce9fa6eb 100644 --- a/examplepack/commands/example.py +++ b/examplepack/commands/example.py @@ -2,6 +2,8 @@ from typing import * from royalnet.commands import * from royalnet.utils import * +# TODO: delete this file! + class ExampleCommand(Command): name: str = "example" diff --git a/examplepack/events/example.py b/examplepack/events/example.py index 866abc7a..6405c77c 100644 --- a/examplepack/events/example.py +++ b/examplepack/events/example.py @@ -2,6 +2,8 @@ from typing import * from royalnet.commands import * from royalnet.utils import * +# TODO: delete this file! + class ExampleEvent(Event): name = "example" diff --git a/examplepack/stars/api_example.py b/examplepack/stars/api_example.py index 80b03165..66c6e835 100644 --- a/examplepack/stars/api_example.py +++ b/examplepack/stars/api_example.py @@ -2,8 +2,8 @@ import royalnet.utils as ru import royalnet.constellation.api as rca import royalnet.constellation.api.apierrors as rcae - # View autogenerated docs for all ApiStars at the HTTP path `/docs` +# TODO: delete this file! class EchoStar(rca.ApiStar): diff --git a/examplepack/stars/example.py b/examplepack/stars/example.py index 6b044cea..aa830e08 100644 --- a/examplepack/stars/example.py +++ b/examplepack/stars/example.py @@ -3,6 +3,8 @@ from starlette.responses import * from royalnet.constellation import * from royalnet.utils import * +# TODO: delete this file! + class ExampleStar(PageStar): path = "/example" diff --git a/examplepack/tables/example.py b/examplepack/tables/example.py index 83078e7e..4e05144f 100644 --- a/examplepack/tables/example.py +++ b/examplepack/tables/example.py @@ -2,6 +2,8 @@ from sqlalchemy import * from sqlalchemy.orm import * from sqlalchemy.ext.declarative import declared_attr +# TODO: delete this file! + class Example: __tablename__ = "examples" diff --git a/examplepack/types/__init__.py b/examplepack/types/__init__.py new file mode 100644 index 00000000..d4496c83 --- /dev/null +++ b/examplepack/types/__init__.py @@ -0,0 +1,7 @@ +# Imports go here! +# from .example import Example + +# A list of strings containing the name of the classes imported here +__all__ = [ + # "Example", +] diff --git a/examplepack/utils/__init__.py b/examplepack/utils/__init__.py new file mode 100644 index 00000000..d4496c83 --- /dev/null +++ b/examplepack/utils/__init__.py @@ -0,0 +1,7 @@ +# Imports go here! +# from .example import Example + +# A list of strings containing the name of the classes imported here +__all__ = [ + # "Example", +]