feat: update metadata and project structure

.github/workflows/main.yml

@@ -16,7 +16,7 @@ jobs:
     with:
       working-directory: .
       python-version: ${{ matrix.python-version }}
-      module-name: safeds_examples
+      module-name: safeds_datasets
       coverage: ${{ matrix.python-version == '3.11' }}
     secrets:
       CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}

.github/workflows/pr.yml

@@ -20,7 +20,7 @@ jobs:
     with:
       working-directory: .
       python-version: ${{ matrix.python-version }}
-      module-name: safeds_examples
+      module-name: safeds_datasets
       coverage: ${{ matrix.python-version == '3.11' }}
     secrets:
       CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}

.gitignore

@@ -37,7 +37,7 @@ coverage.xml
 
 # mkdocs
 /site/
-/docs/reference/safeds_examples/
+/docs/reference/safeds_datasets/
 /docs/reference/SUMMARY.md
 
 # MegaLinter

docs/examples/house_sales.ipynb

@@ -29,7 +29,7 @@
     "\n",
     "disable_warnings()\n",
     "\n",
-    "from safeds_examples.tabular import load_house_sales\n",
+    "from safeds_datasets.tabular import load_house_sales\n",
     "from display_column_description import display_column_descriptions\n",
     "\n",
     "house_sales = load_house_sales()\n",

docs/examples/titanic.ipynb

@@ -29,7 +29,7 @@
     "\n",
     "disable_warnings()\n",
     "\n",
-    "from safeds_examples.tabular import load_titanic\n",
+    "from safeds_datasets.tabular import load_titanic\n",
     "from display_column_description import display_column_descriptions\n",
     "\n",
     "titanic = load_titanic()\n",

docs/reference/generate_reference_pages.py

@@ -12,7 +12,7 @@
 import mkdocs_gen_files
 
 root = "src"
-package = "safeds_examples"
+package = "safeds_datasets"
 
 
 def list_class_and_function_names_in_module(module_name: str) -> list[str]:

pyproject.toml

@@ -1,19 +1,19 @@
 [tool.poetry]
-name = "safe-ds-examples"
-version = "0.17.1"
-description = "Ready-to-use examples for the Safe-DS Python library."
+name = "safe-ds-datasets"
+version = "0.18.0"
+description = "Ready-to-use datasets for the Safe-DS Python library."
 license = "MIT"
 authors = ["Lars Reimann <[email protected]>"]
 readme = "docs/README.md"
-repository = "https://github.com/Safe-DS/Library-Examples"
-documentation = "https://library-examples.safe-ds.com"
-keywords = ["data-science", "machine-learning", "usability", "learnability"]
+repository = "https://github.com/Safe-DS/Datasets"
+documentation = "https://datasets.safe-ds.com"
+keywords = ["data-science", "datasets", "machine-learning"]
 packages = [
-    { include = "safeds_examples", from = "src" },
+    { include = "safeds_datasets", from = "src" },
 ]
 
 [tool.poetry.dependencies]
-python = "^3.11,<3.12"
+python = "^3.11,<3.13"
 safe-ds = ">=0.17,<0.22"
 
 [tool.poetry.group.dev.dependencies]

src/safeds_examples/tabular/_house_sales/_house_sales.py → src/safeds_datasets/tabular/_house_sales/_house_sales.py

@@ -2,12 +2,12 @@
 
 from safeds.data.tabular.containers import Table
 
-from safeds_examples.tabular.containers import ExampleTable
+from safeds_datasets.tabular.containers import TabularDataset
 
 _path = Path(__file__).parent / "data" / "house_sales.csv"
 
 
-def load_house_sales() -> ExampleTable:
+def load_house_sales() -> TabularDataset:
     """
     Load the "House Sales" dataset.
 
@@ -16,7 +16,7 @@ def load_house_sales() -> ExampleTable:
     house_sales :
         The "House Sales" dataset.
     """
