├── .gitignore ├── .travis.yml ├── LICENSE ├── README.md ├── examples ├── content_basic.py ├── content_pages.py ├── content_with_headers.py ├── editions_basic.py ├── section_and_content.py ├── section_basic.py ├── single_item.py ├── single_item_tags.py ├── tag_and_content.py ├── tags_basic.py └── tags_example.py ├── requirements.txt ├── test.py ├── tests ├── __init__.py ├── test_content.py ├── test_edition.py ├── test_section.py └── test_tag.py └── theguardian ├── __init__.py ├── theguardian_content.py ├── theguardian_edition.py ├── theguardian_section.py └── theguardian_tag.py /.gitignore: -------------------------------------------------------------------------------- 1 | .idea 2 | *.pyc 3 | 4 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | language: python 2 | python: 3 | - "3.6" 4 | install: 5 | - pip install -r requirements.txt 6 | script: 7 | - pytest -------------------------------------------------------------------------------- /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 | {one line to give the program's name and a brief idea of what it does.} 635 | Copyright (C) {year} {name of author} 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 | {project} Copyright (C) {year} {fullname} 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.md: -------------------------------------------------------------------------------- 1 | # theguardian-api-python 2 | This is a simple and lightweight Python client for thegaurdian api. 3 | 4 | [![GNU license](https://camo.githubusercontent.com/940baba6e10de9f9bd8616bf42804619f2fb07fc/687474703a2f2f696d672e736869656c64732e696f2f62616467652f6c6963656e73652d474e5576332d627269676874677265656e2e737667)](https://github.com/prabhath6/theguardian-api-python/blob/master/LICENSE) [![Gitter chat](https://badges.gitter.im/USER/REPO.png)](https://gitter.im/theguardian-api-python/developers_contributers_users) [![Build Status](https://travis-ci.org/prabhath6/theguardian-api-python.svg?branch=master)](https://travis-ci.org/prabhath6/theguardian-api-python) 5 | 6 | 7 | ### theguardian Documentation 8 | 1. [Overview](http://open-platform.theguardian.com/documentation/) 9 | 2. [Content](http://open-platform.theguardian.com/documentation/search) 10 | 3. [Tags](http://open-platform.theguardian.com/documentation/tag) 11 | 4. [Section](http://open-platform.theguardian.com/documentation/section) 12 | 5. [Edition](http://open-platform.theguardian.com/documentation/edition) 13 | 6. [Single Item](http://open-platform.theguardian.com/documentation/item) 14 | 15 | ##### theguardian provides several endpoints to retrieve different items: 16 | 17 | * Content 18 | * Tags 19 | * Sections 20 | * Editions 21 | * Single item 22 | 23 | ##### For each endpoint: 24 | 25 | * results can be filtered using parameters. 26 | * response contains minimal detail by default but more data can be exposed using parameters. 27 | * results are returned as paginated list of containing, by default, 10 entries per page. 28 | 29 | ### Content endpoint 30 | This Content module can be used as an interface for the content endpoint provided 31 | by theguardian. 32 | ```python 33 | from theguardian import theguardian_content 34 | 35 | # create content 36 | content = theguardian_content.Content(api='test') 37 | 38 | # gets raw_response 39 | raw_content = content.get_request_response() 40 | print("Request Response status code {status}." .format(status=raw_content.status_code)) 41 | print("Request Response headers {header}." .format(header=raw_content.headers)) 42 | 43 | # content 44 | print("Content Response headers {}." .format(content.response_headers())) 45 | 46 | # get all results of a page 47 | json_content = content.get_content_response() 48 | all_results = content.get_results(json_content) 49 | print("All results {}." .format(all_results)) 50 | 51 | # actual response 52 | print("Response {response}" .format(response=json_content)) 53 | ``` 54 | ### Section endpoint 55 | This Section module can be used as an interface for the sections endpoint provided 56 | by theguardian. This can be used to access various sections within the theguardian's 57 | data. Some example of sections query parameters(q) are business, sports and technology. 58 | ```python 59 | """ 60 | This example deals with returning content of section. 61 | """ 62 | from theguardian import theguardian_section 63 | from theguardian import theguardian_content 64 | 65 | 66 | # get the sports sections 67 | headers = {"q": "sports"} # q=query parameter/search parameter 68 | section = theguardian_section.Section(api='test', **headers) 69 | 70 | # get the results 71 | section_content = section.get_content_response() 72 | results = section.get_results(section_content) 73 | 74 | # get different editions from the results 75 | editions = results[0]['editions'] 76 | 77 | # get uk/sports edition apiUrl 78 | uk_sports = [edi["apiUrl"] for edi in editions if edi["id"] == "uk/sport"][0] 79 | 80 | # use this api url to sports content 81 | content = theguardian_content.Content(api='test', url=uk_sports) 82 | 83 | # get section response 84 | content_response = content.get_content_response() 85 | print(content_response) 86 | ``` 87 | ### Edition endpoint 88 | The editions endpoint returns all editions in the API. 89 | Editions are the different front main pages of the Guardian site we have. 90 | At current thguardian supports editions for the United Kingdom(uk), the United States(us) and Australia(au). 91 | ```python 92 | from theguardian import theguardian_edition 93 | 94 | # create edition 95 | edition = theguardian_edition.Edition(api='test') 96 | 97 | # get all results of a page 98 | json_content = edition.get_content_response() 99 | all_results = edition.get_results(json_content) 100 | 101 | # get all the sections webUrl 102 | for result in all_results: 103 | print("{id} - {url}" .format(id=result["id"], url=result["webUrl"])) 104 | 105 | ``` 106 | ### Tag endpoint 107 | The tags endpoint returns all tags in the API. All Guardian content 108 | is manually categorised using these tags, of which there are more than 50,000. 109 | ```python 110 | """ 111 | This example deals with returning references of specific tags. 112 | """ 113 | from theguardian import theguardian_tag 114 | 115 | header = { 116 | "q": "apple", 117 | "section": "technology", 118 | } 119 | t = theguardian_tag.Tag(api="test", **header) 120 | print(t.get_references_in_page(1)) 121 | 122 | ``` 123 | For more examples refer the [examples](https://github.com/prabhath6/theguardian-api-python/tree/master/examples) folder. 124 | ### Install 125 | 1. Create a virtual environment. 126 | 2. Clone or download the repo. 127 | 3. Pip install requirements. 128 | 4. Run the tests 129 | 5. Copy theguardian folder into virtual environment. 130 | 131 | ``` 132 | mkdir sample_folder 133 | cd sample_folder 134 | virtualenv -p /usr/bin/python3 guardian 135 | 136 | git clone https://github.com/prabhath6/theguardian-api-python.git 137 | cd theguardian-api-python 138 | 139 | source ../guardian/bin/activate 140 | pip install -r requirements.txt 141 | 142 | python test.py 143 | 144 | cp -r theguardian ../guardian/lib/python3.5 145 | ``` 146 | #### Notes 147 | 1. Requires python3. 148 | 2. Designed to work with only json data. 149 | 3. Built as a simple weekend project. 150 | 4. Refer examples for better understanding. 151 | 152 | ### Notes on Patches/Pull requests 153 | * Fork the repo. 154 | * Add features or fix bugs. 155 | * Add tests to features or bug fixes. 156 | * Send pull requests once done building. 157 | 158 | -------------------------------------------------------------------------------- /examples/content_basic.py: -------------------------------------------------------------------------------- 1 | from theguardian import theguardian_content 2 | 3 | # create content 4 | content = theguardian_content.Content(api='test') 5 | 6 | # gets raw_response 7 | raw_content = content.get_request_response() 8 | print("Request Response status code {status}." .format(status=raw_content.status_code)) 9 | print("Request Response headers {header}." .format(header=raw_content.headers)) 10 | 11 | # content 12 | print("Content Response headers {}." .format(content.response_headers())) 13 | 14 | # get all results of a page 15 | json_content = content.get_content_response() 16 | all_results = content.get_results(json_content) 17 | print("All results {}." .format(all_results)) 18 | 19 | # actual response 20 | print("Response {response}" .format(response=json_content)) 21 | -------------------------------------------------------------------------------- /examples/content_pages.py: -------------------------------------------------------------------------------- 1 | from theguardian import theguardian_content 2 | 3 | 4 | # create content 5 | headers = { 6 | "page-size": 5, 7 | "order-by": "newest", 8 | } 9 | content = theguardian_content.Content(api='test', **headers) 10 | 11 | # looping through pages 12 | response_headers = content.response_headers() 13 | total_pages = response_headers["pages"] 14 | 15 | # print apiUrls for all the results in first 5 pages 16 | required_pages = 5 17 | required_urls = [] 18 | 19 | if total_pages > required_pages: 20 | 21 | headers = { 22 | "page-size": 5, 23 | "order-by": "newest", 24 | } 25 | content2 = theguardian_content.Content(api='test', **headers) 26 | 27 | for page in range(1, required_pages+1): 28 | res = content2.get_content_response(headers={"page": page}) 29 | page_results = res['response']['results'] 30 | for result in page_results: 31 | required_urls.append(result["apiUrl"]) 32 | 33 | for url in required_urls: 34 | print(url) 35 | -------------------------------------------------------------------------------- /examples/content_with_headers.py: -------------------------------------------------------------------------------- 1 | from theguardian import theguardian_content 2 | 3 | # create content 4 | content = theguardian_content.Content(api='test') 5 | ids = "technology/2014/feb/17/flappy-bird-clones-apple-google" 6 | 7 | res = content.find_by_id(ids) 8 | result = content.get_results(res) 9 | 10 | print("Result: {result}" .format(result=result)) 11 | 12 | # create content with filters 13 | # for more filters refer 14 | # http://open-platform.theguardian.com/documentation/search 15 | 16 | headers = { 17 | "q": "12 years a slave", 18 | "tag": "film/film,tone/reviews", 19 | "from-date": "2010-01-01", 20 | "order-by": "relevance", 21 | "show-fields": "starRating,headline,thumbnail,short-url", 22 | } 23 | content = theguardian_content.Content(api='test', **headers) 24 | 25 | res = content.get_content_response() 26 | result = content.get_results(res) 27 | 28 | print("Result: {result}" .format(result=result)) 29 | -------------------------------------------------------------------------------- /examples/editions_basic.py: -------------------------------------------------------------------------------- 1 | from theguardian import theguardian_edition 2 | 3 | # create edition 4 | edition = theguardian_edition.Edition(api='test') 5 | 6 | # gets raw_response 7 | raw_content = edition.get_request_response() 8 | print("Request Response status code {status}." .format(status=raw_content.status_code)) 9 | print("Request Response headers {header}." .format(header=raw_content.headers)) 10 | 11 | # content 12 | print("Content Response headers {}." .format(edition.response_headers())) 13 | 14 | # get all results of a page 15 | json_content = edition.get_content_response() 16 | all_results = edition.get_results(json_content) 17 | print("All results {}." .format(all_results)) 18 | 19 | # actual response 20 | print("Response {response}" .format(response=json_content)) 21 | 22 | # get all the sections webUrl 23 | for result in all_results: 24 | print("{id} - {url}" .format(id=result["id"], url=result["webUrl"])) 25 | -------------------------------------------------------------------------------- /examples/section_and_content.py: -------------------------------------------------------------------------------- 1 | """ 2 | This example deals with returning content of section. 3 | """ 4 | from theguardian import theguardian_section 5 | from theguardian import theguardian_content 6 | 7 | 8 | # get the sports sections 9 | headers = {"q": "sports"} # q=query parameter/search parameter 10 | section = theguardian_section.Section(api='test', **headers) 11 | 12 | # get the results 13 | section_content = section.get_content_response() 14 | results = section.get_results(section_content) 15 | 16 | # get different editions from the results 17 | editions = results[0]['editions'] 18 | 19 | # get uk/sports edition apiUrl 20 | uk_sports = [edi["apiUrl"] for edi in editions if edi["id"] == "uk/sport"][0] 21 | 22 | # use this api url to sports content 23 | content = theguardian_content.Content(api='test', url=uk_sports) 24 | 25 | # get section response 26 | content_response = content.get_content_response() 27 | print(content_response) 28 | -------------------------------------------------------------------------------- /examples/section_basic.py: -------------------------------------------------------------------------------- 1 | from theguardian import theguardian_section 2 | 3 | # create section 4 | section = theguardian_section.Section(api='test') 5 | 6 | # gets raw_response 7 | raw_section_content = section.get_request_response() 8 | print("Request Response status code {status}." .format(status=raw_section_content.status_code)) 9 | print("Request Response headers {header}." .format(header=raw_section_content.headers)) 10 | 11 | # content 12 | print("Section Response headers {}." .format(section.response_headers())) 13 | 14 | # get all results of a page 15 | json_content = section.get_content_response() 16 | all_results = section.get_results(json_content) 17 | print("All results {}." .format(all_results)) 18 | 19 | # actual response 20 | print("Response {response}" .format(response=json_content)) 21 | -------------------------------------------------------------------------------- /examples/single_item.py: -------------------------------------------------------------------------------- 1 | """ 2 | Query for a single content item and print its web title 3 | """ 4 | from theguardian import theguardian_content 5 | 6 | 7 | ids = "commentisfree/2013/jan/16/vegans-stomach-unpalatable-truth-quinoa" 8 | content = theguardian_content.Content(api="test") 9 | 10 | single_id_content = content.find_by_id(ids) 11 | results = content.get_results(single_id_content) 12 | 13 | print("web url for {id}: {url}\n" 14 | .format(id=results[0]["id"], url=results[0]["webUrl"])) 15 | 16 | """ 17 | Print web title for a tag 18 | """ 19 | 20 | header = { 21 | "tag": "music/metal", 22 | } 23 | tag_content = theguardian_content.Content(api="test") 24 | 25 | tag_content_response = content.get_content_response(header) 26 | results = content.get_results(tag_content_response) 27 | 28 | print("web title for {id}: {url}\n" 29 | .format(id=results[0]["id"], url=results[0]["webTitle"])) 30 | 31 | """ 32 | print web title for a section 33 | """ 34 | 35 | section_header = { 36 | "section": "environment" 37 | } 38 | 39 | section_content = theguardian_content.Content(api="test") 40 | 41 | section_content_response = content.get_content_response(section_header) 42 | results = content.get_results(section_content_response) 43 | 44 | print("web title for {id}: {url}\n" 45 | .format(id=results[0]["id"], url=results[0]["webTitle"])) 46 | -------------------------------------------------------------------------------- /examples/single_item_tags.py: -------------------------------------------------------------------------------- 1 | """ 2 | Print the web title of every tag a content item has 3 | for a single item. 4 | """ 5 | from theguardian import theguardian_content 6 | 7 | 8 | headers = { 9 | "ids": "environment/2014/sep/14/invest-in-monitoring-and-tagging-sharks-to-prevent-attacks", 10 | "show-tags": "all", 11 | } 12 | 13 | content = theguardian_content.Content(api="test", **headers) 14 | content_response = content.get_content_response() 15 | results = content.get_results(content_response) 16 | tags = results[0]["tags"] 17 | webTitles = [tag["webTitle"] for tag in tags] 18 | 19 | print("Title of tags {titles}" .format(titles=webTitles)) 20 | 21 | """ 22 | Print the web title of each content item in the 23 | editor's picks for the film tag. 24 | """ 25 | 26 | tag_headers = { 27 | "tag": "film/film" 28 | } 29 | 30 | tag_content = theguardian_content.Content(api="test", **tag_headers) 31 | tag_content_response = tag_content.get_content_response() 32 | results = tag_content.get_results(tag_content_response) 33 | webTitles = [result["webTitle"] for result in results] 34 | 35 | print("Title of content {titles}" .format(titles=webTitles)) 36 | 37 | """ 38 | Print 39 | 40 | 1. the total number of content items. 41 | 2. web titles of 15 most recent items. 42 | 43 | """ 44 | 45 | olympic_header = { 46 | "q": "olympic", 47 | "from-date": "2010-08-08", 48 | "order-by": "newest" 49 | } 50 | 51 | olympic_content = theguardian_content.Content(api="test", **olympic_header) 52 | olympic_response_headers = olympic_content.response_headers() 53 | 54 | print("Total number of content items {total}." 55 | .format(total=olympic_response_headers["total"])) 56 | -------------------------------------------------------------------------------- /examples/tag_and_content.py: -------------------------------------------------------------------------------- 1 | """ 2 | This example deals with returning content of specific tags. 3 | """ 4 | from theguardian import theguardian_tag 5 | from theguardian import theguardian_content 6 | 7 | 8 | # get the apple tags 9 | headers = { 10 | "q": "apple", 11 | "section": "technology", 12 | "show-references": "all", 13 | } 14 | tag = theguardian_tag.Tag(api='test', **headers) 15 | 16 | # get the results 17 | tag_content = tag.get_content_response() 18 | results = tag.get_results(tag_content) 19 | 20 | # get results for specific tag 21 | first_tag_apiUrl = results[0]["apiUrl"] 22 | 23 | # use this api url to content 24 | content = theguardian_content.Content(api='test', url=first_tag_apiUrl) 25 | 26 | # get content response 27 | content_response = content.get_content_response() 28 | print(content_response) 29 | -------------------------------------------------------------------------------- /examples/tags_basic.py: -------------------------------------------------------------------------------- 1 | """ 2 | This example deals with returning references of specific tags. 3 | """ 4 | from theguardian import theguardian_tag 5 | 6 | header = { 7 | "q": "apple", 8 | "section": "technology", 9 | } 10 | t = theguardian_tag.Tag("test", **header) 11 | print(t.get_references_in_page(1)) 12 | -------------------------------------------------------------------------------- /examples/tags_example.py: -------------------------------------------------------------------------------- 1 | """ 2 | 1. Get total number of available tags. 3 | 2. print first 15 web title for tags of type 'contributor' 4 | """ 5 | from theguardian import theguardian_tag 6 | 7 | 8 | # 1. 9 | tag = theguardian_tag.Tag(api="test") 10 | tag_response_headers = tag.response_headers() 11 | print("Total number of tags: {tags_count}." 12 | .format(tags_count=tag_response_headers["total"])) 13 | 14 | # 2. 15 | headers = { 16 | "type": "contributor", 17 | "order-by": "newest", 18 | "page-size": 15, 19 | } 20 | tag_contributor = theguardian_tag.Tag(api="test", **headers) 21 | tag_contributor_data = tag_contributor.get_content_response() 22 | results = tag_contributor.get_results(tag_contributor_data) 23 | 24 | webTitles = [result["webUrl"] for result in results] 25 | print("Web Tiles {title}." .format(title=webTitles)) 26 | -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | requests==2.22.0 2 | -------------------------------------------------------------------------------- /test.py: -------------------------------------------------------------------------------- 1 | from unittest import main 2 | 3 | 4 | def load_tests(loader, standard_tests, pattern): 5 | """ 6 | :param loader: 7 | :param standard_tests: 8 | :param pattern: 9 | :return: 10 | """ 11 | 12 | package_tests = loader.discover(start_dir="tests", pattern="test_*.py") 13 | standard_tests.addTests(package_tests) 14 | 15 | return standard_tests 16 | 17 | 18 | if __name__ == '__main__': 19 | main() 20 | -------------------------------------------------------------------------------- /tests/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/prabhath6/theguardian-api-python/1cdf71831bd935453df9239f4e72f2fe1c44da95/tests/__init__.py -------------------------------------------------------------------------------- /tests/test_content.py: -------------------------------------------------------------------------------- 1 | """ 2 | Tests for the theguardian_content.py 3 | """ 4 | 5 | import unittest 6 | from theguardian import theguardian_content 7 | 8 | 9 | class TestContent(unittest.TestCase): 10 | 11 | """ 12 | Mainly built to test the functionality 13 | of the theguardian_content module. 14 | """ 15 | 16 | def test_content_response_success_correct_details(self): 17 | 18 | api_key = "test" 19 | res = theguardian_content.Content(api_key).get_request_response() 20 | self.assertEqual(res.status_code, 200) 21 | 22 | def test_content_response_failure_incorrect_api_key(self): 23 | 24 | api_key = "tests" 25 | res = theguardian_content.Content(api_key).get_request_response() 26 | self.assertEqual(res.status_code, 403) 27 | 28 | def test_content_response_header(self): 29 | 30 | api_key = "test" 31 | res = theguardian_content.Content(api_key).response_headers() 32 | 33 | self.assertIs(type(res), dict) 34 | self.assertIn("pageSize", res.keys()) 35 | self.assertIn("currentPage", res.keys()) 36 | self.assertIn("pages", res.keys()) 37 | self.assertNotIn("results", res.keys()) 38 | 39 | def test_contents_find_by_id_correct_url(self): 40 | 41 | api_key = "test" 42 | ids = "technology/2014/feb/17/flappy-bird-clones-apple-google" 43 | res = theguardian_content.Content(api_key).find_by_id(ids) 44 | 45 | self.assertIs(type(res), dict) 46 | self.assertEqual(res['response']['results'][0]["id"], ids) 47 | 48 | def test_contents_find_by_id_incorrect_url(self): 49 | 50 | api_key = "test" 51 | ids = "technology/2014/feb/17/flappy-bird-clones-apple" 52 | res = theguardian_content.Content(api_key).find_by_id(ids) 53 | 54 | self.assertEqual(res['response']['results'], []) 55 | self.assertEqual(res['response']['pages'], 0) 56 | self.assertEqual(res['response']['total'], 0) 57 | 58 | def test_content_results(self): 59 | 60 | api_key = "test" 61 | ids = "technology/2014/feb/17/flappy-bird-clones-apple-google" 62 | content = theguardian_content.Content(api_key) 63 | res = content.find_by_id(ids) 64 | result = content.get_results(res) 65 | 66 | self.assertIs(type(result), list) 67 | self.assertEqual(result[0]['id'], ids) 68 | 69 | def test_content_with_headers(self): 70 | 71 | headers = { 72 | "q": "12 years a slave", 73 | "tag": "film/film,tone/reviews", 74 | "from-date": "2010-01-01", 75 | "order-by": "relevance", 76 | "show-fields": "starRating,headline,thumbnail,short-url", 77 | } 78 | content = theguardian_content.Content(api='test', **headers) 79 | res = content.get_content_response() 80 | result = content.get_results(res) 81 | 82 | self.assertIs(type(result), list) 83 | 84 | def test_content_get_result_with_exception(self): 85 | 86 | api_key = "test" 87 | section = theguardian_content.Content(api_key) 88 | 89 | self.assertRaises(TypeError, section.get_results, "some random text") 90 | 91 | def test_section_get_references_correct_pages(self): 92 | 93 | api_key = "test" 94 | content = theguardian_content.Content(api_key, **{ 95 | "q": "apple", 96 | "section": "technology", 97 | }) 98 | refs = content.get_references_in_page(page_number=1) 99 | refs2 = content.get_references_in_page() 100 | 101 | self.assertIs(type(refs), list) 102 | self.assertIs(type(refs2), list) 103 | 104 | def test_section_get_references_incorrect_pages(self): 105 | 106 | api_key = "test" 107 | content = theguardian_content.Content(api_key, **{ 108 | "q": "apple", 109 | "section": "technology", 110 | }) 111 | 112 | head = content.response_headers() 113 | 114 | self.assertRaises(ValueError, content.get_references_in_page, page_number=head["pages"] + 1) 115 | 116 | if __name__ == "__main__": 117 | unittest.main() 118 | -------------------------------------------------------------------------------- /tests/test_edition.py: -------------------------------------------------------------------------------- 1 | """ 2 | Tests for the theguardian_edition.py 3 | """ 4 | import unittest 5 | from theguardian import theguardian_edition 6 | 7 | 8 | class TestEdition(unittest.TestCase): 9 | 10 | """ 11 | Mainly built to test the functionality 12 | of the theguardian_edition module. 13 | """ 14 | 15 | def test_edition_response_success_correct_details(self): 16 | 17 | api_key = "test" 18 | res = theguardian_edition.Edition(api_key).get_request_response() 19 | 20 | self.assertEqual(res.status_code, 200) 21 | 22 | def test_edition_response_failure_incorrect_api_key(self): 23 | 24 | api_key = "tests" 25 | res = theguardian_edition.Edition(api_key).get_request_response() 26 | 27 | self.assertEqual(res.status_code, 403) 28 | 29 | def test_edition_get_direct_content(self): 30 | 31 | api_key = "test" 32 | res = theguardian_edition.Edition(api_key).get_content_response() 33 | 34 | self.assertIn("response", res.keys()) 35 | 36 | def test_edition_get_indirect_content(self): 37 | 38 | api_key = "test" 39 | edition = theguardian_edition.Edition(api_key) 40 | res = edition.get_request_response() 41 | edition_content = edition.get_content_response() 42 | 43 | self.assertEqual(res.status_code, 200) 44 | self.assertIn("response", edition_content.keys()) 45 | 46 | def test_edition_get_indirect_content_invalid_credentials(self): 47 | 48 | api_key = "tests" 49 | edition = theguardian_edition.Edition(api_key) 50 | res = edition.get_request_response() 51 | edition_content = edition.get_content_response() 52 | 53 | self.assertEqual(res.status_code, 403) 54 | self.assertIn("message", edition_content.keys()) 55 | self.assertEqual("Invalid authentication credentials", edition_content["message"]) 56 | 57 | def test_edition_get_result_without_exception(self): 58 | 59 | api_key = "test" 60 | edition = theguardian_edition.Edition(api_key) 61 | edition_content = edition.get_content_response() 62 | results = edition.get_results(edition_content) 63 | 64 | self.assertIs(type(results), list) 65 | 66 | def test_edition_get_result_with_exception(self): 67 | 68 | api_key = "test" 69 | edition = theguardian_edition.Edition(api_key) 70 | 71 | self.assertRaises(TypeError, edition.get_results, "some random text") 72 | 73 | def test_edition_url(self): 74 | 75 | api_key = "test" 76 | edition = theguardian_edition.Edition(api_key) 77 | edition_request_content = edition.get_request_response() 78 | 79 | self.assertEqual(edition.base_url, edition_request_content.url.split("?")[0]) 80 | 81 | def test_edition_get_response_section_count(self): 82 | 83 | api_key = "test" 84 | edition = theguardian_edition.Edition(api_key) 85 | edition_content = edition.get_content_response() 86 | total = edition_content['response']['total'] 87 | result_len = len(edition_content['response']['results']) 88 | 89 | self.assertEqual(total, result_len) 90 | 91 | if __name__ == '__main__': 92 | unittest.main() 93 | -------------------------------------------------------------------------------- /tests/test_section.py: -------------------------------------------------------------------------------- 1 | """ 2 | Tests for the theguardian_section.py 3 | """ 4 | 5 | import unittest 6 | from theguardian import theguardian_section 7 | 8 | 9 | class TestSection(unittest.TestCase): 10 | 11 | """ 12 | Mainly built to test the functionality 13 | of the theguardian_section module. 14 | """ 15 | 16 | def test_section_response_success_correct_details(self): 17 | 18 | api_key = "test" 19 | res = theguardian_section.Section(api_key).get_request_response() 20 | 21 | self.assertEqual(res.status_code, 200) 22 | 23 | def test_section_response_failure_incorrect_api_key(self): 24 | 25 | api_key = "tests" 26 | res = theguardian_section.Section(api_key).get_request_response() 27 | 28 | self.assertEqual(res.status_code, 403) 29 | 30 | def test_section_get_direct_content(self): 31 | 32 | api_key = "test" 33 | res = theguardian_section.Section(api_key).get_content_response() 34 | 35 | self.assertIn("response", res.keys()) 36 | 37 | def test_section_get_indirect_content(self): 38 | 39 | api_key = "test" 40 | section = theguardian_section.Section(api_key) 41 | res = section.get_request_response() 42 | section_content = section.get_content_response() 43 | 44 | self.assertEqual(res.status_code, 200) 45 | self.assertIn("response", section_content.keys()) 46 | 47 | def test_section_get_indirect_content_invalid_credentials(self): 48 | 49 | api_key = "tests" 50 | section = theguardian_section.Section(api_key) 51 | res = section.get_request_response() 52 | section_content = section.get_content_response() 53 | 54 | self.assertEqual(res.status_code, 403) 55 | self.assertIn("message", section_content.keys()) 56 | self.assertEqual("Invalid authentication credentials", section_content["message"]) 57 | 58 | def test_section_get_result_without_exception(self): 59 | 60 | api_key = "test" 61 | section = theguardian_section.Section(api_key) 62 | section_content = section.get_content_response() 63 | results = section.get_results(section_content) 64 | 65 | self.assertIs(type(results), list) 66 | self.assertIn("editions", results[0].keys()) 67 | 68 | def test_section_get_result_with_exception(self): 69 | 70 | api_key = "test" 71 | section = theguardian_section.Section(api_key) 72 | 73 | self.assertRaises(TypeError, section.get_results, "some random text") 74 | 75 | if __name__ == "__main__": 76 | unittest.main() 77 | -------------------------------------------------------------------------------- /tests/test_tag.py: -------------------------------------------------------------------------------- 1 | """ 2 | Tests for the theguardian_tag.py 3 | """ 4 | import unittest 5 | from theguardian import theguardian_tag 6 | 7 | 8 | class TestTag(unittest.TestCase): 9 | 10 | """ 11 | Mainly built to test the functionality 12 | of the theguardian_tag module. 13 | """ 14 | 15 | def test_tag_response_success_correct_details(self): 16 | 17 | api_key = "test" 18 | res = theguardian_tag.Tag(api_key).get_request_response() 19 | 20 | self.assertEqual(res.status_code, 200) 21 | 22 | def test_tag_response_failure_incorrect_api_key(self): 23 | 24 | api_key = "tests" 25 | res = theguardian_tag.Tag(api_key).get_request_response() 26 | 27 | self.assertEqual(res.status_code, 403) 28 | 29 | def test_tag_get_direct_content(self): 30 | 31 | api_key = "test" 32 | res = theguardian_tag.Tag(api_key).get_content_response() 33 | 34 | self.assertIn("response", res.keys()) 35 | 36 | def test_tag_get_indirect_content(self): 37 | 38 | api_key = "test" 39 | tag = theguardian_tag.Tag(api_key) 40 | res = tag.get_request_response() 41 | tag_content = tag.get_content_response() 42 | 43 | self.assertEqual(res.status_code, 200) 44 | self.assertIn("response", tag_content.keys()) 45 | 46 | def test_tag_get_indirect_content_invalid_credentials(self): 47 | 48 | api_key = "tests" 49 | tag = theguardian_tag.Tag(api_key) 50 | res = tag.get_request_response() 51 | tag_content = tag.get_content_response() 52 | 53 | self.assertEqual(res.status_code, 403) 54 | self.assertIn("message", tag_content.keys()) 55 | self.assertEqual("Invalid authentication credentials", tag_content["message"]) 56 | 57 | def test_tag_get_result_without_exception(self): 58 | 59 | api_key = "test" 60 | tag = theguardian_tag.Tag(api_key) 61 | tag_content = tag.get_content_response() 62 | results = tag.get_results(tag_content) 63 | 64 | self.assertIs(type(results), list) 65 | 66 | def test_tag_get_result_with_exception(self): 67 | 68 | api_key = "test" 69 | tag = theguardian_tag.Tag(api_key) 70 | 71 | self.assertRaises(TypeError, tag.get_results, "some random text") 72 | 73 | def test_tag_url(self): 74 | 75 | api_key = "test" 76 | tag = theguardian_tag.Tag(api_key) 77 | tag_request_content = tag.get_request_response() 78 | 79 | self.assertEqual(tag.base_url, tag_request_content.url.split("?")[0]) 80 | 81 | def test_section_get_references_correct_pages(self): 82 | 83 | api_key = "test" 84 | tag = theguardian_tag.Tag(api_key, **{ 85 | "q": "apple", 86 | "section": "technology", 87 | }) 88 | refs = tag.get_references_in_page(page_number=1) 89 | refs2 = tag.get_references_in_page() 90 | 91 | self.assertIs(type(refs), list) 92 | self.assertIs(type(refs2), list) 93 | 94 | def test_section_get_references_incorrect_pages(self): 95 | 96 | api_key = "test" 97 | tag = theguardian_tag.Tag(api_key, **{ 98 | "q": "apple", 99 | "section": "technology", 100 | }) 101 | 102 | head = tag.response_headers() 103 | 104 | self.assertRaises(ValueError, tag.get_references_in_page, page_number=head["pages"] + 1) 105 | 106 | if __name__ == '__main__': 107 | unittest.main() 108 | -------------------------------------------------------------------------------- /theguardian/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/prabhath6/theguardian-api-python/1cdf71831bd935453df9239f4e72f2fe1c44da95/theguardian/__init__.py -------------------------------------------------------------------------------- /theguardian/theguardian_content.py: -------------------------------------------------------------------------------- 1 | """ 2 | The content endpoint (/search) returns 3 | all pieces of content in the API. 4 | """ 5 | import requests 6 | import copy 7 | 8 | 9 | class Content: 10 | 11 | def __init__(self, api, url=None, **kwargs): 12 | """ 13 | :param api: api_key 14 | :param url: optional url to get the content. 15 | :param kwargs: optional header data 16 | :return: None 17 | """ 18 | 19 | self.__headers = { 20 | "api-key": api, 21 | "format": "json" 22 | } 23 | self.__request_response = None 24 | 25 | if url is None: 26 | self.base_url = "https://content.guardianapis.com/search" 27 | else: 28 | self.base_url = url 29 | 30 | if kwargs: 31 | for key, value in kwargs.items(): 32 | self.__headers[key] = value 33 | 34 | def __response(self, headers=None): 35 | 36 | """ 37 | :param headers: optional header 38 | :return: returns raw response. 39 | """ 40 | 41 | if headers is None: 42 | headers = self.__headers 43 | else: 44 | headers.update(self.__headers) 45 | 46 | res = requests.get(self.base_url, headers) 47 | 48 | return res 49 | 50 | def get_request_response(self, headers=None): 51 | 52 | """ 53 | :param headers: optional headers 54 | :return: raw request response 55 | """ 56 | 57 | self.__request_response = self.__response(headers) 58 | return self.__request_response 59 | 60 | def get_content_response(self, headers=None): 61 | 62 | """ 63 | :param headers: optional header 64 | :return: json content of the response for the request 65 | """ 66 | 67 | self.get_request_response(headers) 68 | return self.__request_response.json() 69 | 70 | def response_headers(self, headers=None): 71 | 72 | """ 73 | :param headers: optional header 74 | :return: dict of header contents in the response 75 | """ 76 | 77 | if self.__request_response: 78 | response_content = copy.deepcopy(self.__request_response.json()) 79 | else: 80 | self.get_request_response(headers) 81 | response_content = copy.deepcopy(self.__request_response.json()) 82 | 83 | headers_content = response_content['response'] 84 | headers_content.pop("results") 85 | 86 | return headers_content 87 | 88 | def find_by_id(self, ids, **kwargs): 89 | 90 | """ 91 | :param ids: Get the Content using its id. IDs are usually in the form 92 | of url/section/YYYY/month/DD/name-of-article/ 93 | technology/2014/feb/17/flappy-bird-clones-apple-google 94 | 95 | :param kwargs: optional headers 96 | :return: dict 97 | """ 98 | 99 | ids_and_options = self.__response_for_id(ids, **kwargs) 100 | ids_and_options.update(self.__headers) 101 | 102 | return self.__response(ids_and_options).json() 103 | 104 | @staticmethod 105 | def __response_for_id(ids, **kwargs): 106 | 107 | """ 108 | :param ids: IDs are usually in the form 109 | of url/section/YYYY/month/DD/name-of-article/ 110 | 111 | :param kwargs: optional headers 112 | :return: dict 113 | """ 114 | 115 | headers = {} 116 | 117 | if ids and isinstance(ids, str): 118 | headers["ids"] = ids 119 | if kwargs: 120 | headers.update(kwargs) 121 | 122 | return headers 123 | 124 | @staticmethod 125 | def get_results(content): 126 | 127 | """ 128 | :param content: response from url 129 | :return: list of results 130 | """ 131 | 132 | if isinstance(content, dict): 133 | results = content["response"]["results"] 134 | else: 135 | raise TypeError("Content of type dictionary required as input.") 136 | 137 | return results if results else [] 138 | 139 | def get_references_in_page(self, page_number=None): 140 | 141 | """ 142 | :param page_number: optional 143 | :return: 144 | """ 145 | 146 | head = self.response_headers() 147 | 148 | if page_number is None: 149 | content = self.get_content_response({ 150 | "show-references": "all" 151 | }) 152 | results = self.get_results(content) 153 | references = self.__get_references(results) 154 | return references 155 | elif page_number and page_number <= head["pages"]: 156 | content = self.get_content_response({ 157 | "page": page_number, 158 | "show-references": "all" 159 | }) 160 | results = self.get_results(content) 161 | references = self.__get_references(results) 162 | return references 163 | else: 164 | raise ValueError("Page number greater than available pages. Available pages {}." 165 | .format(head["pages"])) 166 | 167 | @staticmethod 168 | def __get_references(results): 169 | 170 | """ 171 | :param results: list of results 172 | :return: list of results 173 | """ 174 | 175 | refs = [(result["id"], result["references"]) for result in results if result["references"]] 176 | 177 | return refs 178 | -------------------------------------------------------------------------------- /theguardian/theguardian_edition.py: -------------------------------------------------------------------------------- 1 | """ 2 | The edition endpoint returns all editions in the API. 3 | """ 4 | from theguardian import theguardian_section 5 | 6 | 7 | class Edition(theguardian_section.Section): 8 | 9 | def __init__(self, api, **kwargs): 10 | 11 | """ 12 | :param api: api-key 13 | :param kwargs: optional headers 14 | :return: 15 | """ 16 | base_url = "https://content.guardianapis.com/editions" 17 | super(Edition, self).__init__(api, base_url, **kwargs) 18 | -------------------------------------------------------------------------------- /theguardian/theguardian_section.py: -------------------------------------------------------------------------------- 1 | """ 2 | The sections endpoint(/sections) returns all sections in the API. 3 | """ 4 | import requests 5 | import copy 6 | 7 | 8 | class Section: 9 | 10 | def __init__(self, api, url=None, **kwargs): 11 | 12 | """ 13 | :param api: api-key 14 | :param kwargs: optional headers 15 | :return: 16 | """ 17 | 18 | self.__request_response = None 19 | self.__headers = { 20 | "api-key": api, 21 | "format": "json" 22 | } 23 | 24 | if not url: 25 | self.base_url = "https://content.guardianapis.com/sections" 26 | else: 27 | self.base_url = url 28 | 29 | if kwargs: 30 | for key, value in kwargs.items(): 31 | self.__headers[key] = value 32 | 33 | def __response(self, header=None): 34 | 35 | """ 36 | :param header: optional headers 37 | :return: raw request response 38 | """ 39 | 40 | if header is None: 41 | header = self.__headers 42 | else: 43 | header.update(self.__headers) 44 | res = requests.get(self.base_url, header) 45 | 46 | return res 47 | 48 | def get_request_response(self, headers=None): 49 | 50 | """ 51 | :param headers: optional headers 52 | :return: raw section request response 53 | """ 54 | 55 | self.__request_response = self.__response(headers) 56 | return self.__request_response 57 | 58 | def get_content_response(self, headers=None): 59 | 60 | """ 61 | :param headers: optional headers 62 | :return: dict of response 63 | """ 64 | 65 | if self.__request_response is None or headers: 66 | self.__request_response = self.get_request_response(headers) 67 | 68 | return self.__request_response.json() 69 | 70 | @staticmethod 71 | def get_results(section_content): 72 | 73 | """ 74 | :param section_content: dict of response received 75 | :return: list of results in that page 76 | """ 77 | 78 | if isinstance(section_content, dict): 79 | results = section_content["response"]["results"] 80 | else: 81 | raise TypeError("Section content of type dictionary required as input.") 82 | 83 | return results if results else [] 84 | 85 | def response_headers(self, headers=None): 86 | 87 | """ 88 | :param headers: optional header 89 | :return: dict of header contents in the response 90 | """ 91 | 92 | if self.__request_response: 93 | response_content = copy.deepcopy(self.__request_response.json()) 94 | else: 95 | self.get_request_response(headers) 96 | response_content = copy.deepcopy(self.__request_response.json()) 97 | 98 | headers_content = response_content['response'] 99 | headers_content.pop("results") 100 | 101 | return headers_content 102 | -------------------------------------------------------------------------------- /theguardian/theguardian_tag.py: -------------------------------------------------------------------------------- 1 | """ 2 | The tags endpoint (/tags) returns all tags in the API. 3 | All Guardian content is manually categorised using these 4 | tags, of which there are more than 50,000 5 | """ 6 | from theguardian import theguardian_section 7 | 8 | 9 | class Tag(theguardian_section.Section): 10 | 11 | def __init__(self, api, **kwargs): 12 | 13 | """ 14 | :param api: api-key 15 | :param kwargs: optional headers 16 | :return: 17 | """ 18 | base_url = "https://content.guardianapis.com/tags" 19 | super(Tag, self).__init__(api, base_url, **kwargs) 20 | 21 | def get_references_in_page(self, page_number=1): 22 | 23 | """ 24 | :param page_number: optional 25 | :return: 26 | """ 27 | 28 | head = self.response_headers() 29 | 30 | if page_number is None: 31 | content = self.get_content_response({ 32 | "show-references": "all" 33 | }) 34 | results = self.get_results(content) 35 | references = self.__get_references(results) 36 | return references 37 | elif page_number and page_number <= head["pages"]: 38 | content = self.get_content_response({ 39 | "page": page_number, 40 | "show-references": "all" 41 | }) 42 | results = self.get_results(content) 43 | references = self.__get_references(results) 44 | return references 45 | else: 46 | raise ValueError("Page number greater than available pages. Available pages {}." 47 | .format(head["pages"])) 48 | 49 | @staticmethod 50 | def __get_references(results): 51 | 52 | """ 53 | :param results: list of results 54 | :return: list of results 55 | """ 56 | 57 | refs = [(result["id"], result["references"]) for result in results if result["references"]] 58 | 59 | return refs 60 | --------------------------------------------------------------------------------