diff --git a/5pils/__init__.py b/5pils/__init__.py deleted file mode 100644 index 4003b3e..0000000 --- a/5pils/__init__.py +++ /dev/null @@ -1,8 +0,0 @@ -from .base import BaseClass - - - -__all__ = [ - "subpackage", - "BaseClass" - ] \ No newline at end of file diff --git a/5pils/__main__.py b/5pils/__main__.py deleted file mode 100644 index f7a148e..0000000 --- a/5pils/__main__.py +++ /dev/null @@ -1,6 +0,0 @@ -"""Entry point for 5pils.""" - -from .cli import main # pragma: no cover - -if __name__ == "__main__": # pragma: no cover - main() diff --git a/5pils/base.py b/5pils/base.py deleted file mode 100644 index 7ecc6ac..0000000 --- a/5pils/base.py +++ /dev/null @@ -1,62 +0,0 @@ -# Example class -class BaseClass: - """ - Base class representing an entity. - - Attributes - ---------- - name : str - The name of the entity. - - Methods - ------- - __init__(): - Initializes a new instance of the BaseClass. - __str__(): - Returns a string representation of the entity. - __repr__(): - Returns a string representation of the entity for debugging. - __eq__(other): - Checks if two entities are equal based on their names. - - """ - - def __init__(self, name: str): - """ - Initializes a new instance of the BaseClass. - """ - self.name = name - - def __str__(self): - """ - Returns a string representation of the entity. - """ - return self.name - - def __repr__(self): - """ - Returns a string representation of the entity for debugging. - """ - return self.name - - def __eq__(self, other): - """ - Checks if two entities are equal based on their names. - - Parameters - ---------- - other : BaseClass - Another instance of BaseClass. - - Returns - ------- - bool - True if the entities are equal, False otherwise. - """ - return self.name == other.name - - def something(self): - """ - Does something. - """ - return "something" diff --git a/5pils/cli.py b/5pils/cli.py deleted file mode 100644 index a59df75..0000000 --- a/5pils/cli.py +++ /dev/null @@ -1,33 +0,0 @@ -"""CLI interface for 5pils project. - -Be creative! do whatever you want! - -- Install click or typer and create a CLI app -- Use builtin argparse -- Start a web application -- Import things from your .base module -""" -from .base import BaseClass -from .subpackage import SubPackageClass - -def main(): # pragma: no cover - """ - The main function executes on commands: - `python -m 5pils` and `$ 5pils `. - - This is your program's entry point. - - You can change this function to do whatever you want. - Examples: - * Run a test suite - * Run a server - * Do some other stuff - * Run a command line application (Click, Typer, ArgParse) - * List all available tasks - * Run an application (Flask, FastAPI, Django, etc.) - """ - bc = BaseClass("test") - print(f"This will do something: {bc.something()}") - - spc = SubPackageClass("test") - print(f"This will do something else: {spc.something()}") diff --git a/5pils/subpackage/__init__.py b/5pils/subpackage/__init__.py deleted file mode 100644 index bf2baf1..0000000 --- a/5pils/subpackage/__init__.py +++ /dev/null @@ -1,5 +0,0 @@ -from .subpackage import SubPackageClass - -__all__ = [ - "SubPackageClass" -] \ No newline at end of file diff --git a/5pils/subpackage/subpackage.py b/5pils/subpackage/subpackage.py deleted file mode 100644 index c676ed5..0000000 --- a/5pils/subpackage/subpackage.py +++ /dev/null @@ -1,15 +0,0 @@ -class SubPackageClass: - def __init__(self, name): - self.name = name - - def __str__(self): - return f"SubPackage - {self.name}" - - def __repr__(self): - return f"SubPackage - {self.name}" - - def __eq__(self, other): - return self.name == other.name - - def something(self): - return "SubPackage - something" \ No newline at end of file