Skip to content

Update package structure #27

Closed
wants to merge 43 commits into from
Closed

Conversation

campb303
Copy link
Collaborator

@campb303 campb303 commented May 6, 2021

Refactoring of code to increase modularity. Also adds config file and command line argument support for interacting with the static module.

Closes #20

@campb303 campb303 self-assigned this May 6, 2021
@campb303 campb303 linked an issue May 6, 2021 that may be closed by this pull request
@campb303 campb303 added the high-priority Needs immediate extra focus label May 17, 2021
@campb303
Copy link
Collaborator Author

Working on this.

@campb303
Copy link
Collaborator Author

Initial review thoughts:

Much more than just a restructuring of the package went into this PR

  • Restructuring
  • Logging
  • Argument parsing
  • Static module commands
  • Refactoring
  • Global config sharing
  • Utilities added

I've yet to confirm functionality but the code itself is hard to follow with mountains of nested conditionals and spaghetti imports. Significant refactoring will be needed for the code to be acceptable. In addition to this, the various steps of the API need to be consolidated rather than repeated in various sections. Comments/doc blocks also need to be updated.

The next steps are:

  1. Confirm functionality
  2. Create a diagram of intended control flow
  3. Research best import practices and update import pattern
  4. Research best config sharing practices and consolidate config parsing
  5. Rewrite logical checks with explicit language (ex config not None -> configExists)
  6. Research and implement gunicorn control via module commands
  7. Cleanup argparse with explicit argument options
  8. Refactor parser to reduce excessive IO that was introduced with its separation
  9. Move WSGI logging from resources to gunicorn logs
  10. Update doc blocks
  11. Update log messages

There may be more. This might need to be rebranched and approached more systematically.

@campb303
Copy link
Collaborator Author

Closing in favor of refactor-to-module-layout branch.

@campb303 campb303 closed this Jun 21, 2021
@campb303 campb303 deleted the update-package-structure branch August 2, 2021 23:26
Sign in to join this conversation on GitHub.
Labels
high-priority Needs immediate extra focus
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Package Structure
2 participants