Skip to content
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

Jump to bottom

Update readme and example #804

Merged
merged 17 commits into from
Feb 10, 2024
Merged

Update readme and example #804

merged 17 commits into from
Feb 10, 2024

Commits on Jan 28, 2024

  1. Remove function and class that shouldn't be public 

    This remove base62 and WebsocketWrapper
    @PierreF
    PierreF committed Jan 28, 2024
    Configuration menu
    Copy the full SHA
    66c075e View commit details
    Browse the repository at this point in the history

  2. Rename to ReasonCode (singular) 

    The class instance represent ONE reason code, it was odd
to have a variable of type `ReasonCodes` (e.g. `rc: ReasonCodes`),
when that variable was a single value.
    @PierreF
    PierreF committed Jan 28, 2024
    Configuration menu
    Copy the full SHA
    a38011d View commit details
    Browse the repository at this point in the history

  3. Remove ConnectionState that shouldn't be public

    @PierreF
    PierreF committed Jan 28, 2024
    Configuration menu
    Copy the full SHA
    49eb1c7 View commit details
    Browse the repository at this point in the history

  4. Enable logger in publish & subscribe helper

    @PierreF
    PierreF committed Jan 28, 2024
    Configuration menu
    Copy the full SHA
    8dfce36 View commit details
    Browse the repository at this point in the history

  5. Add is_failure property on ReasonCodes

    @PierreF
    PierreF committed Jan 28, 2024
    Configuration menu
    Copy the full SHA
    b6e09b8 View commit details
    Browse the repository at this point in the history

  6. Update README following latest API change 

    Also remove all function documentation from README, they are
moved exclusively to pydoc to avoid duplicating the documentations.
The README should contains guide & examples, and pydoc contains reference
documentations.
    @PierreF
    PierreF committed Jan 28, 2024
    Configuration menu
    Copy the full SHA
    75d93f4 View commit details
    Browse the repository at this point in the history

  7. Stop suggesting to install dnspython3 

    dnspython3 is deprecated and replaced by dnspython
    @PierreF
    PierreF committed Jan 28, 2024
    Configuration menu
    Copy the full SHA
    53505af View commit details
    Browse the repository at this point in the history

  8. Add __repr__ to ReasonCodes 

    This allow to have better print for a list of ReasonCodes, for
example in on_subscribe callback.
    @PierreF
    PierreF committed Jan 28, 2024
    Configuration menu
    Copy the full SHA
    8c398c0 View commit details
    Browse the repository at this point in the history

  9. Update examples following breaking change of #802

    @PierreF
    PierreF committed Jan 28, 2024
    Configuration menu
    Copy the full SHA
    2870f5f View commit details
    Browse the repository at this point in the history

  10. Fix README format

    @PierreF
    PierreF committed Jan 28, 2024
    Configuration menu
    Copy the full SHA
    192fbf6 View commit details
    Browse the repository at this point in the history

  11. Add Sphinx documentation 

    Add markdown build to host the documentation using the
Github repository.
    @PierreF
    PierreF committed Jan 28, 2024
    Configuration menu
    Copy the full SHA
    fb1b93b View commit details
    Browse the repository at this point in the history

Commits on Feb 6, 2024

  1. Drop markdown build from git repository

    @PierreF
    PierreF committed Feb 6, 2024
    Configuration menu
    Copy the full SHA
    87ce6f6 View commit details
    Browse the repository at this point in the history

  2. Move migrations.md to docs (and convert to rst)

    @PierreF
    PierreF committed Feb 6, 2024
    Configuration menu
    Copy the full SHA
    a2d7534 View commit details
    Browse the repository at this point in the history

  3. Include ChangeLog in Sphinx docs

    @PierreF
    PierreF committed Feb 6, 2024
    Configuration menu
    Copy the full SHA
    a44e1c5 View commit details
    Browse the repository at this point in the history

  4. Add links to online Sphinx documentation

    @PierreF
    PierreF committed Feb 6, 2024
    Configuration menu
    Copy the full SHA
    6f4ad37 View commit details
    Browse the repository at this point in the history

  5. Add note that 2.0 is not yet released

    @PierreF
    PierreF committed Feb 6, 2024
    Configuration menu
    Copy the full SHA
    8645d3b View commit details
    Browse the repository at this point in the history

Commits on Feb 7, 2024

  1. Fix spelling 

    Co-authored-by: Danny Staple <danny@orionrobots.co.uk>
    @PierreF @dannystaple
    PierreF and dannystaple committed Feb 7, 2024
    Configuration menu
    Copy the full SHA
    80667d2 View commit details
    Browse the repository at this point in the history