Skip to content
This repository has been archived by the owner on Aug 29, 2021. It is now read-only.

Release v1.0.0 #17

Closed
17 tasks done
robertwayne opened this issue Aug 17, 2020 · 2 comments
Closed
17 tasks done

Release v1.0.0 #17

robertwayne opened this issue Aug 17, 2020 · 2 comments

Comments

@robertwayne
Copy link
Owner

robertwayne commented Aug 17, 2020

Looking to move this little library into a stable, released form. These are the changes that I feel need to be met first... many will be largely breaking for versions >1.0.0:

  • Commit to and stabilize the API.
    • Remove all optional parameters from pages and menus. See CHANGELOG on why fluent-style is better here. This follows the discord.py convention in any case.
    • Implement fluent-style API for all menus and pages.
    • Rewrite examples to use fluent-style chaining.
      • Text
      • Button
      • Paginated
      • Poll
  • Test Poll helpers to confirm they are stable and correct.
    - [ ] Add decorator magic for making setting up ButtonMenu's much less ugly.
  • Add custom button overrides to PaginatedMenu.
  • Add to_first and to_last buttons on PaginatedMenu defaults.
  • Optimize *Menus and Pages with _slots_?
    - [ ] Implement methods for properly extending the BaseMenu open method instead of using completely custom methods for every menu type. Should be much easier with proper events, and allows for simple Custom menu types.
  • Add helper function to flush the session list manually.
    - [ ] Write custom documentation accessible on the site.
    - [ ] Write tutorials for each menu type on the site.
    - [ ] Text
    - [ ] Button
    - [ ] Paginated
    - [ ] Poll
    ~~ - [ ] Custom~~
  • Update README to include new changes and point to the completed site.
    • Replace examples/ files with trimmed, no-inline commented versions.
  • Update the CHANGELOG.
  • Set up GitHub Releases.
@robertwayne robertwayne pinned this issue Aug 17, 2020
@robertwayne
Copy link
Owner Author

The release candidate version is available at pip install dpymenus==1.0.0rc2 currently. I am just going to go through a battery of additional tests and double-check remaining documentation and it should be good to go. No further breaking changes.

Please note if you're upgrading from the beta version, there will be a lot of breaking changes. It should not be hard to update, and I do recommend it as it is much cleaner and stable overall.

@robertwayne
Copy link
Owner Author

Initial release complete. Any crossed off items will be moved toward a later release. You can install the latest version with pip install dpymenus.

@robertwayne robertwayne unpinned this issue Oct 20, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant