Skip to content

Add example to readme #72

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
Parent: Add directory context
merged 1 commit into from
Oct 15, 2025
Merged

Add example to readme #72

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
16 changes: 16 additions & 0 deletions docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,22 @@ Easily indicate that some functionality is being deprecated
Raises a warning like `DeprecationWarning: __main__.foo is deprecated: Use bar(a, b) instead. It is not guaranteed to be in service in vers. 0.5.0 foo(1, 2)`


## Directory context

A context manager that changes the current working directory to the given path upon entering the context and reverts to the original directory upon exiting.
If the specified path does not exist, it is created.

```python
>>> import os
>>> from pyiron_snippets.directory_context import set_directory
>>> directory_before_context_is_applied = os.getcwd()
>>> with set_directory("tmp"):
... os.path.relpath(os.getcwd(), directory_before_context_is_applied)
'tmp'

```


## DotDict

A dictionary that allows dot-access. Has `.items()` etc.
Expand Down
Loading