Tagstore API improvements

[bradenmacdonald]

A few last API improvements to make this tagstore API a bit nicer, before we get too locked in.

• Per @symbolist's suggestion, Tag.tag is now Tag.name which I think is much nicer
• The API was missing a way to get an existing Tag without constructing it yourself, so I added a get_tag() method
• Made the Taxonomy class a bit more pythonic by giving it some methods, so now you can do taxonomy.add_tag('foo') instead of tagstore.add_tag_to_taxonomy('foo', taxonomy)

Testing instructions:

• The unit tests should cover everything quite well, so mostly review the code. You can also run the updated example code from README.rst.

[pomegranited]

Thanks for these tweaks @bradenmacdonald , the API is looking much nicer!

I did a full read through everything again since we're fine tuning, and made several suggestions below.

But the code example works as described, so will approve when these changes are made.

[pomegranited]

I wasn't able to find a case where the "returned (existing) Tag may differ in case" occurrs.. suggest something like this instead?

If a Tag already exists in the taxonomy with the given name (case-insensitive) with the given parent, then that Tag is returned and no changes are made.

[bradenmacdonald]

I wasn't able to find a case where the "returned (existing) Tag may differ in case"

There is a test case showing that? https://github.com/open-craft/blockstore/blob/05a88e283d81f67bb7094df6d7a453ef40ab3890/tagstore/backends/tests.py#L73-L75

I do like your wording though, so I'll use it.

[pomegranited]

Ah gotcha.. thanks for that example!

[pomegranited]

Looks like your change to the wording hasn't make it in yet?

[bradenmacdonald]

It did make it in in tagstore.py but I missed taxonomy.py. Fixed now :)

[bradenmacdonald]

Thanks @pomegranited, great points. Fixes are all made in aba94c9

[pomegranited]

@bradenmacdonald Thank you for these changes! I think there's just one missing, but ok to merge once it's in 👍

• I tested this by running the API example code from the updated README and checking the results came out as expected.
• I read through the code.
• I checked for accessibility issues N/A
• Includes great documentation.

[openedx-webhooks]

Although this pull request is already merged, I've created OSPR-5476 so that we can track it in Jira.

There is nothing you have to do. No action is needed from your side. Thanks again for your contribution.