Add support for getting and replacing topics on a repository

[peterkline]

Topics are a fairly new feature within Github. Currently this functionality is provided in the API in a beta mode. We have a need to use these to add attributes and then consume them for automation. Hopefully this helps others.

API Documentation:
List topics in a repo
Replace topics in a repo

Examples of use:

# Get list of topics from a repository    
topics = repo_obj.get_topics()

# Replace current (if there are any) topics with list
repo_obj.replace_topics(['base', 'personal', 'playground'])

[TheVetter]

Has topics support been added?

[sfdye]

@TheVetter Should be soon, I have reviewed the PR and still waiting response for the original author @peterkline

[migueleliasweb]

While this issue is not fixed, we should be able to access the topics with the _rawData, right ?

[sfdye]

@migueleliasweb I am afraid not, as it requires calling another endpoint. (/topics) However, I will try to get this merged soon.

[migueleliasweb]

I thought the same but apparently the topics list is returned from the repo itself. Ps: Dunno if this was a recent change on the API itself.

See: https://developer.github.com/v3/repos/#get

[sfdye]

@migueleliasweb You are right, the topics attributes is currently in preview, but to edit the attributes we still need to go back to /topics endpoint.

[migueleliasweb]

@sfdye I just wanted to list them =/

Anyway... I seem unable to get them even accessing the _rawData directly. See:

ipdb> ll
    643     def get_repo(self, name):
    644         """
    645         :calls: `GET /repos/:owner/:repo <http://developer.github.com/v3/repos>`_
    646         :param name: string
    647         :rtype: :class:`github.Repository.Repository`
    648         """
    649         assert isinstance(name, str), name
    650         headers, data = self._requester.requestJsonAndCheck(
    651             "GET",
    652             "/repos/" + self.login + "/" + name
    653         )
--> 654         return github.Repository.Repository(self._requester, headers, data, completed=True)
    655 

ipdb> data["topics"]
*** KeyError: 'topics'

[sfdye]

@migueleliasweb You're missing the custom header application/vnd.github.mercy-preview+json. I guess this is new so the master doesn't have it yet.

[migueleliasweb]

@sfdye Pardon me, I totally missed that !

[edanhauon]

Hi @sfdye
How soon is soon?

I ask since My app is dependent on this matter - and if it won't happen soon we'll have to develop this ourselves.

Your help is much appreciated 👍.

Edan

[sfdye]

@edanhauon The original author is not responding, so if you could open a new PR I am happy to review and cut a new version once that's merged.

[edanhauon]

Could you maybe add me to the current PR so I could what has been done already?

Thanks,
Edan

[sfdye]

@edanhauon what do you mean?

[edanhauon]

@sfdye never mind, I see it in this thread. thanks.

[peterkline]

Sorry guys for not being around. Been buried with work related coding. if you can't wait for about 12 hours for me to make any mods and redo the PR then by all means fork off whats here. If you can wait I will finish the coding.

[sfdye]

@peterkline I can wait

[edanhauon]

@peterkline same :)

[wyardley]

Patch works for me, with the notes mentioned in the PR, that is, it would be a little more user-friendly if you can pass that array back rather than having to send it as {'name': topics}, so like so:

topics = repo.get_topics()
topics.append('foobar')
repo.replace_topics(data)

vs

topics = repo.get_topics()
topics.append('foobar')
data = {'names': topics}
repo.replace_topics(data)

[sfdye]

@wyardley suggestion accepted

[sfdye]

Anyone care to get this thing moving? Topic is a stable feature now, I wanna make it happen!

[stale]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

[wyardley]

I'm proposing #832, which resolves the test failure, and I think resolves most of this feedback? It also switches the input to replace_topics() to the expected array as discussed. Would appreciate feedback, esp. on the test case I added.

[sfdye]

Merged in #832 thanks to @wyardley and credits to @peterkline for the original PR 🎉