C1 - Mailroom OO Revision

[natasha-aleksandrova]

Please review the revision. Anything else should be added? (or removed?)

[PythonCHB]

In my OO mailroom solution: source/solutions/mailroom/mailroom_oo

I kept everything in one file (plus a test file).

Then, in mailroom_package (in course 2, though it may not be there anymore), I split it up similarily to how you are suggesting:

source/solutions/mailroom/mailroom_pkg

While also adding a bit more to make it a proper package.

I like the idea of having them split up the data management and CLI, but I wonder if we'll have confusion about how to import, and how to run the code.

It may be just fine if they always run it from the dir where the files are -- but be prepared for questions!

[natasha-aleksandrova]

for your main comment; given that they have to import mailroom to test it in lesson 6 (along with all further assignments that unit test), they are doing imports already.

[natasha-aleksandrova]

@PythonCHB thanks for review!

I will work on updates later today.

[PythonCHB]

Yes -- for importing, but we should probably put a bit of guidance in here, too to remind them.

As for building the docs -- it's using Sphinx, which is pretty simple to use (once it's set up...), but you do need to have Sphinx and rtd_theme installed. I think this will do it:

pip install sphinx sphinx_rtd_theme

I suspect PyCharm is doing raw RST rendering, which gets you most of the way, but won't have any of the Sphinx niceties like table of contents, cross referencing, etc.

[natasha-aleksandrova]

@PythonCHB ok I have pushed some updates.

• fixed the heading
• simplified mailroom code organization since that is something they do in next course anyway

FYI, I tried installing Sphinx and running make html but running into missing dependency errors. I'll see if I can get away with pycharm plugin so I don't get bogged down on this.

[PythonCHB]

I added a touch -- but it looks great -- merging away.

[natasha-aleksandrova]

great adds! thanks!

[natasha-aleksandrova]

Mailroom OO