-    return ExampleTable(
+    return TabularDataset(
         Table.from_csv_file(str(_path)),
         column_descriptions={
             "id": "A unique identifier",

src/safeds_examples/tabular/_titanic/_titanic.py → src/safeds_datasets/tabular/_titanic/_titanic.py

@@ -2,12 +2,12 @@
 
 from safeds.data.tabular.containers import Table
 
-from safeds_examples.tabular.containers import ExampleTable
+from safeds_datasets.tabular.containers import TabularDataset
 
 _path = Path(__file__).parent / "data" / "titanic.csv"
 
 
-def load_titanic() -> ExampleTable:
+def load_titanic() -> TabularDataset:
     """
     Load the "Titanic" dataset.
 
@@ -16,7 +16,7 @@ def load_titanic() -> ExampleTable:
     titanic :
         The "Titanic" dataset.
     """
-    return ExampleTable(
+    return TabularDataset(
         Table.from_csv_file(str(_path)),
         column_descriptions={
             "id": "A unique identifier",

src/safeds_datasets/tabular/containers/__init__.py

@@ -0,0 +1,5 @@
+"""Classes that can store tabular data."""
+
+from ._tabular_dataset import TabularDataset
+
+__all__ = ["TabularDataset"]

src/safeds_examples/tabular/containers/_example_table.py → src/safeds_datasets/tabular/containers/_tabular_dataset.py

@@ -2,7 +2,7 @@
 from safeds.exceptions import UnknownColumnNameError
 
 
-class ExampleTable(Table):
+class TabularDataset(Table):
     """
     A `Table` with descriptions for its columns.
 

tests/safeds_examples/tabular/_house_sales/test_house_sales.py → tests/safeds_datasets/tabular/_house_sales/test_house_sales.py

@@ -1,7 +1,7 @@
 import pytest
 from safeds.data.tabular.containers import Table
 from safeds.data.tabular.typing import Integer, RealNumber, Schema
-from safeds_examples.tabular import load_house_sales
+from safeds_datasets.tabular import load_house_sales
 
 
 class TestLoadHouseSales:

tests/safeds_examples/tabular/_titanic/test_titanic.py → tests/safeds_datasets/tabular/_titanic/test_titanic.py

@@ -1,7 +1,7 @@
 import pytest
 from safeds.data.tabular.containers import Table
 from safeds.data.tabular.typing import Anything, Integer, RealNumber, Schema, String
-from safeds_examples.tabular import load_titanic
+from safeds_datasets.tabular import load_titanic
 
 
 class TestLoadTitanic:

tests/safeds_examples/tabular/containers/test_example_table.py → tests/safeds_datasets/tabular/containers/test_tabular_dataset.py

@@ -1,12 +1,12 @@
 import pytest
 from safeds.data.tabular.containers import Column, Table
 from safeds.exceptions import UnknownColumnNameError
-from safeds_examples.tabular.containers import ExampleTable
+from safeds_datasets.tabular.containers import TabularDataset
 
 
 @pytest.fixture()
-def example_table() -> ExampleTable:
-    return ExampleTable(
+def tabular_dataset() -> TabularDataset:
+    return TabularDataset(
         Table.from_columns(
             [
                 Column("a", [1, 2, 3]),
@@ -20,7 +20,7 @@ def example_table() -> ExampleTable:
 class TestInit:
     def test_should_raise_if_column_does_not_exist(self) -> None:
         with pytest.raises(UnknownColumnNameError):
-            ExampleTable(
+            TabularDataset(
                 Table.from_columns(
                     [
                         Column("a", [1, 2, 3]),
@@ -32,8 +32,8 @@ def test_should_raise_if_column_does_not_exist(self) -> None:
 
 
 class TestColumnDescriptions:
-    def test_should_map_column_names_to_descriptions(self, example_table: ExampleTable) -> None:
-        assert example_table.column_descriptions == Table.from_columns(
+    def test_should_map_column_names_to_descriptions(self, tabular_dataset: TabularDataset) -> None:
+        assert tabular_dataset.column_descriptions == Table.from_columns(
             [
                 Column("Name", ["a", "b"]),
                 Column("Description", ["The first column", ""]),
@@ -42,12 +42,12 @@ def test_should_map_column_names_to_descriptions(self, example_table: ExampleTab
 
 
 class TestGetColumnDescription:
-    def test_should_return_description_for_column(self, example_table: ExampleTable) -> None:
-        assert example_table.get_column_description("a") == "The first column"
+    def test_should_return_description_for_column(self, tabular_dataset: TabularDataset) -> None:
+        assert tabular_dataset.get_column_description("a") == "The first column"
 
-    def test_should_return_empty_string_if_no_description_exists(self, example_table: ExampleTable) -> None:
-        assert example_table.get_column_description("b") == ""
+    def test_should_return_empty_string_if_no_description_exists(self, tabular_dataset: TabularDataset) -> None:
+        assert tabular_dataset.get_column_description("b") == ""
 
-    def test_should_raise_error_if_column_does_not_exist(self, example_table: ExampleTable) -> None:
+    def test_should_raise_error_if_column_does_not_exist(self, tabular_dataset: TabularDataset) -> None:
         with pytest.raises(UnknownColumnNameError):
-            example_table.get_column_description("c")
+            tabular_dataset.get_column_description("c")