Skip to content

Commit

Permalink
Create an expanded example project
Browse files Browse the repository at this point in the history
  • Loading branch information
jbhannah committed Jan 16, 2025
1 parent 74285d9 commit a4510ce
Show file tree
Hide file tree
Showing 11 changed files with 1,511 additions and 157 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ pip install budge

## Usage

See the [demo notebook][demo] for usage examples.
See the [example directory][demo] for usage examples.

## Copyright

Expand All @@ -24,7 +24,7 @@ Copyright © 2025 Jesse Brooklyn Hannah. Licensed under the terms of the
[badge/pypi-publish]: https://github.com/budgeapp/budge/actions/workflows/pypi.yml/badge.svg
[badge/pypi]: https://img.shields.io/pypi/v/budge
[badge/pytest]: https://github.com/budgeapp/budge/actions/workflows/pytest.yml/badge.svg
[demo]: https://github.com/budgeapp/budge/blob/trunk/demo.ipynb
[demo]: https://github.com/budgeapp/budge/blob/trunk/example
[license]: https://github.com/budgeapp/budge/blob/trunk/LICENSE.md
[pypi]: https://pypi.org/project/budge/
[workflows/pypi-publish]: https://github.com/budgeapp/budge/actions/workflows/pypi.yml
Expand Down
155 changes: 0 additions & 155 deletions demo.ipynb

This file was deleted.

1 change: 1 addition & 0 deletions example/.python-version
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
3.13
7 changes: 7 additions & 0 deletions example/.vscode/extensions.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"recommendations": [
"ms-python.python",
"ms-toolsai.jupyter",
"ms-toolsai.datawrangler"
]
}
8 changes: 8 additions & 0 deletions example/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Example Budget

This is an example of how to use a Jupyter notebook and Budge to track and
forecast your budget. All of the dependencies needed to run the notebook at
[`budget.ipynb`][nb] are listed in [`pyproject.toml`][toml].

[nb]: ./budget.ipynb
[toml]: ./pyproject.toml
Loading

0 comments on commit a4510ce

Please sign in to comment.