Skip to content

Move code examples to examples/ directory #215

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
elliot-100 merged 1 commit into from
Feb 23, 2026
Merged

Move code examples to examples/ directory #215

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 2 additions & 5 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -166,8 +166,5 @@ cython_debug/
########################################################################################

# Project specific
exports/*
config.py



examples/config.py
examples/exports/
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
0 attendance.py → examples/attendance.py
View file
Open in desktop
File renamed without changes.
0 config.py.sample → examples/config.py.sample
View file
Open in desktop
File renamed without changes.
0 groups.py → examples/groups.py
View file
Open in desktop
File renamed without changes.
0 ical.py → examples/ical.py
View file
Open in desktop
File renamed without changes.
0 manual_test_functions.py → examples/manual_test_functions.py
View file
Open in desktop
File renamed without changes.
0 transactions.py → examples/transactions.py
View file
Open in desktop
File renamed without changes.
10 changes: 5 additions & 5 deletions pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down