├── .github └── workflows │ └── python-package.yml ├── .gitignore ├── LICENSE.txt ├── README.rst ├── docs ├── Makefile ├── api-config.rst ├── api.rst ├── auth.rst ├── conf.py ├── format.rst ├── index.rst ├── make.bat └── pgn.rst ├── lichess ├── __init__.py ├── api.py ├── auth.py ├── format.py └── pgn.py ├── requirements.txt ├── setup.py └── test.py /.github/workflows/python-package.yml: -------------------------------------------------------------------------------- 1 | # This workflow will install Python dependencies, run tests and lint with a variety of Python versions 2 | # For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions 3 | 4 | name: Python package 5 | 6 | on: 7 | push: 8 | branches: [ master ] 9 | pull_request: 10 | branches: [ master ] 11 | 12 | jobs: 13 | build: 14 | 15 | runs-on: ubuntu-latest 16 | strategy: 17 | matrix: 18 | python-version: [3.8] 19 | 20 | steps: 21 | - uses: actions/checkout@v2 22 | - name: Set up Python ${{ matrix.python-version }} 23 | uses: actions/setup-python@v2 24 | with: 25 | python-version: ${{ matrix.python-version }} 26 | - name: Install dependencies 27 | run: | 28 | python -m pip install --upgrade pip 29 | pip install flake8 python-chess 30 | if [ -f requirements.txt ]; then pip install -r requirements.txt; fi 31 | # - name: Lint with flake8 32 | # run: | 33 | # # stop the build if there are Python syntax errors or undefined names 34 | # flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics 35 | # # exit-zero treats all errors as warnings 36 | # flake8 . --count --exit-zero --ignore=E203,E501,W503 --max-complexity=10 --statistics 37 | # - name: Check formatting with black 38 | # run: | 39 | # black . --check 40 | - name: Test 41 | run: | 42 | python test.py 43 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Byte-compiled / optimized / DLL files 2 | __pycache__/ 3 | *.py[cod] 4 | *$py.class 5 | 6 | # C extensions 7 | *.so 8 | 9 | # Distribution / packaging 10 | .Python 11 | build/ 12 | develop-eggs/ 13 | dist/ 14 | downloads/ 15 | eggs/ 16 | .eggs/ 17 | lib/ 18 | lib64/ 19 | parts/ 20 | sdist/ 21 | var/ 22 | wheels/ 23 | *.egg-info/ 24 | .installed.cfg 25 | *.egg 26 | MANIFEST 27 | 28 | # PyInstaller 29 | # Usually these files are written by a python script from a template 30 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 31 | *.manifest 32 | *.spec 33 | 34 | # Installer logs 35 | pip-log.txt 36 | pip-delete-this-directory.txt 37 | 38 | # Unit test / coverage reports 39 | htmlcov/ 40 | .tox/ 41 | .coverage 42 | .coverage.* 43 | .cache 44 | nosetests.xml 45 | coverage.xml 46 | *.cover 47 | .hypothesis/ 48 | 49 | # Translations 50 | *.mo 51 | *.pot 52 | 53 | # Django stuff: 54 | *.log 55 | .static_storage/ 56 | .media/ 57 | local_settings.py 58 | 59 | # Flask stuff: 60 | instance/ 61 | .webassets-cache 62 | 63 | # Scrapy stuff: 64 | .scrapy 65 | 66 | # Sphinx documentation 67 | docs/_build/ 68 | 69 | # PyBuilder 70 | target/ 71 | 72 | # Jupyter Notebook 73 | .ipynb_checkpoints 74 | 75 | # pyenv 76 | .python-version 77 | 78 | # celery beat schedule file 79 | celerybeat-schedule 80 | 81 | # SageMath parsed files 82 | *.sage.py 83 | 84 | # Environments 85 | .env 86 | .venv 87 | env/ 88 | venv/ 89 | ENV/ 90 | env.bak/ 91 | venv.bak/ 92 | 93 | # Spyder project settings 94 | .spyderproject 95 | .spyproject 96 | 97 | # Rope project settings 98 | .ropeproject 99 | 100 | # mkdocs documentation 101 | /site 102 | 103 | # mypy 104 | .mypy_cache/ 105 | 106 | # IDE 107 | .idea 108 | -------------------------------------------------------------------------------- /LICENSE.txt: -------------------------------------------------------------------------------- 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.rst: -------------------------------------------------------------------------------- 1 | python-lichess: a client for the lichess.org API 2 | ================================================ 3 | This is a client library for the `lichess.org `_ `API `_. It is designed to be: 4 | 5 | * Easy to use 6 | 7 | * Customizable when you need it 8 | 9 | * Adaptable to API changes 10 | 11 | * Easy to `integrate `_ with `python-chess `_ 12 | 13 | Have a look at some short examples. For more, check out the `full documentation `_. 14 | 15 | Getting a user's rating: 16 | 17 | >>> import lichess.api 18 | >>> 19 | >>> user = lichess.api.user('thibault') 20 | >>> print(user['perfs']['blitz']['rating']) 21 | 1617 22 | 23 | Checking who's online and playing: 24 | 25 | >>> import lichess.api 26 | >>> 27 | >>> users = list(lichess.api.users_status(['thibault', 'cyanfish'])) 28 | >>> online = [u['id'] for u in users if u['online']] 29 | >>> playing = [u['id'] for u in users if u['playing']] 30 | >>> print(online, playing) 31 | ['thibault', 'cyanfish'] ['cyanfish'] 32 | 33 | Saving a PGN of a user's last 200 games: 34 | 35 | >>> import lichess.api 36 | >>> from lichess.format import SINGLE_PGN 37 | >>> 38 | >>> pgn = lichess.api.user_games('thibault', max=200, format=SINGLE_PGN) 39 | >>> with open('last200.pgn', 'w') as f: 40 | >>> f.write(pgn) 41 | 42 | Integrating with `python-chess `_: 43 | 44 | >>> import lichess.api 45 | >>> from lichess.format import PYCHESS 46 | >>> 47 | >>> game = lichess.api.game('Qa7FJNk2', format=PYCHESS) 48 | >>> print(game.end().board()) 49 | . . k . R b r . 50 | . p p r . N p . 51 | p . . . . . . p 52 | . . . . . . . . 53 | . . . p . . . . 54 | P . . P . . . P 55 | . P P . . P P . 56 | . . K R . . . . 57 | 58 | Installing 59 | ---------- 60 | 61 | :: 62 | 63 | pip install python-lichess 64 | -------------------------------------------------------------------------------- /docs/Makefile: -------------------------------------------------------------------------------- 1 | # Minimal makefile for Sphinx documentation 2 | # 3 | 4 | # You can set these variables from the command line. 5 | SPHINXOPTS = 6 | SPHINXBUILD = sphinx-build 7 | SPHINXPROJ = python-lichess 8 | SOURCEDIR = . 9 | BUILDDIR = _build 10 | 11 | # Put it first so that "make" without argument is like "make help". 12 | help: 13 | @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) 14 | 15 | .PHONY: help Makefile 16 | 17 | # Catch-all target: route all unknown targets to Sphinx using the new 18 | # "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). 19 | %: Makefile 20 | @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) -------------------------------------------------------------------------------- /docs/api-config.rst: -------------------------------------------------------------------------------- 1 | API Client Configuration 2 | ========================================== 3 | 4 | The :class:`~lichess.api.DefaultApiClient` is used to perform the actual HTTP requests. It also manages rate-limiting and retries. 5 | 6 | If you need more functionality, you can subclass it. To use a custom client, set :class:`~lichess.api.default_client` or use the :data:`client` parameter in each API method wrapper. 7 | 8 | .. automodule:: lichess.api 9 | :members: ApiError, ApiHttpError, DefaultApiClient, default_client 10 | -------------------------------------------------------------------------------- /docs/api.rst: -------------------------------------------------------------------------------- 1 | API Methods 2 | ========================================== 3 | 4 | The module :mod:`lichess.api` provides thin wrappers around the `lichess API `_. 5 | 6 | In addition to the API parameters, each function takes optional :mod:`format `, :mod:`auth `, and :doc:`client ` arguments. 7 | 8 | Endpoints that return collections (like :data:`~lichess.api.user_games`) stream the results by returning a generator. 9 | 10 | .. automodule:: lichess.api 11 | :members: user, users_by_team, users_by_ids, users_status, user_games, user_activity, games_by_team, game, games_by_ids, tournaments, tournament, tournament_standings, tv_channels 12 | -------------------------------------------------------------------------------- /docs/auth.rst: -------------------------------------------------------------------------------- 1 | Authentication 2 | ========================================== 3 | 4 | Authentication lets you download games at a faster rate and access private data. 5 | 6 | The simplest way to authenticate is to create an OAuth access token on `lichess.org `_, and use the :data:`auth` parameter like so: 7 | 8 | >>> import lichess.api 9 | >>> 10 | >>> games = lichess.api.user_games('cyanfish', max=100, auth='your-token-here') 11 | 12 | You can also authenticate using your username and password (but please, try and avoid this): 13 | 14 | >>> import lichess.api 15 | >>> 16 | >>> cookie = lichess.api.login('cyanfish', 'this-is-not-my-real-password') 17 | >>> games = lichess.api.user_games('cyanfish', max=100, auth=cookie) 18 | 19 | .. automodule:: lichess.auth 20 | :members: OAuthToken, Cookie, EMPTY 21 | -------------------------------------------------------------------------------- /docs/conf.py: -------------------------------------------------------------------------------- 1 | # -*- coding: utf-8 -*- 2 | # 3 | # Configuration file for the Sphinx documentation builder. 4 | # 5 | # This file does only contain a selection of the most common options. For a 6 | # full list see the documentation: 7 | # http://www.sphinx-doc.org/en/stable/config 8 | 9 | # -- Path setup -------------------------------------------------------------- 10 | 11 | # If extensions (or modules to document with autodoc) are in another directory, 12 | # add these directories to sys.path here. If the directory is relative to the 13 | # documentation root, use os.path.abspath to make it absolute, like shown here. 14 | # 15 | import os 16 | import sys 17 | sys.path.insert(0, os.path.abspath('..')) 18 | 19 | # -- Project information ----------------------------------------------------- 20 | 21 | project = 'python-lichess' 22 | copyright = 'Ben Olden-Cooligan 2018' 23 | author = 'Ben Olden-Cooligan' 24 | 25 | # The short X.Y version 26 | version = '' 27 | # The full version, including alpha/beta/rc tags 28 | release = '' 29 | 30 | 31 | # -- General configuration --------------------------------------------------- 32 | 33 | # If your documentation needs a minimal Sphinx version, state it here. 34 | # 35 | # needs_sphinx = '1.0' 36 | 37 | # Add any Sphinx extension module names here, as strings. They can be 38 | # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom 39 | # ones. 40 | extensions = [ 41 | 'sphinx.ext.autodoc' 42 | ] 43 | autodoc_member_order = 'bysource' 44 | 45 | # Add any paths that contain templates here, relative to this directory. 46 | templates_path = ['_templates'] 47 | 48 | # The suffix(es) of source filenames. 49 | # You can specify multiple suffix as a list of string: 50 | # 51 | # source_suffix = ['.rst', '.md'] 52 | source_suffix = '.rst' 53 | 54 | # The master toctree document. 55 | master_doc = 'index' 56 | 57 | # The language for content autogenerated by Sphinx. Refer to documentation 58 | # for a list of supported languages. 59 | # 60 | # This is also used if you do content translation via gettext catalogs. 61 | # Usually you set "language" from the command line for these cases. 62 | language = None 63 | 64 | # List of patterns, relative to source directory, that match files and 65 | # directories to ignore when looking for source files. 66 | # This pattern also affects html_static_path and html_extra_path . 67 | exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] 68 | 69 | # The name of the Pygments (syntax highlighting) style to use. 70 | pygments_style = 'sphinx' 71 | 72 | 73 | # -- Options for HTML output ------------------------------------------------- 74 | 75 | # The theme to use for HTML and HTML Help pages. See the documentation for 76 | # a list of builtin themes. 77 | # 78 | import sphinx_rtd_theme 79 | html_theme = "sphinx_rtd_theme" 80 | html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] 81 | 82 | # Theme options are theme-specific and customize the look and feel of a theme 83 | # further. For a list of options available for each theme, see the 84 | # documentation. 85 | # 86 | # html_theme_options = {} 87 | 88 | # Add any paths that contain custom static files (such as style sheets) here, 89 | # relative to this directory. They are copied after the builtin static files, 90 | # so a file named "default.css" will overwrite the builtin "default.css". 91 | html_static_path = ['_static'] 92 | 93 | # Custom sidebar templates, must be a dictionary that maps document names 94 | # to template names. 95 | # 96 | # The default sidebars (for documents that don't match any pattern) are 97 | # defined by theme itself. Builtin themes are using these templates by 98 | # default: ``['localtoc.html', 'relations.html', 'sourcelink.html', 99 | # 'searchbox.html']``. 100 | # 101 | # html_sidebars = {} 102 | 103 | 104 | # -- Options for HTMLHelp output --------------------------------------------- 105 | 106 | # Output file base name for HTML help builder. 107 | htmlhelp_basename = 'python-lichessdoc' 108 | 109 | 110 | # -- Options for LaTeX output ------------------------------------------------ 111 | 112 | latex_elements = { 113 | # The paper size ('letterpaper' or 'a4paper'). 114 | # 115 | # 'papersize': 'letterpaper', 116 | 117 | # The font size ('10pt', '11pt' or '12pt'). 118 | # 119 | # 'pointsize': '10pt', 120 | 121 | # Additional stuff for the LaTeX preamble. 122 | # 123 | # 'preamble': '', 124 | 125 | # Latex figure (float) alignment 126 | # 127 | # 'figure_align': 'htbp', 128 | } 129 | 130 | # Grouping the document tree into LaTeX files. List of tuples 131 | # (source start file, target name, title, 132 | # author, documentclass [howto, manual, or own class]). 133 | latex_documents = [ 134 | (master_doc, 'python-lichess.tex', 'python-lichess Documentation', 135 | 'python-lichess', 'manual'), 136 | ] 137 | 138 | 139 | # -- Options for manual page output ------------------------------------------ 140 | 141 | # One entry per manual page. List of tuples 142 | # (source start file, name, description, authors, manual section). 143 | man_pages = [ 144 | (master_doc, 'python-lichess', 'python-lichess Documentation', 145 | [author], 1) 146 | ] 147 | 148 | 149 | # -- Options for Texinfo output ---------------------------------------------- 150 | 151 | # Grouping the document tree into Texinfo files. List of tuples 152 | # (source start file, target name, title, author, 153 | # dir menu entry, description, category) 154 | texinfo_documents = [ 155 | (master_doc, 'python-lichess', 'python-lichess Documentation', 156 | author, 'python-lichess', 'One line description of project.', 157 | 'Miscellaneous'), 158 | ] 159 | -------------------------------------------------------------------------------- /docs/format.rst: -------------------------------------------------------------------------------- 1 | Formats 2 | ========================================== 3 | 4 | The module :mod:`lichess.format` lets you choose the format for games and other data (:data:`~lichess.format.JSON`, :data:`~lichess.format.PGN`, :data:`~lichess.format.SINGLE_PGN`, or :data:`~lichess.format.PYCHESS`). 5 | 6 | .. automodule:: lichess.format 7 | :members: JSON, PGN, SINGLE_PGN, PYCHESS 8 | -------------------------------------------------------------------------------- /docs/index.rst: -------------------------------------------------------------------------------- 1 | python-lichess: a client for the lichess.org API 2 | ================================================ 3 | 4 | .. toctree:: 5 | :maxdepth: 2 6 | :caption: Contents 7 | 8 | api 9 | format 10 | auth 11 | pgn 12 | api-config 13 | 14 | Introduction 15 | ------------ 16 | 17 | This is a client library for the `lichess.org `_ `API `_. It is designed to be: 18 | 19 | * Easy to use 20 | 21 | * Customizable when you need it 22 | 23 | * Adaptable to API changes 24 | 25 | * Easy to `integrate `_ with `python-chess `_ 26 | 27 | Have a look at some short examples. For more, check out the full doc in the table of contents. 28 | 29 | Getting a user's rating: 30 | 31 | >>> import lichess.api 32 | >>> 33 | >>> user = lichess.api.user('thibault') 34 | >>> print(user['perfs']['blitz']['rating']) 35 | 1617 36 | 37 | Checking who's online and playing: 38 | 39 | >>> import lichess.api 40 | >>> 41 | >>> users = list(lichess.api.users_status(['thibault', 'cyanfish'])) 42 | >>> online = [u['id'] for u in users if u.get('online')] 43 | >>> playing = [u['id'] for u in users if u.get('playing')] 44 | >>> print(online, playing) 45 | ['thibault', 'cyanfish'] ['cyanfish'] 46 | 47 | Saving a PGN of a user's last 200 games: 48 | 49 | >>> import lichess.api 50 | >>> from lichess.format import SINGLE_PGN 51 | >>> 52 | >>> pgn = lichess.api.user_games('thibault', max=200, format=SINGLE_PGN) 53 | >>> with open('last200.pgn', 'w') as f: 54 | >>> f.write(pgn) 55 | 56 | Integrating with `python-chess `_: 57 | 58 | >>> import lichess.api 59 | >>> from lichess.format import PYCHESS 60 | >>> 61 | >>> game = lichess.api.game('Qa7FJNk2', format=PYCHESS) 62 | >>> print(game.end().board()) 63 | . . k . R b r . 64 | . p p r . N p . 65 | p . . . . . . p 66 | . . . . . . . . 67 | . . . p . . . . 68 | P . . P . . . P 69 | . P P . . P P . 70 | . . K R . . . . 71 | 72 | Installing 73 | ---------- 74 | 75 | :: 76 | 77 | pip install python-lichess 78 | -------------------------------------------------------------------------------- /docs/make.bat: -------------------------------------------------------------------------------- 1 | @ECHO OFF 2 | 3 | pushd %~dp0 4 | 5 | REM Command file for Sphinx documentation 6 | 7 | if "%SPHINXBUILD%" == "" ( 8 | set SPHINXBUILD=sphinx-build 9 | ) 10 | set SOURCEDIR=. 11 | set BUILDDIR=_build 12 | set SPHINXPROJ=python-lichess 13 | 14 | if "%1" == "" goto help 15 | 16 | %SPHINXBUILD% >NUL 2>NUL 17 | if errorlevel 9009 ( 18 | echo. 19 | echo.The 'sphinx-build' command was not found. Make sure you have Sphinx 20 | echo.installed, then set the SPHINXBUILD environment variable to point 21 | echo.to the full path of the 'sphinx-build' executable. Alternatively you 22 | echo.may add the Sphinx directory to PATH. 23 | echo. 24 | echo.If you don't have Sphinx installed, grab it from 25 | echo.http://sphinx-doc.org/ 26 | exit /b 1 27 | ) 28 | 29 | %SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% 30 | goto end 31 | 32 | :help 33 | %SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% 34 | 35 | :end 36 | popd 37 | -------------------------------------------------------------------------------- /docs/pgn.rst: -------------------------------------------------------------------------------- 1 | Custom PGNs 2 | ========================================== 3 | 4 | The module :mod:`lichess.pgn` provides functions to generate custom PGNs from games in JSON format. 5 | 6 | If you only need a default PGN, see the :mod:`lichess.format` module for an easier way to get it. 7 | 8 | .. automodule:: lichess.pgn 9 | :members: from_game, io_from_game, from_games, save_games 10 | -------------------------------------------------------------------------------- /lichess/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/cyanfish/python-lichess/8deea5dda8965b90915c744d65f2a4bc3ee085e5/lichess/__init__.py -------------------------------------------------------------------------------- /lichess/api.py: -------------------------------------------------------------------------------- 1 | import json 2 | import requests 3 | import time 4 | from six.moves import urllib 5 | import lichess.format 6 | import lichess.auth 7 | 8 | 9 | class ApiError(Exception): 10 | """The base class for API exceptions.""" 11 | 12 | class ApiHttpError(ApiError): 13 | """The class for API exceptions caused by an HTTP error code.""" 14 | 15 | def __init__(self, http_status, url, response_text): 16 | self.http_status = http_status 17 | self.url = url 18 | self.response_text = response_text 19 | 20 | def __str__(self): 21 | return '{} {} {}'.format(self.http_status, self.url, self.response_text) 22 | 23 | class DefaultApiClient(object): 24 | """ 25 | The default API client, with immediate HTTP calls and basic rate-limiting functionality. 26 | """ 27 | 28 | _first_call = True 29 | 30 | base_url = 'https://lichess.org/' 31 | """The base lichess API URL. 32 | 33 | This does not include the /api/ prefix, since some APIs don't use it. 34 | """ 35 | 36 | max_retries = -1 37 | """The maximum number of retries after rate-limiting before an exception is raised. -1 for infinite retries.""" 38 | 39 | def __init__(self, base_url=None, max_retries=None): 40 | if base_url is not None: 41 | self.base_url = base_url 42 | if max_retries is not None: 43 | self.max_retries = max_retries 44 | 45 | def call(self, path, params=None, post_data=None, auth=None, format=lichess.format.JSON, object_type=lichess.format.PUBLIC_API_OBJECT): 46 | """Makes an API call, prepending :data:`~lichess.api.DefaultApiClient.base_url` to the provided path. HTTP GET is used unless :data:`post_data` is provided. 47 | 48 | Consecutive calls use a 1s delay. 49 | If HTTP 429 is received, retries after a 1min delay. 50 | """ 51 | if DefaultApiClient._first_call: 52 | DefaultApiClient._first_call = False 53 | else: 54 | time.sleep(1) 55 | 56 | if auth is None: 57 | auth = lichess.auth.EMPTY 58 | elif isinstance(auth, str): 59 | auth = lichess.auth.OAuthToken(auth) 60 | headers = auth.headers() 61 | stream = format.stream(object_type) 62 | content_type = format.content_type(object_type) 63 | if content_type: 64 | headers['Accept'] = content_type 65 | cookies = auth.cookies() 66 | 67 | retry_count = 0 68 | while True: 69 | url = urllib.parse.urljoin(self.base_url, path) 70 | if post_data: 71 | resp = requests.post(url, params=params, data=post_data, headers=headers, cookies=cookies, stream=stream) 72 | else: 73 | resp = requests.get(url, params, headers=headers, cookies=cookies, stream=stream) 74 | 75 | if resp.status_code == 429: 76 | self.on_rate_limit(url, retry_count) 77 | time.sleep(60) 78 | retry_count += 1 79 | elif resp.status_code == 502 or resp.status_code == 503: 80 | self.on_api_down(retry_count) 81 | time.sleep(60) 82 | retry_count += 1 83 | else: 84 | break 85 | 86 | if resp.status_code != 200: 87 | raise ApiHttpError(resp.status_code, url, resp.text) 88 | 89 | return format.parse(object_type, resp) 90 | 91 | def on_rate_limit(self, url, retry_count): 92 | """A handler called when HTTP 429 is received. 93 | 94 | Raises an exception when :data:`~lichess.api.DefaultApiClient.max_retries` is exceeded. 95 | """ 96 | if self.max_retries != -1 and retry_count >= self.max_retries: 97 | raise ApiError('Max retries exceeded') 98 | 99 | def on_api_down(self, retry_count): 100 | """A handler called when HTTP 502 or HTTP 503 is received. 101 | 102 | Raises an exception when :data:`~lichess.api.DefaultApiClient.max_retries` is exceeded. 103 | """ 104 | if self.max_retries != -1 and retry_count >= self.max_retries: 105 | raise ApiError('Max retries exceeded') 106 | 107 | default_client = DefaultApiClient() 108 | """The client object used to communicate with the lichess API. 109 | 110 | Initially set to an instance of :class:`~lichess.api.DefaultApiClient`. 111 | """ 112 | 113 | 114 | # Helpers for API functions 115 | 116 | def _api_get(path, params, object_type=lichess.format.PUBLIC_API_OBJECT): 117 | client = params.pop('client', default_client) 118 | auth = params.pop('auth', lichess.auth.EMPTY) 119 | format = params.pop('format', lichess.format.JSON) 120 | return client.call(path, params, auth=auth, format=format, object_type=object_type) 121 | 122 | def _api_post(path, params, post_data, object_type=lichess.format.PUBLIC_API_OBJECT): 123 | client = params.pop('client', default_client) 124 | auth = params.pop('auth', lichess.auth.EMPTY) 125 | format = params.pop('format', lichess.format.JSON) 126 | return client.call(path, params, post_data, auth=auth, format=format, object_type=object_type) 127 | 128 | def _enum(fn, args, kwargs): 129 | if 'nb' not in kwargs: 130 | kwargs['nb'] = 100 131 | kwargs['page'] = 1 132 | while True: 133 | pag = fn(*args, **kwargs) 134 | if 'paginator' in pag: 135 | pag = pag['paginator'] 136 | for obj in pag['currentPageResults']: 137 | yield obj 138 | if pag['nextPage'] is None or pag['currentPage'] != kwargs['page']: 139 | break 140 | kwargs['page'] += 1 141 | 142 | def _batch(fn, args, kwargs, batch_size): 143 | if len(args) == 0: 144 | raise ValueError('A positional argument must be supplied') 145 | if not isinstance(args[0], list): 146 | raise ValueError('First argument must be a list') 147 | args = list(args) 148 | remaining = args[0] 149 | while len(remaining) > 0: 150 | args[0] = remaining[:batch_size] 151 | remaining = remaining[batch_size:] 152 | results = fn(*args, **kwargs) 153 | for obj in results: 154 | yield obj 155 | 156 | # Actual public API functions 157 | 158 | def user(username, **kwargs): 159 | """Wrapper for the `GET /api/user/ `_ endpoint. 160 | 161 | >>> user = lichess.api.user('thibault') 162 | >>> print(user.get('perfs', {}).get('blitz', {}).get('rating')) 163 | 1617 164 | """ 165 | return _api_get('/api/user/{}'.format(username), kwargs) 166 | 167 | def users_by_team(team, **kwargs): 168 | """Wrapper for the `GET /api/team/{name}/users `_ endpoint. 169 | Returns a generator that streams the user data. 170 | 171 | >>> users = lichess.api.users_by_team('coders') 172 | >>> ratings = [u.get('perfs', {}).get('blitz', {}).get('rating') for u in users] 173 | >>> print(ratings) 174 | [1349, 1609, ...] 175 | """ 176 | return _api_get('/api/team/{}/users'.format(team), kwargs, object_type=lichess.format.STREAM_OBJECT) 177 | 178 | def users_by_ids(ids, **kwargs): 179 | """Wrapper for the `POST /api/users `_ endpoint. 180 | Returns a generator that splits the IDs into multiple requests as needed. 181 | 182 | Note: Use :data:`~lichess.api.users_status` when possible, since it is cheaper and not rate-limited. 183 | 184 | >>> users = lichess.api.users_by_ids(['thibault', 'cyanfish']) 185 | >>> ratings = [u.get('perfs', {}).get('blitz', {}).get('rating') for u in users] 186 | >>> print(ratings) 187 | [1617, 1948] 188 | """ 189 | return _batch(users_by_ids_page, [ids], kwargs, 300) 190 | 191 | def users_by_ids_page(ids, **kwargs): 192 | """Wrapper for the `POST /api/users `_ endpoint. 193 | Use :data:`~lichess.api.users_by_ids` to avoid manual pagination. 194 | """ 195 | return _api_post('/api/users', kwargs, ','.join(ids)) 196 | 197 | def users_status(ids, **kwargs): 198 | """Wrapper for the `GET /api/users/status `_ endpoint. 199 | Returns a generator that makes requests for additional pages as needed. 200 | 201 | Note: This endpoint is cheap and not rate-limited. Use it instead of :data:`~lichess.api.users_by_ids` when possible. 202 | 203 | >>> users = lichess.api.users_status(['thibault', 'cyanfish']) 204 | >>> online_count = len([u for u in users if u.get('online')]) 205 | >>> print(online_count) 206 | 1 207 | """ 208 | return _batch(users_status_page, [ids], kwargs, 40) 209 | 210 | def users_status_page(ids, **kwargs): 211 | """Wrapper for the `GET /api/users/status `_ endpoint. 212 | Use :data:`~lichess.api.users_status` to avoid manual pagination. 213 | """ 214 | kwargs['ids'] = ','.join(ids) 215 | return _api_get('/api/users/status', kwargs) 216 | 217 | def user_activity(username, **kwargs): 218 | """Wrapper for the `GET /api/user//activity `_ endpoint.""" 219 | return _api_get('/api/user/{}/activity'.format(username), kwargs) 220 | 221 | def game(game_id, **kwargs): 222 | """Wrapper for the `GET /api/game/{id} `_ endpoint. 223 | 224 | By default, returns a dict representing a JSON game object. 225 | Use `format=PGN` for a PGN string or `format=PYCHESS` for a `python-chess `_ game object. 226 | 227 | >>> game = lichess.api.game('Qa7FJNk2') 228 | >>> print(game['moves']) 229 | e4 e5 Nf3 Nc6 Bc4 Qf6 d3 h6 ... 230 | 231 | >>> from lichess.format import PGN, PYCHESS 232 | >>> pgn = lichess.api.game('Qa7FJNk2', format=PGN) 233 | >>> print(pgn) 234 | [Event "Casual rapid game"] 235 | ... 236 | 237 | >>> game_obj = lichess.api.game('Qa7FJNk2', format=PYCHESS) 238 | >>> print(game_obj.end().board()) 239 | . . k . R b r . 240 | . p p r . N p . 241 | p . . . . . . p 242 | . . . . . . . . 243 | . . . p . . . . 244 | P . . P . . . P 245 | . P P . . P P . 246 | . . K R . . . . 247 | """ 248 | return _api_get('/game/export/{}'.format(game_id), kwargs, object_type=lichess.format.GAME_OBJECT) 249 | 250 | def games_by_ids(ids, **kwargs): 251 | """Wrapper for the `POST /games/export/_ids `_ endpoint. 252 | Returns a generator that splits the IDs into multiple requests as needed.""" 253 | return _batch(games_by_ids_page, [ids], kwargs, 300) 254 | 255 | def games_by_ids_page(ids, **kwargs): 256 | """Wrapper for the `POST /games/export/_ids `_ endpoint. 257 | Use :data:`~lichess.api.games_by_ids` to avoid manual pagination. 258 | """ 259 | return _api_post('/games/export/_ids', kwargs, ','.join(ids), object_type=lichess.format.GAME_STREAM_OBJECT) 260 | 261 | def user_games(username, **kwargs): 262 | """Wrapper for the `GET /api/user//games `_ endpoint. 263 | 264 | By default, returns a generator that streams game objects. 265 | Use `format=PGN` for a generator of game PGNs, `format=SINGLE_PGN` for a single PGN string, or `format=PYCHESS` for a generator of `python-chess `_ game objects. 266 | 267 | >>> games = lichess.api.user_games('cyanfish', max=50, perfType='blitz') 268 | >>> print(next(games)['moves']) 269 | e4 e5 Nf3 Nc6 Bc4 Qf6 d3 h6 ... 270 | 271 | >>> from lichess.format import PGN, SINGLE_PGN, PYCHESS 272 | >>> pgns = lichess.api.user_games('cyanfish', max=50, format=PGN) 273 | >>> print(next(pgns)) 274 | [Event "Casual rapid game"] 275 | ... 276 | 277 | >>> pgn = lichess.api.user_games('cyanfish', max=50, format=SINGLE_PGN) 278 | >>> print(pgn) 279 | [Event "Casual rapid game"] 280 | ... 281 | 282 | >>> game_objs = lichess.api.user_games('cyanfish', max=50, format=PYCHESS) 283 | >>> print(next(game_objs).end().board()) 284 | . . k . R b r . 285 | . p p r . N p . 286 | p . . . . . . p 287 | . . . . . . . . 288 | . . . p . . . . 289 | P . . P . . . P 290 | . P P . . P P . 291 | . . K R . . . . 292 | """ 293 | return _api_get('/api/games/user/{}'.format(username), kwargs, object_type=lichess.format.GAME_STREAM_OBJECT) 294 | 295 | 296 | def current_game(username, **kwargs): 297 | """Wrapper for the `GET /api/user//current-game` endpoint. 298 | Returns a single game.""" 299 | return _api_get('/api/user/{}/current-game'.format(username), kwargs, object_type=lichess.format.GAME_OBJECT) 300 | 301 | def tournaments(**kwargs): 302 | """Wrapper for the `GET /api/tournament `_ endpoint.""" 303 | return _api_get('/api/tournament', kwargs) 304 | 305 | def tournament(tournament_id, **kwargs): 306 | """Wrapper for the `GET /api/tournament/ `_ endpoint.""" 307 | return _api_get('/api/tournament/{}'.format(tournament_id), kwargs) 308 | 309 | def tournament_standings(tournament_id, **kwargs): 310 | """Wrapper for the `GET /api/tournament/ `_ endpoint. 311 | Returns a generator that makes requests for additional pages as needed.""" 312 | kwargs['page'] = 1 313 | while True: 314 | pag = tournament_standings_page(tournament_id, **kwargs) 315 | for obj in pag['players']: 316 | yield obj 317 | if len(pag['players']) == 0: 318 | break 319 | kwargs['page'] += 1 320 | 321 | def tournament_standings_page(tournament_id, **kwargs): 322 | """Wrapper for the `GET /api/tournament/ `_ endpoint. 323 | Use :data:`~lichess.api.tournament_standings` to avoid manual pagination. 324 | """ 325 | return _api_get('/api/tournament/{}'.format(tournament_id), kwargs)['standing'] 326 | 327 | def tv_channels(**kwargs): 328 | """Wrapper for the `GET /tv/channels `_ endpoint.""" 329 | return _api_get('/tv/channels', kwargs) 330 | 331 | def cloud_eval(fen, **kwargs): 332 | """Wrapper for the `GET api/cloud-eval `_ endpoint. """ 333 | kwargs['fen'] = fen 334 | return _api_get('/api/cloud-eval', kwargs) 335 | 336 | def login(username, password): 337 | cookie_jar = _api_post('/login', {'format': lichess.format.COOKIES}, {'username': username, 'password': password}) 338 | return lichess.auth.Cookie(cookie_jar) 339 | -------------------------------------------------------------------------------- /lichess/auth.py: -------------------------------------------------------------------------------- 1 | 2 | class AuthBase(object): 3 | 4 | def headers(self): 5 | return {} 6 | 7 | def cookies(self): 8 | return {} 9 | 10 | 11 | class OAuthToken(AuthBase): 12 | 13 | def __init__(self, token): 14 | self.token = token 15 | 16 | def headers(self): 17 | return {'Authorization': 'Bearer %s' % self.token} 18 | 19 | 20 | class Cookie(AuthBase): 21 | 22 | def __init__(self, jar): 23 | self.jar = jar 24 | 25 | def cookies(self): 26 | return self.jar 27 | 28 | 29 | EMPTY = AuthBase() 30 | -------------------------------------------------------------------------------- /lichess/format.py: -------------------------------------------------------------------------------- 1 | from six import StringIO 2 | import re 3 | import json 4 | 5 | GAME_STREAM_OBJECT = 'game_stream' 6 | STREAM_OBJECT = 'stream' 7 | GAME_OBJECT = 'game' 8 | PUBLIC_API_OBJECT = 'public_api' 9 | MOBILE_API_OBJECT = 'mobile_api' 10 | 11 | 12 | def stream_pgns(resp): 13 | buffer = [] 14 | for line in resp.iter_lines(): 15 | buffer.append(line.decode('utf-8')) 16 | if buffer[-2:] == ['', '']: 17 | yield '\n'.join(buffer) 18 | buffer = [] 19 | if len(buffer) > 3: 20 | yield '\n'.join(buffer) 21 | 22 | 23 | class _FormatBase(object): 24 | 25 | def content_type(self, object_type): 26 | return None 27 | 28 | def stream(self, object_type): 29 | return False 30 | 31 | def parse(self, object_type, resp): 32 | pass 33 | 34 | 35 | class _Pgn(_FormatBase): 36 | 37 | def content_type(self, object_type): 38 | if object_type not in (GAME_STREAM_OBJECT, GAME_OBJECT): 39 | raise ValueError('PGN format is only valid for games') 40 | return 'application/x-chess-pgn' 41 | 42 | def stream(self, object_type): 43 | return object_type == GAME_STREAM_OBJECT 44 | 45 | def parse(self, object_type, resp): 46 | if object_type == GAME_STREAM_OBJECT: 47 | return stream_pgns(resp) 48 | return resp.text 49 | 50 | 51 | PGN = _Pgn() 52 | """Produces a PGN string, or a generator for PGN strings of each game. 53 | 54 | >>> from lichess.format import PGN 55 | >>> 56 | >>> pgn = lichess.api.game('Qa7FJNk2', format=PGN) 57 | >>> print(pgn) 58 | [Event "Casual rapid game"] 59 | ... 60 | >>> pgns = lichess.api.user_games('cyanfish', max=50, format=PGN) 61 | >>> print(len(list(pgns))) 62 | 50 63 | """ 64 | 65 | 66 | class _SinglePgn(_Pgn): 67 | 68 | def parse(self, object_type, resp): 69 | return resp.text 70 | 71 | 72 | SINGLE_PGN = _SinglePgn() 73 | """Produces a PGN string, possibly containing multiple games. 74 | 75 | >>> from lichess.format import0 SINGLE_PGN 76 | >>> 77 | >>> pgn = lichess.api.user_games('cyanfish', max=50, format=SINGLE_PGN) 78 | >>> print(pgn) 79 | [Event "Casual rapid game"] 80 | ... 81 | """ 82 | 83 | 84 | class _PyChess(_FormatBase): 85 | 86 | def content_type(self, object_type): 87 | if object_type not in (GAME_STREAM_OBJECT, GAME_OBJECT): 88 | raise ValueError('PyChess format is only valid for games') 89 | return 'application/x-chess-pgn' 90 | 91 | def parse(self, object_type, resp): 92 | try: 93 | import chess.pgn 94 | except ImportError: 95 | raise ImportError('PyChess format requires the python-chess package to be installed') 96 | if object_type == GAME_STREAM_OBJECT: 97 | return (chess.pgn.read_game(StringIO(pgn)) for pgn in stream_pgns(resp)) 98 | return chess.pgn.read_game(StringIO(resp.text)) 99 | 100 | 101 | PYCHESS = _PyChess() 102 | """Produces a `python-chess `_ game object, or a generator for multiple game objects. 103 | 104 | >>> from lichess.format import PYCHESS 105 | >>> 106 | >>> game = lichess.api.game('Qa7FJNk2', format=PYCHESS) 107 | >>> print(game.end().board()) 108 | . . k . R b r . 109 | . p p r . N p . 110 | p . . . . . . p 111 | . . . . . . . . 112 | . . . p . . . . 113 | P . . P . . . P 114 | . P P . . P P . 115 | . . K R . . . . 116 | """ 117 | 118 | 119 | class _Json(_FormatBase): 120 | 121 | def content_type(self, object_type): 122 | if object_type in (STREAM_OBJECT, GAME_STREAM_OBJECT): 123 | return 'application/x-ndjson' 124 | if object_type == MOBILE_API_OBJECT: 125 | return 'application/vnd.lichess.v3+json' 126 | return 'application/json' 127 | 128 | def stream(self, object_type): 129 | return object_type in (STREAM_OBJECT, GAME_STREAM_OBJECT) 130 | 131 | def parse(self, object_type, resp): 132 | if object_type in (STREAM_OBJECT, GAME_STREAM_OBJECT): 133 | return (json.loads(s) for s in resp.iter_lines()) 134 | return json.loads(resp.text) 135 | 136 | 137 | JSON = _Json() 138 | """Produces a dict representing a JSON object, or a generator for multiple dicts. This is the default format. 139 | 140 | >>> from lichess.format import JSON 141 | >>> 142 | >>> game = lichess.api.game('Qa7FJNk2', format=JSON) # or leave out 143 | >>> print(game['players']['white']['user']['id']) 144 | cyanfish 145 | """ 146 | 147 | 148 | class _Cookies(_FormatBase): 149 | 150 | def content_type(self, object_type): 151 | return 'application/vnd.lichess.v3+json' 152 | 153 | def parse(self, object_type, resp): 154 | return resp.cookies 155 | 156 | 157 | COOKIES = _Cookies() 158 | -------------------------------------------------------------------------------- /lichess/pgn.py: -------------------------------------------------------------------------------- 1 | from datetime import datetime 2 | from six import StringIO 3 | 4 | def _node(g, spec): 5 | parts = spec.split('.') 6 | for p in parts: 7 | if p not in g: 8 | return None 9 | g = g[p] 10 | return str(g) 11 | 12 | def _cap(s): 13 | if len(s) == 0: 14 | return s 15 | return s[0].upper() + s[1:] 16 | 17 | def from_game(game, headers=None): 18 | """Converts a JSON game to a PGN string. 19 | 20 | :game: The game object. 21 | :headers: An optional dictionary with custom PGN headers. 22 | 23 | >>> game = lichess.api.game('Qa7FJNk2', with_moves=1) 24 | >>> pgn = lichess.pgn.from_game(game) 25 | >>> print(pgn) 26 | [Event "Casual rapid game"] 27 | ... 28 | """ 29 | if headers is None: 30 | headers = {} 31 | else: 32 | headers = dict(headers) 33 | g = game 34 | if 'moves' not in g: 35 | raise ValueError('The provided game doesn\'t have any moves. Maybe you forgot to set with_moves=1 on the API call?') 36 | 37 | result = '1/2-1/2' if _node(g, 'status') == 'draw' else '1-0' if _node(g, 'winner') == 'white' else '0-1' if _node(g, 'winner') == 'black' else '*' 38 | h = [] 39 | h.append(("Event", "%s %s game" % ("Rated" if g["rated"] else "Casual", g["speed"]))) 40 | h.append(('Site', 'https://lichess.org/%s' % g['id'])) 41 | h.append(('Date', datetime.fromtimestamp(int(g['createdAt']) / 1000.0).strftime('%Y.%m.%d'))) 42 | h.append(('Round', '?')) 43 | h.append(('White', _node(g, 'players.white.userId') or '?')) 44 | h.append(('Black', _node(g, 'players.black.userId') or '?')) 45 | h.append(('Result', result)) 46 | h.append(('WhiteElo', _node(g, 'players.white.rating') or '?')) 47 | h.append(('BlackElo', _node(g, 'players.black.rating') or '?')) 48 | h.append(('ECO', _node(g, 'opening.eco'))) 49 | h.append(('Opening', _node(g, 'opening.name'))) 50 | if g['variant'] == 'fromPosition': 51 | h.append(('FEN', g['initialFen'])) 52 | elif g['variant'] != 'standard': 53 | h.append(('Variant', _cap(g['variant']))) 54 | if g['speed'] != 'correspondence': 55 | h.append(('TimeControl', _node(g, 'clock.initial') + '+' + _node(g, 'clock.increment'))) 56 | moves = g['moves'] 57 | pgn = '' 58 | for i in h: 59 | key = i[0] 60 | value = headers.pop(key, i[1]) 61 | if value is not None: 62 | pgn += '[{} "{}"]\n'.format(key, value) 63 | pgn += '\n' 64 | ply = 0 65 | for m in moves.split(' '): 66 | if ply % 2 == 0: 67 | pgn += str(int(ply / 2 + 1)) + '. ' 68 | pgn += m + ' ' 69 | ply += 1 70 | pgn += result 71 | pgn += '\n' 72 | return pgn 73 | 74 | def io_from_game(game, headers=None): 75 | """Like :data:`~lichess.pgn.from_game`, except it wraps the result in :data:`StringIO`. 76 | 77 | This allows easy integration with the `python-chess `_ library. 78 | But if this is all you need, see the :mod:`lichess.format` module for an easier way. 79 | 80 | :game: The game object. 81 | :headers: An optional dictionary with custom PGN headers. 82 | 83 | >>> import lichess.api 84 | >>> import lichess.pgn 85 | >>> import chess.pgn 86 | >>> 87 | >>> api_game = lichess.api.game('Qa7FJNk2', with_moves=1) 88 | >>> game = chess.pgn.read_game(lichess.pgn.io_from_game(api_game)) 89 | >>> print(game.end().board()) 90 | . . k . R b r . 91 | . p p r . N p . 92 | p . . . . . . p 93 | . . . . . . . . 94 | . . . p . . . . 95 | P . . P . . . P 96 | . P P . . P P . 97 | . . K R . . . . 98 | """ 99 | return StringIO(from_game(game, headers)) 100 | 101 | def _validate_games(games): 102 | if isinstance(games, dict) and 'currentPageResults' in games: 103 | raise ValueError('The games argument must be a list. You provided a paginator. Use [\'currentPageResults\'] to get the games list, or use an API method that returns a generator.') 104 | 105 | def from_games(games, headers=None): 106 | """Converts an enumerable of JSON games to a PGN string. 107 | 108 | :games: The enumerable of game objects. 109 | :headers: An optional dictionary with (shared) custom PGN headers. 110 | 111 | >>> import itertools 112 | >>> 113 | >>> games = lichess.api.user_games('cyanfish', with_moves=1) 114 | >>> pgn = lichess.pgn.from_games(itertools.islice(games, 5)) 115 | >>> print(pgn.count('\\n')) 116 | 66 117 | """ 118 | _validate_games(games) 119 | return '\n'.join((from_game(g, headers) for g in games)) 120 | 121 | def save_games(games, path, headers=None): 122 | """Saves an enumerable of JSON games to a PGN file. 123 | 124 | :games: The enumerable of game objects. 125 | :path: The path of the .pgn file to save. 126 | :headers: An optional dictionary with (shared) custom PGN headers. 127 | 128 | >>> import itertools 129 | >>> 130 | >>> games = lichess.api.user_games('cyanfish', with_moves=1) 131 | >>> lichess.pgn.save_games(itertools.islice(games, 5), 'mylast5games.pgn') 132 | 133 | """ 134 | _validate_games(games) 135 | with open(path, 'wb') as fout: 136 | first = True 137 | for g in games: 138 | if first: 139 | first = False 140 | else: 141 | fout.write('\n'.encode('utf-8')) 142 | fout.write(from_game(g, headers).encode('utf-8')) 143 | -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | requests==2.20.0 2 | six==1.11.0 3 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | import io 2 | import os 3 | import setuptools 4 | import sys 5 | import platform 6 | import re 7 | 8 | def read_description(): 9 | return io.open(os.path.join(os.path.dirname(__file__), "README.rst"), encoding="utf-8").read() 10 | 11 | setuptools.setup( 12 | name="python-lichess", 13 | version='0.8', 14 | description='A client for the lichess.org API', 15 | long_description=read_description(), 16 | license="GPL3", 17 | keywords="chess lichess api", 18 | url="https://github.com/cyanfish/python-lichess", 19 | packages=["lichess"], 20 | install_requires=['requests', 'six'], 21 | python_requires=">=2.7,!=3.0.*,!=3.1.*,!=3.2.*", 22 | classifiers=[ 23 | "Development Status :: 4 - Beta", 24 | "Intended Audience :: Developers", 25 | "Intended Audience :: Science/Research", 26 | "License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)", 27 | "Operating System :: OS Independent", 28 | "Programming Language :: Python", 29 | "Programming Language :: Python :: 2", 30 | "Programming Language :: Python :: 2.7", 31 | "Programming Language :: Python :: 3", 32 | "Programming Language :: Python :: 3.3", 33 | "Programming Language :: Python :: 3.4", 34 | "Programming Language :: Python :: 3.5", 35 | "Programming Language :: Python :: 3.6", 36 | "Topic :: Games/Entertainment :: Board Games", 37 | "Topic :: Software Development :: Libraries :: Python Modules", 38 | ], 39 | ) 40 | -------------------------------------------------------------------------------- /test.py: -------------------------------------------------------------------------------- 1 | import lichess.api 2 | import lichess.pgn 3 | import lichess.format 4 | import chess.pgn 5 | import itertools 6 | import unittest 7 | 8 | class ApiIntegrationTestCase(unittest.TestCase): 9 | 10 | def test_user(self): 11 | user = lichess.api.user('thibault') 12 | rating = user['perfs']['blitz']['rating'] 13 | self.assertEqual(type(rating), int) 14 | 15 | def test_users_by_team(self): 16 | users = lichess.api.users_by_team('coders', nb=10) 17 | lst = list(itertools.islice(users, 2)) 18 | self.assertEqual(type(lst[0]['id']), str) 19 | self.assertEqual(len(lst), 2) 20 | 21 | def test_users_by_ids(self): 22 | users = lichess.api.users_by_ids(['thibault', 'cyanfish']) 23 | lst = list(users) 24 | rating1 = lst[0]['perfs']['blitz']['rating'] 25 | rating2 = lst[1]['perfs']['blitz']['rating'] 26 | self.assertEqual(type(rating1), int) 27 | self.assertEqual(type(rating2), int) 28 | self.assertNotEqual(rating1, rating2) 29 | 30 | def test_users_status(self): 31 | users = lichess.api.users_status(['thibault', 'cyanfish']) 32 | online_count = len([u for u in users if u.get('online')]) 33 | self.assertEqual(type(online_count), int) 34 | 35 | def test_user_activity(self): 36 | activity = lichess.api.user_activity('thibault') 37 | self.assertEqual(type(activity), list) 38 | 39 | def test_current_game(self): 40 | game = lichess.api.current_game('cyanfish') 41 | self.assertEqual(type(game['moves']), type(u'')) 42 | 43 | def test_game(self): 44 | game = lichess.api.game('Qa7FJNk2') 45 | self.assertEqual(type(game['moves']), type(u'')) 46 | 47 | def test_game_pgn(self): 48 | pgn = lichess.api.game('Qa7FJNk2', format=lichess.format.PGN) 49 | self.assertEqual(pgn[:7], '[Event ') 50 | 51 | def test_game_pychess(self): 52 | game = lichess.api.game('Qa7FJNk2', format=lichess.format.PYCHESS) 53 | self.assertTrue('Event' in game.headers) 54 | 55 | def test_games_by_ids(self): 56 | games = lichess.api.games_by_ids(['Qa7FJNk2', '4M973EVR'], with_moves=1) 57 | lst = list(games) 58 | moves1 = lst[0]['moves'] 59 | moves2 = lst[1]['moves'] 60 | self.assertEqual(type(moves1), type(u'')) 61 | self.assertEqual(type(moves2), type(u'')) 62 | self.assertNotEqual(moves1, moves2) 63 | 64 | def test_user_games(self): 65 | games = lichess.api.user_games('thibault', max=5) 66 | lst = list(itertools.islice(games, 2)) 67 | moves1 = lst[0]['moves'] 68 | moves2 = lst[1]['moves'] 69 | self.assertEqual(type(moves1), type(u'')) 70 | self.assertEqual(type(moves2), type(u'')) 71 | 72 | def test_user_games_pgn(self): 73 | pgns = lichess.api.user_games('thibault', max=5, format=lichess.format.PGN) 74 | lst = list(itertools.islice(pgns, 2)) 75 | self.assertEqual(lst[0][:7], '[Event ') 76 | self.assertEqual(lst[1][:7], '[Event ') 77 | self.assertNotEqual(lst[0], lst[1]) 78 | 79 | def test_user_games_single_pgn(self): 80 | pgn = lichess.api.user_games('thibault', max=5, format=lichess.format.SINGLE_PGN) 81 | lst = list(itertools.islice(pgn, 2)) 82 | self.assertEqual(pgn[:7], '[Event ') 83 | 84 | def test_user_games_pychess(self): 85 | games = lichess.api.user_games('thibault', max=5, format=lichess.format.PYCHESS) 86 | lst = list(itertools.islice(games, 2)) 87 | self.assertTrue('Event' in lst[0].headers) 88 | self.assertTrue('Event' in lst[1].headers) 89 | self.assertNotEqual(lst[0], lst[1]) 90 | 91 | def test_tournaments(self): 92 | tourns = lichess.api.tournaments() 93 | self.assertGreater(len(tourns), 0) 94 | 95 | def test_tournament(self): 96 | tourn = lichess.api.tournament('winter17') 97 | self.assertEqual(tourn['id'], 'winter17') 98 | 99 | def test_tournament_standings(self): 100 | stands = lichess.api.tournament_standings('winter17') 101 | first_20 = list(itertools.islice(stands, 20)) 102 | self.assertEqual(first_20[0]['name'].lower(), 'lance5500') 103 | self.assertEqual(first_20[-1]['name'].lower(), 'mr_strange') 104 | 105 | def test_tv_channels(self): 106 | channels = lichess.api.tv_channels() 107 | self.assertEqual(type(channels['Blitz']), dict) 108 | 109 | def test_cloud_eval(self): 110 | evaluation = lichess.api.cloud_eval(fen="rnbqkbnr/ppp1pppp/8/3pP3/8/8/PPPP1PPP/RNBQKBNR b KQkq - 0 2", multiPv=5, variant="standard") 111 | pvs = evaluation['pvs'] 112 | self.assertEqual(evaluation['fen'], "rnbqkbnr/ppp1pppp/8/3pP3/8/8/PPPP1PPP/RNBQKBNR b KQkq - 0 2") 113 | self.assertEqual(len(pvs), 5) 114 | 115 | class PgnIntegrationTestCase(unittest.TestCase): 116 | 117 | def test_pychess(self): 118 | api_game = lichess.api.game('Qa7FJNk2') 119 | game = chess.pgn.read_game(lichess.pgn.io_from_game(api_game)) 120 | fen = game.end().board().fen() 121 | self.assertEqual(fen, '2k1Rbr1/1ppr1Np1/p6p/8/3p4/P2P3P/1PP2PP1/2KR4 b - - 2 19') 122 | 123 | def test_pychess_correspondence(self): 124 | api_game = lichess.api.game('9PzeRgcM') 125 | game = chess.pgn.read_game(lichess.pgn.io_from_game(api_game)) 126 | fen = game.end().board().fen() 127 | self.assertEqual(fen, '2r5/p2Q1ppp/1p2k3/1Bb1P3/5B2/P7/1P3PPP/R3K2R b KQ - 0 21') 128 | 129 | if __name__ == '__main__': 130 | unittest.main() 131 | --------------------------------------------------------------------------------