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.

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

Refactoring protocol packages #160

Closed
andrewwhitehead opened this issue Aug 28, 2019 · 2 comments
Closed

Refactoring protocol packages #160

andrewwhitehead opened this issue Aug 28, 2019 · 2 comments
Milestone

Comments

@andrewwhitehead
Copy link
Contributor

andrewwhitehead commented Aug 28, 2019

As discussed with @swcurran

  • Protocol packages (currently located under aries_cloudagent.messaging along with various messaging framework classes) should be moved into a new subpackage, likely aries_cloudagent.protocols. This aligns with the move from 'message families' to 'protocols' in the RFCs. It may be desirable to use a script or refactoring tool to reduce the manual edits required as a result.
  • In order to improve the generated documentation, class files should be moved out of the base package (including classloader.py, conductor.py, dispatcher.py, and friends) into existing or new subpackages.

This change should be aligned with a minor release to allow any dependent packages to be updated.

@swcurran
Copy link
Contributor

Let me know when you do this as I've put links in the RTD index.rst to the protocols generated code. Best to align this change with an update to the index.rst.

@andrewwhitehead andrewwhitehead added this to the Version 0.4.0 milestone Sep 27, 2019
@andrewwhitehead
Copy link
Contributor Author

Addressed by #250, #301

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants