Skip to content

Update README.md #155

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update README.md #155

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
11 changes: 8 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,10 @@

[Spond](https://spond.com/welcome) is a team/group-oriented events system.

The unofficial Python [`spond` library package](https://github.com/Olen/Spond/) gets
The unofficial Python `spond` library package ([GitHub](https://github.com/Olen/Spond/), [PyPI](https://pypi.org/project/spond/)) gets
data from the Spond API and returns `dict` objects.

This unofficial Python `spond-classes` library package parses those `dict` objects to
create [Pydantic](https://docs.pydantic.dev/) class instances.
This unofficial Python `spond-classes` library package ([GitHub](https://github.com/elliot-100/Spond-classes), [PyPI](https://pypi.org/project/spond-classes/)) parses those `dict`s using [Pydantic](https://docs.pydantic.dev/) to create class instances.

Partial, read-only implementation.

Expand All @@ -25,6 +24,12 @@ poetry add spond-classes
Note that [`spond`](https://github.com/Olen/Spond/) is required for practical use, but not a technical dependency,
so needs to be installed separately.

> [!IMPORTANT]
> The project is `Spond-classes`; the PYPI package is `spond-classes` with a hyphen; the module name is `spond_classes` with an underscore.
>
> So it's `pip install spond-classes` but `import spond-classes`.
>
> This may change.

## Example code

Expand Down
Loading