├── .gitignore ├── CHANGES.txt ├── LICENSE ├── README ├── README.md ├── github.py ├── sample_basic.py ├── sample_content.py ├── sample_issue.py └── setup.py /.gitignore: -------------------------------------------------------------------------------- 1 | # generated by: https://gitignore.itranswarp.com/ 2 | 3 | #################### Python.gitignore #################### 4 | 5 | # Byte-compiled / optimized / DLL files 6 | __pycache__/ 7 | *.py[cod] 8 | *$py.class 9 | 10 | # C extensions 11 | *.so 12 | 13 | # Distribution / packaging 14 | .Python 15 | build/ 16 | develop-eggs/ 17 | dist/ 18 | downloads/ 19 | eggs/ 20 | .eggs/ 21 | lib/ 22 | lib64/ 23 | parts/ 24 | sdist/ 25 | var/ 26 | wheels/ 27 | share/python-wheels/ 28 | *.egg-info/ 29 | .installed.cfg 30 | *.egg 31 | MANIFEST 32 | 33 | # PyInstaller 34 | # Usually these files are written by a python script from a template 35 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 36 | *.manifest 37 | *.spec 38 | 39 | # Installer logs 40 | pip-log.txt 41 | pip-delete-this-directory.txt 42 | 43 | # Unit test / coverage reports 44 | htmlcov/ 45 | .tox/ 46 | .nox/ 47 | .coverage 48 | .coverage.* 49 | .cache 50 | nosetests.xml 51 | coverage.xml 52 | *.cover 53 | *.py,cover 54 | .hypothesis/ 55 | .pytest_cache/ 56 | cover/ 57 | 58 | # Translations 59 | *.mo 60 | *.pot 61 | 62 | # Django stuff: 63 | *.log 64 | local_settings.py 65 | db.sqlite3 66 | db.sqlite3-journal 67 | 68 | # Flask stuff: 69 | instance/ 70 | .webassets-cache 71 | 72 | # Scrapy stuff: 73 | .scrapy 74 | 75 | # Sphinx documentation 76 | docs/_build/ 77 | 78 | # PyBuilder 79 | .pybuilder/ 80 | target/ 81 | 82 | # Jupyter Notebook 83 | .ipynb_checkpoints 84 | 85 | # IPython 86 | profile_default/ 87 | ipython_config.py 88 | 89 | # pyenv 90 | # For a library or package, you might want to ignore these files since the code is 91 | # intended to run in multiple environments; otherwise, check them in: 92 | # .python-version 93 | 94 | # pipenv 95 | # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. 96 | # However, in case of collaboration, if having platform-specific dependencies or dependencies 97 | # having no cross-platform support, pipenv may install dependencies that don't work, or not 98 | # install all needed dependencies. 99 | #Pipfile.lock 100 | 101 | # poetry 102 | # Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control. 103 | # This is especially recommended for binary packages to ensure reproducibility, and is more 104 | # commonly ignored for libraries. 105 | # https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control 106 | #poetry.lock 107 | 108 | # pdm 109 | # Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control. 110 | #pdm.lock 111 | # pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it 112 | # in version control. 113 | # https://pdm.fming.dev/#use-with-ide 114 | .pdm.toml 115 | 116 | # PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm 117 | __pypackages__/ 118 | 119 | # Celery stuff 120 | celerybeat-schedule 121 | celerybeat.pid 122 | 123 | # SageMath parsed files 124 | *.sage.py 125 | 126 | # Environments 127 | .env 128 | .venv 129 | env/ 130 | venv/ 131 | ENV/ 132 | env.bak/ 133 | venv.bak/ 134 | 135 | # Spyder project settings 136 | .spyderproject 137 | .spyproject 138 | 139 | # Rope project settings 140 | .ropeproject 141 | 142 | # mkdocs documentation 143 | /site 144 | 145 | # mypy 146 | .mypy_cache/ 147 | .dmypy.json 148 | dmypy.json 149 | 150 | # Pyre type checker 151 | .pyre/ 152 | 153 | # pytype static type analyzer 154 | .pytype/ 155 | 156 | # Cython debug symbols 157 | cython_debug/ 158 | 159 | # PyCharm 160 | # JetBrains specific template is maintained in a separate JetBrains.gitignore that can 161 | # be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore 162 | # and can be added to the global gitignore or merged into this file. For a more nuclear 163 | # option (not recommended) you can uncomment the following to ignore the entire idea folder. 164 | #.idea/ 165 | 166 | #################### Archives.gitignore #################### 167 | 168 | # It's better to unpack these files and commit the raw source because 169 | # git has its own built in compression methods. 170 | *.7z 171 | *.jar 172 | *.rar 173 | *.zip 174 | *.gz 175 | *.gzip 176 | *.tgz 177 | *.bzip 178 | *.bzip2 179 | *.bz2 180 | *.xz 181 | *.lzma 182 | *.cab 183 | *.xar 184 | 185 | # Packing-only formats 186 | *.iso 187 | *.tar 188 | 189 | # Package management formats 190 | *.dmg 191 | *.xpi 192 | *.gem 193 | *.egg 194 | *.deb 195 | *.rpm 196 | *.msi 197 | *.msm 198 | *.msp 199 | *.txz 200 | 201 | #################### Backup.gitignore #################### 202 | 203 | *.bak 204 | *.gho 205 | *.ori 206 | *.orig 207 | *.tmp 208 | 209 | #################### Emacs.gitignore #################### 210 | 211 | # -*- mode: gitignore; -*- 212 | *~ 213 | \#*\# 214 | /.emacs.desktop 215 | /.emacs.desktop.lock 216 | *.elc 217 | auto-save-list 218 | tramp 219 | .\#* 220 | 221 | # Org-mode 222 | .org-id-locations 223 | *_archive 224 | 225 | # flymake-mode 226 | *_flymake.* 227 | 228 | # eshell files 229 | /eshell/history 230 | /eshell/lastdir 231 | 232 | # elpa packages 233 | /elpa/ 234 | 235 | # reftex files 236 | *.rel 237 | 238 | # AUCTeX auto folder 239 | /auto/ 240 | 241 | # cask packages 242 | .cask/ 243 | dist/ 244 | 245 | # Flycheck 246 | flycheck_*.el 247 | 248 | # server auth directory 249 | /server/ 250 | 251 | # projectiles files 252 | .projectile 253 | 254 | # directory configuration 255 | .dir-locals.el 256 | 257 | # network security 258 | /network-security.data 259 | 260 | 261 | #################### JetBrains.gitignore #################### 262 | 263 | # Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio, WebStorm and Rider 264 | # Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839 265 | 266 | # User-specific stuff 267 | .idea/**/workspace.xml 268 | .idea/**/tasks.xml 269 | .idea/**/usage.statistics.xml 270 | .idea/**/dictionaries 271 | .idea/**/shelf 272 | 273 | # AWS User-specific 274 | .idea/**/aws.xml 275 | 276 | # Generated files 277 | .idea/**/contentModel.xml 278 | 279 | # Sensitive or high-churn files 280 | .idea/**/dataSources/ 281 | .idea/**/dataSources.ids 282 | .idea/**/dataSources.local.xml 283 | .idea/**/sqlDataSources.xml 284 | .idea/**/dynamic.xml 285 | .idea/**/uiDesigner.xml 286 | .idea/**/dbnavigator.xml 287 | 288 | # Gradle 289 | .idea/**/gradle.xml 290 | .idea/**/libraries 291 | 292 | # Gradle and Maven with auto-import 293 | # When using Gradle or Maven with auto-import, you should exclude module files, 294 | # since they will be recreated, and may cause churn. Uncomment if using 295 | # auto-import. 296 | # .idea/artifacts 297 | # .idea/compiler.xml 298 | # .idea/jarRepositories.xml 299 | # .idea/modules.xml 300 | # .idea/*.iml 301 | # .idea/modules 302 | # *.iml 303 | # *.ipr 304 | 305 | # CMake 306 | cmake-build-*/ 307 | 308 | # Mongo Explorer plugin 309 | .idea/**/mongoSettings.xml 310 | 311 | # File-based project format 312 | *.iws 313 | 314 | # IntelliJ 315 | out/ 316 | 317 | # mpeltonen/sbt-idea plugin 318 | .idea_modules/ 319 | 320 | # JIRA plugin 321 | atlassian-ide-plugin.xml 322 | 323 | # Cursive Clojure plugin 324 | .idea/replstate.xml 325 | 326 | # SonarLint plugin 327 | .idea/sonarlint/ 328 | 329 | # Crashlytics plugin (for Android Studio and IntelliJ) 330 | com_crashlytics_export_strings.xml 331 | crashlytics.properties 332 | crashlytics-build.properties 333 | fabric.properties 334 | 335 | # Editor-based Rest Client 336 | .idea/httpRequests 337 | 338 | # Android studio 3.1+ serialized cache file 339 | .idea/caches/build_file_checksums.ser 340 | 341 | #################### Linux.gitignore #################### 342 | 343 | *~ 344 | 345 | # temporary files which can be created if a process still has a handle open of a deleted file 346 | .fuse_hidden* 347 | 348 | # KDE directory preferences 349 | .directory 350 | 351 | # Linux trash folder which might appear on any partition or disk 352 | .Trash-* 353 | 354 | # .nfs files are created when an open file is removed but is still being accessed 355 | .nfs* 356 | 357 | #################### NotepadPP.gitignore #################### 358 | 359 | # Notepad++ backups # 360 | *.bak 361 | 362 | #################### PuTTY.gitignore #################### 363 | 364 | # Private key 365 | *.ppk 366 | 367 | #################### SublimeText.gitignore #################### 368 | 369 | # Cache files for Sublime Text 370 | *.tmlanguage.cache 371 | *.tmPreferences.cache 372 | *.stTheme.cache 373 | 374 | # Workspace files are user-specific 375 | *.sublime-workspace 376 | 377 | # Project files should be checked into the repository, unless a significant 378 | # proportion of contributors will probably not be using Sublime Text 379 | # *.sublime-project 380 | 381 | # SFTP configuration file 382 | sftp-config.json 383 | sftp-config-alt*.json 384 | 385 | # Package control specific files 386 | Package Control.last-run 387 | Package Control.ca-list 388 | Package Control.ca-bundle 389 | Package Control.system-ca-bundle 390 | Package Control.cache/ 391 | Package Control.ca-certs/ 392 | Package Control.merged-ca-bundle 393 | Package Control.user-ca-bundle 394 | oscrypto-ca-bundle.crt 395 | bh_unicode_properties.cache 396 | 397 | # Sublime-github package stores a github token in this file 398 | # https://packagecontrol.io/packages/sublime-github 399 | GitHub.sublime-settings 400 | 401 | #################### Vim.gitignore #################### 402 | 403 | # Swap 404 | [._]*.s[a-v][a-z] 405 | !*.svg # comment out if you don't need vector files 406 | [._]*.sw[a-p] 407 | [._]s[a-rt-v][a-z] 408 | [._]ss[a-gi-z] 409 | [._]sw[a-p] 410 | 411 | # Session 412 | Session.vim 413 | Sessionx.vim 414 | 415 | # Temporary 416 | .netrwhist 417 | *~ 418 | # Auto-generated tag files 419 | tags 420 | # Persistent undo 421 | [._]*.un~ 422 | 423 | #################### VirtualEnv.gitignore #################### 424 | 425 | # Virtualenv 426 | # http://iamzed.com/2009/05/07/a-primer-on-virtualenv/ 427 | .Python 428 | [Bb]in 429 | [Ii]nclude 430 | [Ll]ib 431 | [Ll]ib64 432 | [Ll]ocal 433 | [Ss]cripts 434 | pyvenv.cfg 435 | .venv 436 | pip-selfcheck.json 437 | 438 | #################### VisualStudioCode.gitignore #################### 439 | 440 | .vscode/* 441 | !.vscode/settings.json 442 | !.vscode/tasks.json 443 | !.vscode/launch.json 444 | !.vscode/extensions.json 445 | !.vscode/*.code-snippets 446 | 447 | # Local History for Visual Studio Code 448 | .history/ 449 | 450 | # Built Visual Studio Code Extensions 451 | *.vsix 452 | 453 | #################### Windows.gitignore #################### 454 | 455 | # Windows thumbnail cache files 456 | Thumbs.db 457 | Thumbs.db:encryptable 458 | ehthumbs.db 459 | ehthumbs_vista.db 460 | 461 | # Dump file 462 | *.stackdump 463 | 464 | # Folder config file 465 | [Dd]esktop.ini 466 | 467 | # Recycle Bin used on file shares 468 | $RECYCLE.BIN/ 469 | 470 | # Windows Installer files 471 | *.cab 472 | *.msi 473 | *.msix 474 | *.msm 475 | *.msp 476 | 477 | # Windows shortcuts 478 | *.lnk 479 | 480 | #################### macOS.gitignore #################### 481 | 482 | # General 483 | .DS_Store 484 | .AppleDouble 485 | .LSOverride 486 | 487 | # Icon must end with two \r 488 | Icon 489 | 490 | # Thumbnails 491 | ._* 492 | 493 | # Files that might appear in the root of a volume 494 | .DocumentRevisions-V100 495 | .fseventsd 496 | .Spotlight-V100 497 | .TemporaryItems 498 | .Trashes 499 | .VolumeIcon.icns 500 | .com.apple.timemachine.donotpresent 501 | 502 | # Directories potentially created on remote AFP share 503 | .AppleDB 504 | .AppleDesktop 505 | Network Trash Folder 506 | Temporary Items 507 | .apdisk 508 | 509 | #################### Custom.gitignore #################### 510 | 511 | # add your custom gitignore here: 512 | !.gitignore 513 | !.gitsubmodules 514 | -------------------------------------------------------------------------------- /CHANGES.txt: -------------------------------------------------------------------------------- 1 | Version 1.0.0 released 2013-06-24 2 | 3 | * Initial release. 4 | 5 | Version 1.1.0 released 2014-02-13 6 | 7 | * Add py3 support; 8 | * Add x_ratelimit_reset; 9 | * Fix JsonObject class. 10 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /README: -------------------------------------------------------------------------------- 1 | Github v3 API Python SDK 2 | 3 | This software is a 100% pure Python interface to Github v3 API which provides OAuth2.0 authentication and API calling wrapper. 4 | 5 | You can find docs and source code at: 6 | 7 | http://michaelliao.github.io/githubpy/ 8 | 9 | Developed and mantained by Michael Liao. Please feel free to report bugs and your suggestions at: 10 | 11 | https://github.com/michaelliao/githubpy/ 12 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | githubpy 2 | ======== 3 | 4 | ### Welcome 5 | 6 | githubpy is a simple Python3 client for GitHub's REST API. It's all contained in one easy-to-use file. 7 | 8 | Sample code: 9 | 10 | ``` 11 | >>> from github import GitHub 12 | >>> gh = GitHub(token='your-github-token') 13 | >>> gh.users('michaelliao').get() 14 | {'id': 470058, 'name': 'Michael Liao', ... } 15 | ``` 16 | 17 | Requirement: 18 | 19 | Python 3.x 20 | 21 | Python 2 is not supported. 22 | 23 | ### Call APIs 24 | 25 | All APIs are dynamic calls. You can construct an API call by GitHub's [REST API](https://docs.github.com/en/rest). 26 | 27 | For example, according to GitHub API doc of how to [get a user](https://docs.github.com/en/rest/users/users#get-a-user): 28 | 29 | ``` 30 | GET /users/{username} 31 | ``` 32 | 33 | Note the `{username}` variable. You can make a call in Python like this: 34 | 35 | ``` 36 | >>> gh.users('michaelliao').get() 37 | {'id': 470058, 'name': 'Michael Liao', ... } 38 | ``` 39 | 40 | This returns a dict, but it can also be treated like an object: 41 | 42 | ``` 43 | >>> u['name'] 44 | 'Michael Liao' 45 | >>> u.name 46 | 'Michael Liao' 47 | ``` 48 | 49 | Another example of how to [list repository issues](https://docs.github.com/en/rest/issues/issues#list-repository-issues): 50 | 51 | ``` 52 | GET /repos/{owner}/{repo}/issues 53 | Query parameters: 54 | state: open, closed, all 55 | assignee: username or * 56 | sort: created, updated, comments 57 | direction: asc, desc 58 | page: 1, 2, 3, ... 59 | per_page: 30 60 | ... 61 | ``` 62 | 63 | Python keywords can filter for `open` issues assigned to `michaelliao`: 64 | 65 | ``` 66 | >>> gh.repos('michaelliao')('githubpy').issues \ 67 | .get(state='open', assignee='michaelliao') 68 | ``` 69 | 70 | ### Using POST, PUT, PATCH, and DELETE 71 | 72 | [Create an issue](https://docs.github.com/en/rest/issues/issues#create-an-issue): 73 | 74 | ``` 75 | POST /repos/{owner}/{repo}/issues 76 | Body json: 77 | { 78 | "title": "Found a bug", 79 | "body": "Having a problem with this.", 80 | "assignees": ["michaelliao"] 81 | } 82 | ``` 83 | 84 | Python code to create an issue: 85 | 86 | ``` 87 | >>> issue = dict(title='Found a bug', body='Having a problem with this.', assignees=["michaelliao"]) 88 | >>> gh.repos('michaelliao')('githubpy').issues \ 89 | .post(issue) 90 | ``` 91 | 92 | Remember, all APIs are dynamic calls, so you won't need update this SDK if GitHub add new APIs! 93 | 94 | ### Authentication 95 | 96 | Anonymous API call: 97 | 98 | ``` 99 | >>> gh = GitHub() 100 | ``` 101 | 102 | Authentication with GitHub token: 103 | 104 | ``` 105 | >>> gh = GitHub(token='ghp_...') 106 | ``` 107 | 108 | Personal token can be generated from `Settings` - `Developer settings` - `Personal access tokens`. 109 | 110 | OAuth authentication is a bit complicated: 111 | 112 | **Step 1:** Redirect user to the generated URL: 113 | 114 | ``` 115 | >>> gh = GitHub(client_id='1234', client_secret='secret') 116 | >>> print gh.authorize_url(state='a-random-string') 117 | 'https://github.com/login/oauth/authorize?client_id=1234' 118 | ``` 119 | 120 | **Step 2:** GitHub redirects back to your site with the parameters `code` and `state` (optional). Then get an access token: 121 | 122 | ``` 123 | >>> code = request.input('code') 124 | >>> state = request.input('state') 125 | >>> t = gh.get_access_token(code, state) 126 | >>> print(t.token_type, t.scope, t.access_token) 127 | 'bearer', 'repo, user', 'abc1234567xyz' 128 | ``` 129 | 130 | **Step 3:** Using access token as authentication to call APIs: 131 | 132 | ``` 133 | >>> gh = GitHub(token='abc1234567xyz') 134 | ``` 135 | 136 | 137 | ### Errors 138 | 139 | An `ApiError` is raised if something wrong. 140 | There are sub-classes of `ApiError`: 141 | 142 | - `ApiAuthError`: OAuth failed. 143 | - `ApiForbiddenError`: 403 response. 144 | - `ApiNotFoundError`: 404 response. 145 | - `ApiConflictError`: 409 response. 146 | 147 | ``` 148 | try: 149 | gh.user.emails.delete('email@example.com') 150 | except ApiNotFoundError as e: 151 | print(e.code, e.url, str(e)) 152 | ``` 153 | 154 | NOTE: You may get `ApiNotFoundError` (404 Not Found) even if the URL is correct, but authentication fails. According to GitHub's API docs: 155 | 156 | > Requests that require authentication will return 404, instead of 403, 157 | > in some places. This is to prevent the accidental leakage of private 158 | > repositories to unauthorized users. 159 | 160 | 161 | ### Rate Limiting 162 | 163 | You can check rate limits after any API call: 164 | 165 | ``` 166 | >>> u = gh.users('michaelliao').get() 167 | >>> gh.x_ratelimit_limit 168 | 5000 169 | >>> gh.x_ratelimit_remaining 170 | 4999 171 | ``` 172 | 173 | 174 | ### Licensing 175 | 176 | githubpy is distributed under [GPLv3](LICENSE). 177 | 178 | 179 | ### Sample 180 | 181 | - Get user and repo info: [sample_basic.py](sample_basic.py) 182 | - Get, upload, update and delete content: [sample_content.py](sample_content.py) 183 | - Get, create and update issues: [sample_issue.py](sample_issue.py) 184 | 185 | ### Enjoy! 186 | -------------------------------------------------------------------------------- /github.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | # -*-coding: utf8 -*- 3 | 4 | ''' 5 | GitHub API Python3 SDK. 6 | 7 | GPLv3 License 8 | 9 | Michael Liao (askxuefeng@gmail.com) 10 | 11 | https://github.com/michaelliao/githubpy 12 | 13 | Usage: 14 | 15 | >>> token = os.getenv('GITHUB_TOKEN') # token from env or other source 16 | >>> proxy = os.getenv('HTTPS_PROXY') # proxy for access https, default to None 17 | >>> gh = GitHub(token, proxy=proxy) 18 | >>> L = gh.users('michaelliao').followers.get() 19 | >>> L[0].login # doctest: +ELLIPSIS 20 | '...' 21 | >>> print('rate limit remaining: ', gh.x_ratelimit_remaining) # doctest: +ELLIPSIS 22 | rate limit remaining: ... 23 | >>> x_ratelimit_limit = gh.x_ratelimit_limit 24 | >>> x_ratelimit_reset = gh.x_ratelimit_reset 25 | >>> L = gh.users('michaelliao').following.get() 26 | >>> L[0].url # doctest: +ELLIPSIS 27 | 'https://api.github.com/users/...' 28 | >>> L = gh.repos('michaelliao')('githubpy').issues.get(state='closed', sort='created', direction='asc') 29 | >>> L[0].title 30 | 'No license' 31 | >>> L[0].number 32 | 1 33 | >>> I = gh.repos('michaelliao')('githubpy').issues(1).get() 34 | >>> I.url 35 | 'https://api.github.com/repos/michaelliao/githubpy/issues/1' 36 | >>> new_issue = { 'title': 'New issue test', 'body': 'Test create issue with githubpy', 'assignees': ['michaelliao']} 37 | >>> r = gh.repos('michaelliao')('githubpy').issues.post(new_issue) 38 | >>> r.title 39 | 'New issue test' 40 | >>> r.state 41 | 'open' 42 | >>> exist = gh.repos('michaelliao')('githubpy').contents('test/café.txt').get() # doctest: +ELLIPSIS 43 | {...} 44 | >>> # update exist file: 45 | >>> import base64, datetime 46 | >>> dt = datetime.datetime.now().strftime('%Y-%m-%d %H:%M:%S') 47 | >>> file_content = bytes('Hello world! ' + dt, 'utf-8') 48 | >>> update = { 'message': 'Update file at ' + dt, 'committer': { 'name': 'Michael', 'email': 'askxuefeng@gmail.com' }, 'content': base64.b64encode(file_content).decode('utf-8'), 'sha': exist.sha } 49 | >>> commit = gh.repos('michaelliao')('githubpy').contents('test/café.txt').put(update) 50 | >>> commit.content.url 51 | 'https://api.github.com/repos/michaelliao/githubpy/contents/test/caf%C3%A9.txt?ref=master' 52 | >>> gh.repos.thisisabadurl.get() 53 | Traceback (most recent call last): 54 | ... 55 | ApiNotFoundError: https://api.github.com/repos/thisisabadurl 56 | >>> gh.users('github-not-exist-user').followers.get() 57 | Traceback (most recent call last): 58 | ... 59 | ApiNotFoundError: https://api.github.com/users/github-not-exist-user/followers 60 | ''' 61 | 62 | __version__ = '2.0.0' 63 | 64 | from urllib.request import build_opener, HTTPSHandler, HTTPError, Request 65 | from urllib.parse import quote 66 | from io import StringIO 67 | 68 | import re, os, time, hmac, base64, hashlib, urllib, mimetypes, json 69 | from collections import namedtuple 70 | from collections.abc import Iterable 71 | from datetime import datetime, timedelta, tzinfo 72 | 73 | TIMEOUT = 60 74 | 75 | _API_VERSION = '2022-11-28' 76 | 77 | _URL = 'https://api.github.com' 78 | 79 | _METHOD_MAP = dict( 80 | GET=lambda: 'GET', 81 | PUT=lambda: 'PUT', 82 | POST=lambda: 'POST', 83 | PATCH=lambda: 'PATCH', 84 | DELETE=lambda: 'DELETE') 85 | 86 | DEFAULT_SCOPE = None 87 | 88 | RW_SCOPE = 'user,public_repo,repo,repo:status,gist' 89 | 90 | AccessToken = namedtuple('AccessToken', ['access_token', 'scope', 'token_type']) 91 | 92 | 93 | def _encode_path(path): 94 | ''' 95 | Encode url path. 96 | ''' 97 | return quote(path, encoding='utf-8') 98 | 99 | def _encode_params(kw): 100 | ''' 101 | Encode parameters. 102 | 103 | >>> kw = { 'a': 'K&R', 'lang': 'Ελληνικά,Français,中文,日本語', 'page': 1 } 104 | >>> _encode_params(kw) 105 | 'a=K%26R&lang=%CE%95%CE%BB%CE%BB%CE%B7%CE%BD%CE%B9%CE%BA%CE%AC%2CFran%C3%A7ais%2C%E4%B8%AD%E6%96%87%2C%E6%97%A5%E6%9C%AC%E8%AA%9E&page=1' 106 | ''' 107 | args = [] 108 | for k, v in kw.items(): 109 | q = quote(str(v), encoding='utf-8') 110 | args.append(f'{k}={q}') 111 | return '&'.join(args) 112 | 113 | def _encode_json(obj): 114 | ''' 115 | Encode object as json str. 116 | ''' 117 | def _dump_obj(obj): 118 | if isinstance(obj, dict): 119 | return obj 120 | d = dict() 121 | for k in dir(obj): 122 | if not k.startswith('_'): 123 | d[k] = getattr(obj, k) 124 | return d 125 | return json.dumps(obj) 126 | 127 | def _parse_json(jsonstr): 128 | def _obj_hook(pairs): 129 | o = JsonObject() 130 | for k, v in pairs.items(): 131 | o[str(k)] = v 132 | return o 133 | return json.loads(jsonstr, object_hook=_obj_hook) 134 | 135 | class _Get(object): 136 | 137 | def __init__(self, _gh, _path): 138 | self._gh = _gh 139 | self._path = _path 140 | 141 | def __call__(self, **kw): 142 | return self._gh._http('GET', self._path, None, **kw) 143 | 144 | def __str__(self): 145 | return f'GET {self._path}' 146 | 147 | __repr__ = __str__ 148 | 149 | class _Executable(object): 150 | 151 | def __init__(self, _gh, _method, _path): 152 | self._gh = _gh 153 | self._method = _method 154 | self._path = _path 155 | 156 | def __call__(self, data=None): 157 | return self._gh._http(self._method, self._path, data) 158 | 159 | def __str__(self): 160 | return '_Executable (%s %s)' % (self._method, self._path) 161 | 162 | __repr__ = __str__ 163 | 164 | class _Callable(object): 165 | 166 | def __init__(self, _gh, _name): 167 | self._gh = _gh 168 | self._name = _name 169 | 170 | def __call__(self, *args): 171 | n = len(args) 172 | if n == 0: 173 | return self 174 | if n == 1: 175 | return _Callable(self._gh, self._name + '/' + _encode_path(str(args[0]))) 176 | return _Callable(self._gh, self._name + '/' + '/'.join([_encode_path(str(arg)) for arg in args])) 177 | 178 | def __getattr__(self, attr): 179 | if attr == 'get': 180 | return _Get(self._gh, self._name) 181 | if attr == 'put': 182 | return _Executable(self._gh, 'PUT', self._name) 183 | if attr == 'post': 184 | return _Executable(self._gh, 'POST', self._name) 185 | if attr == 'patch': 186 | return _Executable(self._gh, 'PATCH', self._name) 187 | if attr == 'delete': 188 | return _Executable(self._gh, 'DELETE', self._name) 189 | return _Callable(self._gh, f'{self._name}/{attr}') 190 | 191 | def __str__(self): 192 | return '_Callable (%s)' % self._name 193 | 194 | __repr__ = __str__ 195 | 196 | class GitHub(object): 197 | 198 | ''' 199 | GitHub client. 200 | ''' 201 | 202 | def __init__(self, token=None, proxy=None, debug=False): 203 | self.x_ratelimit_remaining = -1 204 | self.x_ratelimit_limit = -1 205 | self.x_ratelimit_reset = -1 206 | self._authorization = f'Bearer {token}' if token else None 207 | self._debug = debug 208 | 209 | @classmethod 210 | def authorize_url(cls, client_id, redirect_uri, scope=None, state=None, **kw): 211 | ''' 212 | Generate authorize_url. 213 | 214 | scope: A space-delimited list of scopes. Default to None (no scope, read-only access to public information). See https://docs.github.com/en/developers/apps/building-oauth-apps/scopes-for-oauth-apps 215 | state: An unguessable random string. It is used to protect against cross-site request forgery attacks. Default to None (do not use state). 216 | 217 | >>> GitHub.authorize_url(client_id='3ebf94c5776d565bcf75', redirect_uri='https://example.com/callback', scope='public_repo, user', allow_signup='false') 218 | 'https://github.com/login/oauth/authorize?allow_signup=false&client_id=3ebf94c5776d565bcf75&redirect_uri=https%3A//example.com/callback&scope=public_repo%2C%20user' 219 | ''' 220 | if not client_id: 221 | raise ValueError('Bad argument of client_id.') 222 | if not redirect_uri: 223 | raise ValueError('Bad argument of redirect_uri.') 224 | kw['client_id'] = client_id 225 | kw['redirect_uri'] = redirect_uri 226 | if scope: 227 | kw['scope'] = scope 228 | if state: 229 | kw['state'] = state 230 | params = _encode_params(kw) 231 | return f'https://github.com/login/oauth/authorize?{params}' 232 | 233 | @classmethod 234 | def get_access_token(cls, client_id, client_secret, code, redirect_uri=None, state=None): 235 | ''' 236 | In callback url: http://host/callback?code=123&state=xyz 237 | 238 | use code and state to get an access token. 239 | ''' 240 | kw = dict(client_id=client_id, client_secret=client_secret, code=code) 241 | if redirect_uri: 242 | kw['redirect_uri'] = redirect_uri 243 | if state: 244 | kw['state'] = state 245 | url = 'https://github.com/login/oauth/access_token' 246 | opener = build_opener(HTTPSHandler) 247 | request = Request(url, data=_encode_params(kw)) 248 | request.get_method = _METHOD_MAP['POST'] 249 | request.add_header('Accept', 'application/json') 250 | try: 251 | response = opener.open(request, timeout=TIMEOUT) 252 | r = _parse_json(response.read()) 253 | if 'error' in r: 254 | raise ApiAuthError(400, url, r.error) 255 | return AccessToken(r.access_token, r.scope, r.token_type) 256 | except HTTPError as e: 257 | raise ApiAuthError(e.code, url, 'HTTPError when get access token') 258 | 259 | def __getattr__(self, attr): 260 | path = _encode_path(attr) 261 | return _Callable(self, f'/{path}') 262 | 263 | def _http(self, _method, _path, _data=None, **kw): 264 | data = None 265 | params = None 266 | if _method=='GET' and kw: 267 | _path = '%s?%s' % (_path, _encode_params(kw)) 268 | if _method in ['POST', 'PATCH', 'PUT', 'DELETE']: 269 | data = bytes(_encode_json(_data), 'utf-8') 270 | url = f'{_URL}{_path}' 271 | headers = { 272 | 'Accept': 'application/vnd.github+json', 273 | 'X-GitHub-Api-Version': _API_VERSION 274 | } 275 | if self._authorization: 276 | headers['Authorization'] = self._authorization 277 | if _method in ['POST', 'PATCH', 'PUT']: 278 | headers['Content-Type'] = 'application/json' 279 | opener = build_opener(HTTPSHandler) 280 | request = Request(url, data=data) 281 | request.get_method = _METHOD_MAP[_method] 282 | for k, v in headers.items(): 283 | request.add_header(k, v) 284 | if self._debug: 285 | curl = ['curl -v', f' -X {_method}'] 286 | for k, v in headers.items(): 287 | curl.append(f' -H "{k}: {v}"') 288 | curl.append(f' "{url}"') 289 | if data: 290 | curl.append(f' -d \'{_encode_json(_data)}\'') 291 | print(' \\\n'.join(curl)) 292 | try: 293 | response = opener.open(request, timeout=TIMEOUT) 294 | is_json = self._process_resp(response.headers) 295 | if is_json: 296 | return _parse_json(response.read().decode('utf-8')) 297 | except HTTPError as e: 298 | is_json = self._process_resp(e.headers) 299 | if is_json: 300 | json = _parse_json(e.read().decode('utf-8')) 301 | else: 302 | json = e.read().decode('utf-8') 303 | if e.code == 404: 304 | raise ApiNotFoundError(url) 305 | if e.code == 403: 306 | raise ApiForbiddenError(url) 307 | if e.code == 409: 308 | raise ApiConflictError(url) 309 | raise ApiError(e.code, url) 310 | 311 | def _process_resp(self, headers): 312 | is_json = False 313 | if headers: 314 | for h in headers: 315 | hl = h.lower() 316 | if hl == 'x-ratelimit-remaining': 317 | self.x_ratelimit_remaining = int(headers[h]) 318 | elif hl == 'x-ratelimit-limit': 319 | self.x_ratelimit_limit = int(headers[h]) 320 | elif hl == 'x-ratelimit-reset': 321 | self.x_ratelimit_reset = int(headers[h]) 322 | elif hl == 'content-type': 323 | is_json = headers[h].startswith('application/json') 324 | return is_json 325 | 326 | 327 | class JsonObject(dict): 328 | ''' 329 | general json object that can bind any fields but also act as a dict. 330 | ''' 331 | def __getattr__(self, key): 332 | try: 333 | return self[key] 334 | except KeyError: 335 | raise AttributeError(f'\'Dict\' object has no attribute \'{key}\'') 336 | 337 | def __setattr__(self, attr, value): 338 | self[attr] = value 339 | 340 | 341 | class ApiError(Exception): 342 | 343 | def __init__(self, code, url, message=None): 344 | super(ApiError, self).__init__(message if message else f'{code}: {url}') 345 | self.code = code 346 | self.url = url 347 | 348 | 349 | class ApiAuthError(ApiError): 350 | 351 | def __init__(self, code, url, message=None): 352 | super(ApiAuthError, self).__init__(code, url, message) 353 | 354 | 355 | class ApiForbiddenError(ApiError): 356 | ' 403 Error ' 357 | 358 | def __init__(self, url): 359 | super(ApiForbiddenError, self).__init__(403, url) 360 | 361 | 362 | class ApiNotFoundError(ApiError): 363 | ' 404 Error ' 364 | 365 | def __init__(self, url): 366 | super(ApiNotFoundError, self).__init__(404, url) 367 | 368 | 369 | class ApiConflictError(ApiError): 370 | ' 409 Error ' 371 | 372 | def __init__(self, url): 373 | super(ApiConflictError, self).__init__(409, url) 374 | 375 | 376 | if __name__ == '__main__': 377 | import doctest 378 | doctest.testmod() 379 | -------------------------------------------------------------------------------- /sample_basic.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | # -*-coding: utf8 -*- 3 | 4 | ''' 5 | Get user, repo info. 6 | 7 | Export token first before run this script: 8 | 9 | $ export GITHUB_TOKEN=ghp_xxx 10 | ''' 11 | 12 | import os, json, time, datetime 13 | from github import GitHub, ApiNotFoundError 14 | 15 | def main(): 16 | # read token from env: 17 | token = os.getenv('GITHUB_TOKEN') 18 | if not token: 19 | print('could not read token from env.') 20 | exit(1) 21 | gh = GitHub(token, debug=True) 22 | user = 'michaelliao' 23 | repo = 'githubpy-test' 24 | 25 | # get a user: https://docs.github.com/rest/users/users#get-a-user 26 | u = gh.users(user).get() 27 | print_json('user:', u) 28 | 29 | sleep() 30 | 31 | # get repositories for a user: https://docs.github.com/rest/repos/repos#list-repositories-for-a-user 32 | repos = gh.users(user).repos.get(sort='updated', page=1, per_page=6) 33 | print_json('repos:', repos) 34 | 35 | for rp in repos: 36 | sleep() 37 | # list repository contributors: https://docs.github.com/rest/repos/repos#list-repository-contributors 38 | cs = gh.repos(user)(rp.name).contributors.get() 39 | print_json(f'contributors of repo {rp.name}', cs) 40 | 41 | if rp.name == repo: 42 | # update a repository: https://docs.github.com/rest/repos/repos#update-a-repository 43 | updated = gh.repos(user)(rp.name).patch( 44 | { 45 | 'description': 'Test repo for githubpy, updated at ' + now() 46 | } 47 | ) 48 | print_json('updated repo:', updated) 49 | 50 | # update a repository without permission: https://docs.github.com/rest/repos/repos#update-a-repository 51 | try: 52 | gh.repos('torvalds')('linux').patch( 53 | { 54 | 'description': 'Update Linux kernel source tree' 55 | } 56 | ) 57 | except ApiNotFoundError as e: 58 | print(e.code, e.url) 59 | 60 | 61 | def print_json(msg, obj): 62 | print(f'{msg}') 63 | print('----------------------------------------') 64 | print(json.dumps(obj, indent=2)) 65 | print('----------------------------------------') 66 | 67 | 68 | def sleep(): 69 | time.sleep(1.5) 70 | 71 | 72 | def now(): 73 | return datetime.datetime.now().strftime('%Y-%m-%d %H:%M') 74 | 75 | 76 | if __name__ == '__main__': 77 | main() 78 | -------------------------------------------------------------------------------- /sample_content.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | # -*-coding: utf8 -*- 3 | 4 | ''' 5 | Get, upload, update and delete content of repo. 6 | 7 | Export token first before run this script: 8 | 9 | $ export GITHUB_TOKEN=ghp_xxx 10 | ''' 11 | 12 | import os, json, time, base64, datetime 13 | from github import GitHub, ApiConflictError, ApiNotFoundError 14 | 15 | def main(): 16 | # read token from env: 17 | token = os.getenv('GITHUB_TOKEN') 18 | if not token: 19 | print('could not read token from env.') 20 | exit(1) 21 | gh = GitHub(token, debug=True) 22 | user = 'michaelliao' 23 | repo = 'githubpy-test' 24 | path = 'test/café.txt' 25 | 26 | try: 27 | # get exist file: 28 | exist = gh.repos(user)(repo).contents(path).get() 29 | print_json(f'exist file: {path}', exist) 30 | except ApiNotFoundError as e: 31 | # file not exist, upload new file: https://docs.github.com/rest/repos/contents#create-or-update-file-contents 32 | exist = gh.repos(user)(repo).contents(path).put( 33 | { 34 | 'message': 'upload new file', 35 | 'committer': committer(), 36 | 'content': file_content() 37 | } 38 | ) 39 | print_json(f'created file: {path}', exist) 40 | 41 | sleep() 42 | try: 43 | # update exist file with conflict, because sha is invalid: https://docs.github.com/rest/repos/contents#create-or-update-file-contents 44 | gh.repos(user)(repo).contents(path).put( 45 | { 46 | 'message': 'update file', 47 | 'committer': committer(), 48 | 'content': file_content(), 49 | 'sha': '1000000000200000000030000000004000000000' # invalid sha 50 | } 51 | ) 52 | except ApiConflictError as e: 53 | print(e.code, e.url, 'Conflict error.') 54 | 55 | sleep() 56 | # update exist file: https://docs.github.com/rest/repos/contents#create-or-update-file-contents 57 | updated = gh.repos(user)(repo).contents(path).put( 58 | { 59 | 'message': 'update file', 60 | 'committer': committer(), 61 | 'content': file_content(), 62 | 'sha': get_sha(exist) 63 | } 64 | ) 65 | print_json(f'updated file: {path}', updated) 66 | 67 | sleep() 68 | # delete file: https://docs.github.com/rest/repos/contents#delete-a-file 69 | deleted = gh.repos(user)(repo).contents(path).delete( 70 | { 71 | 'message': 'delete exist file', 72 | 'committer': committer(), 73 | 'sha': get_sha(updated) 74 | } 75 | ) 76 | print_json(f'deleted file: {path}', deleted) 77 | 78 | # try upload without permission: https://docs.github.com/rest/repos/contents#create-or-update-file-contents 79 | try: 80 | gh.repos('torvalds')('linux').contents('test-upload-without-permission.txt').put( 81 | { 82 | 'message': 'upload new file', 83 | 'committer': committer(), 84 | 'content': file_content() 85 | } 86 | ) 87 | except ApiNotFoundError as e: 88 | print(e.code, e.url, 'No permission.') 89 | 90 | 91 | def print_json(msg, obj): 92 | print(f'{msg}') 93 | print('----------------------------------------') 94 | print(json.dumps(obj, indent=2)) 95 | print('----------------------------------------') 96 | 97 | 98 | def sleep(): 99 | time.sleep(1.5) 100 | 101 | 102 | def get_sha(obj): 103 | if hasattr(obj, 'sha'): 104 | return obj.sha 105 | if hasattr(obj, 'content'): 106 | return obj.content.sha 107 | raise ValueError('object has no attribute of \'sha\'') 108 | 109 | 110 | def file_content(): 111 | dt = datetime.datetime.now().strftime('%Y-%m-%d %H:%M:%S') 112 | content = bytes('Hello world!\nUpdated at ' + dt, 'utf-8') 113 | b64 = base64.b64encode(content) 114 | return b64.decode('utf-8') 115 | 116 | 117 | def committer(): 118 | return { 119 | 'name': 'Michael', 120 | 'email': 'askxuefeng@gmail.com' 121 | } 122 | 123 | 124 | if __name__ == '__main__': 125 | main() 126 | -------------------------------------------------------------------------------- /sample_issue.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | # -*-coding: utf8 -*- 3 | 4 | ''' 5 | Get, create, update issues. 6 | 7 | Export token first before run this script: 8 | 9 | $ export GITHUB_TOKEN=ghp_xxx 10 | ''' 11 | 12 | import os, json, time, datetime 13 | from github import GitHub 14 | 15 | def main(): 16 | # read token from env: 17 | token = os.getenv('GITHUB_TOKEN') 18 | if not token: 19 | print('could not read token from env.') 20 | exit(1) 21 | gh = GitHub(token, debug=True) 22 | user = 'michaelliao' 23 | repo = 'githubpy-test' 24 | 25 | # get all issues: https://docs.github.com/rest/issues/issues#list-repository-issues 26 | all = gh.repos(user)(repo).issues.get(state='all', page=1, per_page=100) 27 | print_json('all issues:', all) 28 | 29 | sleep() 30 | 31 | # get open issues: https://docs.github.com/rest/issues/issues#list-repository-issues 32 | opens = gh.repos(user)(repo).issues.get(state='open', page=1, per_page=100) 33 | print_json('open issues:', opens) 34 | 35 | for oi in opens: 36 | sleep() 37 | 38 | if oi.comments < 1: 39 | # make a comment: https://docs.github.com/rest/issues/comments#create-an-issue-comment 40 | comment = gh.repos(user)(repo).issues(oi.number).comments.post( 41 | { 42 | 'body': 'Me too' 43 | } 44 | ) 45 | print_json('comment:', comment) 46 | else: 47 | # update an issue: https://docs.github.com/rest/issues/issues#update-an-issue 48 | closed = gh.repos(user)(repo).issues(oi.number).patch( 49 | { 50 | 'state': 'closed' 51 | } 52 | ) 53 | print_json('closed issue:', closed) 54 | 55 | sleep() 56 | # create an issue: https://docs.github.com/rest/issues/issues#create-an-issue 57 | issue = gh.repos(user)(repo).issues.post( 58 | { 59 | 'title': 'Found a bug at ' + now(), 60 | 'body': 'Having a problem with githubpy.', 61 | 'labels': ['bug', 'question'], 62 | 'assignees': ['michaelliao'] 63 | } 64 | ) 65 | print_json(f'created issue:', issue) 66 | 67 | 68 | def print_json(msg, obj): 69 | print(f'{msg}') 70 | print('----------------------------------------') 71 | print(json.dumps(obj, indent=2)) 72 | print('----------------------------------------') 73 | 74 | 75 | def sleep(): 76 | time.sleep(1.5) 77 | 78 | 79 | def now(): 80 | return datetime.datetime.now().strftime('%Y-%m-%d %H:%M') 81 | 82 | 83 | if __name__ == '__main__': 84 | main() 85 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | import setuptools 2 | 3 | import github 4 | 5 | setuptools.setup( 6 | name = 'githubpy', 7 | version = github.__version__, 8 | description = 'Github REST API Python3 SDK', 9 | long_description = 'githubpy is a simple Python3 client for GitHub REST API.', 10 | author = 'Michael Liao', 11 | author_email = 'askxuefeng@gmail.com', 12 | url = 'https://github.com/michaelliao/githubpy', 13 | download_url = 'https://github.com/michaelliao/githubpy', 14 | py_modules = ['github'], 15 | python_requires = '>=3.5', 16 | install_requires = [], 17 | classifiers = [ 18 | 'Development Status :: 5 - Production/Stable', 19 | 'Environment :: Web Environment', 20 | 'Intended Audience :: Developers', 21 | 'License :: OSI Approved :: Apache Software License', 22 | 'Operating System :: OS Independent', 23 | 'Programming Language :: Python :: 3', 24 | 'Topic :: Internet', 25 | 'Topic :: Software Development :: Libraries :: Python Modules', 26 | ] 27 | ) 28 | --------------------------------------------------------------------------------