forked from transifex/PyGithub
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Implement License API (PyGithub#734)
* Implement License API * Update copyright
- Loading branch information
Showing
12 changed files
with
315 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,162 @@ | ||
| # -*- coding: utf-8 -*- | ||
|
|
||
| ############################ Copyrights and license ############################ | ||
| # # | ||
| # Copyright 2018 Wan Liuyang <[email protected]> # | ||
| # # | ||
| # This file is part of PyGithub. # | ||
| # http://pygithub.readthedocs.io/ # | ||
| # # | ||
| # PyGithub is free software: you can redistribute it and/or modify it under # | ||
| # the terms of the GNU Lesser General Public License as published by the Free # | ||
| # Software Foundation, either version 3 of the License, or (at your option) # | ||
| # any later version. # | ||
| # # | ||
| # PyGithub is distributed in the hope that it will be useful, but WITHOUT ANY # | ||
| # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS # | ||
| # FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more # | ||
| # details. # | ||
| # # | ||
| # You should have received a copy of the GNU Lesser General Public License # | ||
| # along with PyGithub. If not, see <http://www.gnu.org/licenses/>. # | ||
| # # | ||
| ################################################################################ | ||
|
|
||
| import github.GithubObject | ||
| import github.PaginatedList | ||
|
|
||
| import github.NamedUser | ||
|
|
||
|
|
||
| class License(github.GithubObject.CompletableGithubObject): | ||
| """ | ||
| This class represents Licenses. The reference can be found here https://developer.github.com/v3/licenses/ | ||
| """ | ||
|
|
||
| def __repr__(self): | ||
| return self.get__repr__({"name": self._name.value}) | ||
|
|
||
| @property | ||
| def key(self): | ||
| """ | ||
| :type: string | ||
| """ | ||
| self._completeIfNotSet(self._key) | ||
| return self._key.value | ||
|
|
||
| @property | ||
| def name(self): | ||
| """ | ||
| :type: string | ||
| """ | ||
| self._completeIfNotSet(self._name) | ||
| return self._name.value | ||
|
|
||
| @property | ||
| def spdx_id(self): | ||
| """ | ||
| :type: string | ||
| """ | ||
| self._completeIfNotSet(self._spdx_id) | ||
| return self._spdx_id.value | ||
|
|
||
| @property | ||
| def url(self): | ||
| """ | ||
| :type: string | ||
| """ | ||
| self._completeIfNotSet(self._url) | ||
| return self._url.value | ||
|
|
||
| @property | ||
| def html_url(self): | ||
| """ | ||
| :type: string | ||
| """ | ||
| self._completeIfNotSet(self._html_url) | ||
| return self._html_url.value | ||
|
|
||
| @property | ||
| def description(self): | ||
| """ | ||
| :type: string | ||
| """ | ||
| self._completeIfNotSet(self._description) | ||
| return self._description.value | ||
|
|
||
| @property | ||
| def implementation(self): | ||
| """ | ||
| :type: string | ||
| """ | ||
| self._completeIfNotSet(self._implementation) | ||
| return self._implementation.value | ||
|
|
||
| @property | ||
| def body(self): | ||
| """ | ||
| :type: string | ||
| """ | ||
| self._completeIfNotSet(self._body) | ||
| return self._body.value | ||
|
|
||
| @property | ||
| def permissions(self): | ||
| """ | ||
| :type: list of string | ||
| """ | ||
| self._completeIfNotSet(self._permissions) | ||
| return self._permissions.value | ||
|
|
||
| @property | ||
| def conditions(self): | ||
| """ | ||
| :type: list of string | ||
| """ | ||
| self._completeIfNotSet(self._conditions) | ||
| return self._conditions.value | ||
|
|
||
| @property | ||
| def limitations(self): | ||
| """ | ||
| :type: list of string | ||
| """ | ||
| self._completeIfNotSet(self._limitations) | ||
| return self._limitations.value | ||
|
|
||
| def _initAttributes(self): | ||
| self._key = github.GithubObject.NotSet | ||
| self._name = github.GithubObject.NotSet | ||
| self._spdx_id = github.GithubObject.NotSet | ||
| self._url = github.GithubObject.NotSet | ||
| self._html_url = github.GithubObject.NotSet | ||
| self._description = github.GithubObject.NotSet | ||
| self._implementation = github.GithubObject.NotSet | ||
| self._body = github.GithubObject.NotSet | ||
| self._permissions = github.GithubObject.NotSet | ||
| self._conditions = github.GithubObject.NotSet | ||
| self._limitations = github.GithubObject.NotSet | ||
|
|
||
| def _useAttributes(self, attributes): | ||
| if "key" in attributes: # pragma no branch | ||
| self._key = self._makeStringAttribute(attributes["key"]) | ||
| if "name" in attributes: # pragma no branch | ||
| self._name = self._makeStringAttribute(attributes["name"]) | ||
| if "spdx_id" in attributes: # pragma no branch | ||
| self._spdx_id = self._makeStringAttribute(attributes["spdx_id"]) | ||
| if "url" in attributes: # pragma no branch | ||
| self._url = self._makeStringAttribute(attributes["url"]) | ||
| if "html_url" in attributes: # pragma no branch | ||
| self._html_url = self._makeStringAttribute(attributes["html_url"]) | ||
| if "description" in attributes: # pragma no branch | ||
| self._description = self._makeStringAttribute(attributes["description"]) | ||
| if "implementation" in attributes: # pragma no branch | ||
| self._implementation = self._makeStringAttribute(attributes["implementation"]) | ||
| if "body" in attributes: # pragma no branch | ||
| self._body = self._makeStringAttribute(attributes["body"]) | ||
| if "permissions" in attributes: # pragma no branch | ||
| self._permissions = self._makeListOfStringsAttribute(attributes["permissions"]) | ||
| if "conditions" in attributes: # pragma no branch | ||
| self._conditions = self._makeListOfStringsAttribute(attributes["conditions"]) | ||
| if "limitations" in attributes: # pragma no branch | ||
| self._limitations = self._makeListOfStringsAttribute(attributes["limitations"]) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
| # -*- coding: utf-8 -*- | ||
|
|
||
| ############################ Copyrights and license ############################ | ||
| # # | ||
| # Copyright 2018 Wan Liuyang <[email protected]> # | ||
| # # | ||
| # This file is part of PyGithub. # | ||
| # http://pygithub.readthedocs.io/ # | ||
| # # | ||
| # PyGithub is free software: you can redistribute it and/or modify it under # | ||
| # the terms of the GNU Lesser General Public License as published by the Free # | ||
| # Software Foundation, either version 3 of the License, or (at your option) # | ||
| # any later version. # | ||
| # # | ||
| # PyGithub is distributed in the hope that it will be useful, but WITHOUT ANY # | ||
| # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS # | ||
| # FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more # | ||
| # details. # | ||
| # # | ||
| # You should have received a copy of the GNU Lesser General Public License # | ||
| # along with PyGithub. If not, see <http://www.gnu.org/licenses/>. # | ||
| # # | ||
| ################################################################################ | ||
|
|
||
| import Framework | ||
|
|
||
|
|
||
| class License(Framework.TestCase): | ||
| def setUp(self): | ||
| Framework.TestCase.setUp(self) | ||
| self.license = self.g.get_license("mit") | ||
|
|
||
| def testAttributes(self): | ||
| self.assertEqual(self.license.key, "mit") | ||
| self.assertEqual(self.license.name, "MIT License") | ||
| self.assertEqual(self.license.description, "A short and simple permissive license with conditions only requiring preservation of copyright and license notices. Licensed works, modifications, and larger works may be distributed under different terms and without source code.") | ||
| self.assertEqual(self.license.spdx_id, "MIT") | ||
| self.assertEqual(self.license.body, """MIT License\n\nCopyright (c) [year] [fullname]\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the "Software"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n""") | ||
| self.assertEqual(self.license.permissions, ['commercial-use', 'modifications', 'distribution', 'private-use']) | ||
| self.assertEqual(self.license.conditions, ['include-copyright']) | ||
| self.assertEqual(self.license.limitations, ['liability', 'warranty']) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| https | ||
| GET | ||
| api.github.com | ||
| None | ||
| /licenses/mit | ||
| {'Authorization': 'Basic login_and_password_removed', 'User-Agent': 'PyGithub/Python'} | ||
| None | ||
| 200 | ||
| [('content-length', '1927'), ('x-runtime-rack', '0.023326'), ('vary', 'Accept, Authorization, Cookie, X-GitHub-OTP, Accept-Encoding'), ('x-oauth-scopes', 'admin:gpg_key, admin:org, admin:org_hook, admin:public_key, admin:repo_hook, delete_repo, gist, notifications, repo, user, write:discussion'), ('x-xss-protection', '1; mode=block'), ('x-content-type-options', 'nosniff'), ('x-accepted-oauth-scopes', ''), ('etag', '"9f803324f4a6fde118084a597a68c1c5"'), ('cache-control', 'private, max-age=60, s-maxage=60'), ('referrer-policy', 'origin-when-cross-origin, strict-origin-when-cross-origin'), ('status', '200 OK'), ('x-ratelimit-remaining', '4547'), ('x-github-media-type', 'github.v3; format=json'), ('access-control-expose-headers', 'ETag, Link, Retry-After, X-GitHub-OTP, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset, X-OAuth-Scopes, X-Accepted-OAuth-Scopes, X-Poll-Interval'), ('x-github-request-id', 'DC94:787A:D084B:115523:5AB31F73'), ('date', 'Thu, 22 Mar 2018 03:13:55 GMT'), ('access-control-allow-origin', '*'), ('content-security-policy', "default-src 'none'"), ('strict-transport-security', 'max-age=31536000; includeSubdomains; preload'), ('server', 'GitHub.com'), ('x-ratelimit-limit', '5000'), ('x-frame-options', 'deny'), ('content-type', 'application/json; charset=utf-8'), ('x-ratelimit-reset', '1521689363')] | ||
| {"key":"mit","name":"MIT License","spdx_id":"MIT","url":"https://api.github.com/licenses/mit","html_url":"http://choosealicense.com/licenses/mit/","description":"A short and simple permissive license with conditions only requiring preservation of copyright and license notices. Licensed works, modifications, and larger works may be distributed under different terms and without source code.","implementation":"Create a text file (typically named LICENSE or LICENSE.txt) in the root of your source code and copy the text of the license into the file. Replace [year] with the current year and [fullname] with the name (or names) of the copyright holders.","permissions":["commercial-use","modifications","distribution","private-use"],"conditions":["include-copyright"],"limitations":["liability","warranty"],"body":"MIT License\n\nCopyright (c) [year] [fullname]\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n","featured":true} |
Oops, something went wrong.