Refactor PagerDuty into a multi-file module #36
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request addresses #27.
It includes significant structural changes to the
pagerduty
package by refactoring what was a monolithic python module file into a multi-file module in thepagerduty
directory.For backwards compatibility, all helper methods and classes are imported to the root namespace of the module (in
__init__.py
). Any new API client classes (i.e. for the newer integration product APIs) are expected to be added in aptly-named files and similarly imported to the root of the module. Classes are expected to be usable as they always previously have. For example:Going forward, any specialized helpers that are declared only in the module where they are used are not necessary to import into the root module namespace (or add to
sphinx/source/module_reference.rst
for that matter) unless the intention is to publish them for use outside their original purpose. All methods should still have docstrings regardless.