diff --git a/.gitignore b/.gitignore index 2935f83..ba45f9c 100644 --- a/.gitignore +++ b/.gitignore @@ -166,8 +166,5 @@ cython_debug/ ######################################################################################## # Project specific -exports/* -config.py - - - +examples/config.py +examples/exports/ diff --git a/README.md b/README.md index ed4ad0b..83b01c1 100644 --- a/README.md +++ b/README.md @@ -66,7 +66,7 @@ Change a member's response for an event (e.g. accept/decline) ## Example scripts -The following scripts are included as examples. Some of the scripts might require additional packages to be installed (csv, ical etc). +The following scripts are included in `examples/`. Some of the scripts might require additional packages to be installed (csv, ical etc). Rename the file `config.py.sample` to `config.py` and add your username and password to the file before running the samples. diff --git a/attendance.py b/examples/attendance.py similarity index 100% rename from attendance.py rename to examples/attendance.py diff --git a/config.py.sample b/examples/config.py.sample similarity index 100% rename from config.py.sample rename to examples/config.py.sample diff --git a/groups.py b/examples/groups.py similarity index 100% rename from groups.py rename to examples/groups.py diff --git a/ical.py b/examples/ical.py similarity index 100% rename from ical.py rename to examples/ical.py diff --git a/manual_test_functions.py b/examples/manual_test_functions.py similarity index 100% rename from manual_test_functions.py rename to examples/manual_test_functions.py diff --git a/transactions.py b/examples/transactions.py similarity index 100% rename from transactions.py rename to examples/transactions.py diff --git a/pyproject.toml b/pyproject.toml index 13be00f..baaa160 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -36,11 +36,11 @@ ignore = [ # In example files: # - Don't try to sort imports as non-existent `config` module causes issues in CI # - Don't enforce type annotations for now -"attendance.py" = ["ANN", "I001"] -"groups.py" = ["ANN", "I001"] -"ical.py" = ["ANN", "I001"] -"manual_test_functions.py" = ["I001"] -"transactions.py" = ["ANN", "I001"] +"examples/attendance.py" = ["ANN", "I001"] +"examples/groups.py" = ["ANN", "I001"] +"examples/ical.py" = ["ANN", "I001"] +"examples/manual_test_functions.py" = ["I001"] +"examples/transactions.py" = ["ANN", "I001"] # In tests: # - Don't enforce type annotations for now