Update for Prism V3

[wd-mgreynolds]

No description provided.

[CurtLH]

@wd-mgreynolds -- I tried to install your fork of the library, but the following error was generated:

Traceback (most recent call last):
  File "/Users/curtis.hampton/miniconda3/envs/example-dev/bin/prism", line 5, in <module>
    from prism.cli import main
  File "/Users/curtis.hampton/miniconda3/envs/example-dev/lib/python3.8/site-packages/prism/cli.py", line 9, in <module>
    import commands.tables_commands as t_commands
ModuleNotFoundError: No module named 'commands'

I wonder if you might have to edit the __init__.py to include the modules within ./commands/?

[CurtLH]

@wd-mgreynolds -- this isn't a complete review, but a couple things that we can start to think about as we review all the proposed changes.

[CurtLH]

Fixed - there was a left-over garbage after a code refactor - fixed. This begs the question - should the pytest be more extensive?

I also added a sanity check to make sure a configuration (base_url/tenant/id/secret) was detected.

@wd-mgreynolds -- one day, I do think pytest could be more extensive. It's a bit tricky through because we would need to create a mock API in order for it to interact with. There are things like requests-mock and vcrpy to do this, but let's explore those after we get this initial support for V3 merged.

[wd-mgreynolds]

I've pushed a first-cut of the revised README.md. I elaborated quite a bit with the idea that a non-administrator would be looking for this type of functionality, so more info is better. This is not final, but the overall structure is in place. Please review for structure and level of detail - final word smithing is still on the plate.

[wd-mgreynolds]

I did another pass on the README - the text should be complete. I'm still thinking about the images, in terms of size, borders, and possibly animated GIFs. I like the idea of animations, but it can get really annoying after the first time the animation runs.

[CurtLH]

I did another pass on the README - the text should be complete. I'm still thinking about the images, in terms of size, borders, and possibly animated GIFs. I like the idea of animations, but it can get really annoying after the first time the animation runs.

@wd-mgreynolds -- I appreciate the thoroughness, but I think this is too much detail for the README. This level of documentation would be fine in Community, but I don't think GitHub is the right place. For example, check out the README for the Google API Client or the README for Boto3.

I think this README should have the following sections:

• Overview of the package
• Description of why it's useful
• How to install it (this should only include the pip installation instructions, we don't need to show people how to install Python, PIP, or Git)
• Examples of how to use the package (both the CLI and the Python Package)
• How to report bugs or request new features

After this initial release, we can consider building further documentation helping a user get started, but the README should be brief and only the essential information.

[wd-mgreynolds]

Thanks for the feedback and I appreciate your partnership. Unfortunately other commitments will limit the speed with which I will be able to make further changes. My manager has requested a hand-off meeting to provide any last details or answer any questions. Let me know if there's a better time next week and I'll throw a meeting on the calendar.

[CurtLH]

@wd-mgreynolds -- if you want to add me as a contributor to your forked repo, I can make some edits to the README.