Skip to content

Commit

Permalink
docs: update README info
Browse files Browse the repository at this point in the history
BREAKING CHANGE
This release changes to a different underlying class system - which should not have any user
visible issues other than there are now no longer the full set of basic methods on an object
that the old ClassForge base gave.  Additionally the classes are generated from the Broadworks
R24 schemas.
  • Loading branch information
nigelm committed Mar 5, 2022
1 parent eac0682 commit 30e4a29
Showing 1 changed file with 15 additions and 2 deletions.
17 changes: 15 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
- python objects to match all Broadworks schema objects
- API framework to talk to a Broadworks server
- additional magic to handle authentication and sessions
- Based on Broadworks schema R21
- Based on Broadworks schema R24

## Current Version

Expand Down Expand Up @@ -52,9 +52,22 @@ response = api.command("SystemSoftwareVersionGetRequest")
print(response.version)
```

## Version 2

Despite the bump in version number there are no known major incompatibilities
from previous versions. However the underlying class base has been changed
to a vanilla python slots based system - the thinking behind this is in the
API internals documentation. This will change the underlying requirements.

Additionally at the same time I have converted to Broadworks R24 API schema
files as the basis for generating these classes.


## Credits

The class is built using Michael DeHaan's [`ClassForge`](https://classforge.io/) object system.
The class used to be built using Michael DeHaan's [`ClassForge`]
(https://classforge.io/) object system, however from version 2.0.0 it has
been based on vanilla python slotted objects.

Development on the python version was done by
[Nigel Metheringham `<nigelm@cpan.org>`](https://github.com/nigelm/)
Expand Down

0 comments on commit 30e4a29

Please sign in to comment.