././@PaxHeader0000000000000000000000000000003400000000000011452 xustar000000000000000028 mtime=1426442512.8271773 goobook-3.5.2/LICENSE.txt0000644000000000000000000010451300000000000013136 0ustar0000000000000000 GNU GENERAL PUBLIC LICENSE Version 3, 29 June 2007 Copyright (C) 2007 Free Software Foundation, Inc. Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Preamble The GNU General Public License is a free, copyleft license for software and other kinds of works. The licenses for most software and other practical works are designed to take away your freedom to share and change the works. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change all versions of a program--to make sure it remains free software for all its users. We, the Free Software Foundation, use the GNU General Public License for most of our software; it applies also to any other work released this way by its authors. You can apply it to your programs, too. When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for them if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs, and that you know you can do these things. To protect your rights, we need to prevent others from denying you these rights or asking you to surrender the rights. Therefore, you have certain responsibilities if you distribute copies of the software, or if you modify it: responsibilities to respect the freedom of others. For example, if you distribute copies of such a program, whether gratis or for a fee, you must pass on to the recipients the same freedoms that you received. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights. Developers that use the GNU GPL protect your rights with two steps: (1) assert copyright on the software, and (2) offer you this License giving you legal permission to copy, distribute and/or modify it. For the developers' and authors' protection, the GPL clearly explains that there is no warranty for this free software. For both users' and authors' sake, the GPL requires that modified versions be marked as changed, so that their problems will not be attributed erroneously to authors of previous versions. Some devices are designed to deny users access to install or run modified versions of the software inside them, although the manufacturer can do so. This is fundamentally incompatible with the aim of protecting users' freedom to change the software. The systematic pattern of such abuse occurs in the area of products for individuals to use, which is precisely where it is most unacceptable. Therefore, we have designed this version of the GPL to prohibit the practice for those products. If such problems arise substantially in other domains, we stand ready to extend this provision to those domains in future versions of the GPL, as needed to protect the freedom of users. Finally, every program is threatened constantly by software patents. States should not allow patents to restrict development and use of software on general-purpose computers, but in those that do, we wish to avoid the special danger that patents applied to a free program could make it effectively proprietary. To prevent this, the GPL assures that patents cannot be used to render the program non-free. The precise terms and conditions for copying, distribution and modification follow. TERMS AND CONDITIONS 0. Definitions. "This License" refers to version 3 of the GNU General Public License. "Copyright" also means copyright-like laws that apply to other kinds of works, such as semiconductor masks. "The Program" refers to any copyrightable work licensed under this License. Each licensee is addressed as "you". "Licensees" and "recipients" may be individuals or organizations. To "modify" a work means to copy from or adapt all or part of the work in a fashion requiring copyright permission, other than the making of an exact copy. The resulting work is called a "modified version" of the earlier work or a work "based on" the earlier work. A "covered work" means either the unmodified Program or a work based on the Program. To "propagate" a work means to do anything with it that, without permission, would make you directly or secondarily liable for infringement under applicable copyright law, except executing it on a computer or modifying a private copy. Propagation includes copying, distribution (with or without modification), making available to the public, and in some countries other activities as well. To "convey" a work means any kind of propagation that enables other parties to make or receive copies. Mere interaction with a user through a computer network, with no transfer of a copy, is not conveying. An interactive user interface displays "Appropriate Legal Notices" to the extent that it includes a convenient and prominently visible feature that (1) displays an appropriate copyright notice, and (2) tells the user that there is no warranty for the work (except to the extent that warranties are provided), that licensees may convey the work under this License, and how to view a copy of this License. If the interface presents a list of user commands or options, such as a menu, a prominent item in the list meets this criterion. 1. Source Code. The "source code" for a work means the preferred form of the work for making modifications to it. "Object code" means any non-source form of a work. A "Standard Interface" means an interface that either is an official standard defined by a recognized standards body, or, in the case of interfaces specified for a particular programming language, one that is widely used among developers working in that language. The "System Libraries" of an executable work include anything, other than the work as a whole, that (a) is included in the normal form of packaging a Major Component, but which is not part of that Major Component, and (b) serves only to enable use of the work with that Major Component, or to implement a Standard Interface for which an implementation is available to the public in source code form. A "Major Component", in this context, means a major essential component (kernel, window system, and so on) of the specific operating system (if any) on which the executable work runs, or a compiler used to produce the work, or an object code interpreter used to run it. The "Corresponding Source" for a work in object code form means all the source code needed to generate, install, and (for an executable work) run the object code and to modify the work, including scripts to control those activities. However, it does not include the work's System Libraries, or general-purpose tools or generally available free programs which are used unmodified in performing those activities but which are not part of the work. For example, Corresponding Source includes interface definition files associated with source files for the work, and the source code for shared libraries and dynamically linked subprograms that the work is specifically designed to require, such as by intimate data communication or control flow between those subprograms and other parts of the work. The Corresponding Source need not include anything that users can regenerate automatically from other parts of the Corresponding Source. The Corresponding Source for a work in source code form is that same work. 2. Basic Permissions. All rights granted under this License are granted for the term of copyright on the Program, and are irrevocable provided the stated conditions are met. This License explicitly affirms your unlimited permission to run the unmodified Program. The output from running a covered work is covered by this License only if the output, given its content, constitutes a covered work. This License acknowledges your rights of fair use or other equivalent, as provided by copyright law. You may make, run and propagate covered works that you do not convey, without conditions so long as your license otherwise remains in force. You may convey covered works to others for the sole purpose of having them make modifications exclusively for you, or provide you with facilities for running those works, provided that you comply with the terms of this License in conveying all material for which you do not control copyright. Those thus making or running the covered works for you must do so exclusively on your behalf, under your direction and control, on terms that prohibit them from making any copies of your copyrighted material outside their relationship with you. Conveying under any other circumstances is permitted solely under the conditions stated below. Sublicensing is not allowed; section 10 makes it unnecessary. 3. Protecting Users' Legal Rights From Anti-Circumvention Law. No covered work shall be deemed part of an effective technological measure under any applicable law fulfilling obligations under article 11 of the WIPO copyright treaty adopted on 20 December 1996, or similar laws prohibiting or restricting circumvention of such measures. When you convey a covered work, you waive any legal power to forbid circumvention of technological measures to the extent such circumvention is effected by exercising rights under this License with respect to the covered work, and you disclaim any intention to limit operation or modification of the work as a means of enforcing, against the work's users, your or third parties' legal rights to forbid circumvention of technological measures. 4. Conveying Verbatim Copies. You may convey verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice; keep intact all notices stating that this License and any non-permissive terms added in accord with section 7 apply to the code; keep intact all notices of the absence of any warranty; and give all recipients a copy of this License along with the Program. You may charge any price or no price for each copy that you convey, and you may offer support or warranty protection for a fee. 5. Conveying Modified Source Versions. You may convey a work based on the Program, or the modifications to produce it from the Program, in the form of source code under the terms of section 4, provided that you also meet all of these conditions: a) The work must carry prominent notices stating that you modified it, and giving a relevant date. b) The work must carry prominent notices stating that it is released under this License and any conditions added under section 7. This requirement modifies the requirement in section 4 to "keep intact all notices". c) You must license the entire work, as a whole, under this License to anyone who comes into possession of a copy. This License will therefore apply, along with any applicable section 7 additional terms, to the whole of the work, and all its parts, regardless of how they are packaged. This License gives no permission to license the work in any other way, but it does not invalidate such permission if you have separately received it. d) If the work has interactive user interfaces, each must display Appropriate Legal Notices; however, if the Program has interactive interfaces that do not display Appropriate Legal Notices, your work need not make them do so. A compilation of a covered work with other separate and independent works, which are not by their nature extensions of the covered work, and which are not combined with it such as to form a larger program, in or on a volume of a storage or distribution medium, is called an "aggregate" if the compilation and its resulting copyright are not used to limit the access or legal rights of the compilation's users beyond what the individual works permit. Inclusion of a covered work in an aggregate does not cause this License to apply to the other parts of the aggregate. 6. Conveying Non-Source Forms. You may convey a covered work in object code form under the terms of sections 4 and 5, provided that you also convey the machine-readable Corresponding Source under the terms of this License, in one of these ways: a) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by the Corresponding Source fixed on a durable physical medium customarily used for software interchange. b) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by a written offer, valid for at least three years and valid for as long as you offer spare parts or customer support for that product model, to give anyone who possesses the object code either (1) a copy of the Corresponding Source for all the software in the product that is covered by this License, on a durable physical medium customarily used for software interchange, for a price no more than your reasonable cost of physically performing this conveying of source, or (2) access to copy the Corresponding Source from a network server at no charge. c) Convey individual copies of the object code with a copy of the written offer to provide the Corresponding Source. This alternative is allowed only occasionally and noncommercially, and only if you received the object code with such an offer, in accord with subsection 6b. d) Convey the object code by offering access from a designated place (gratis or for a charge), and offer equivalent access to the Corresponding Source in the same way through the same place at no further charge. You need not require recipients to copy the Corresponding Source along with the object code. If the place to copy the object code is a network server, the Corresponding Source may be on a different server (operated by you or a third party) that supports equivalent copying facilities, provided you maintain clear directions next to the object code saying where to find the Corresponding Source. Regardless of what server hosts the Corresponding Source, you remain obligated to ensure that it is available for as long as needed to satisfy these requirements. e) Convey the object code using peer-to-peer transmission, provided you inform other peers where the object code and Corresponding Source of the work are being offered to the general public at no charge under subsection 6d. A separable portion of the object code, whose source code is excluded from the Corresponding Source as a System Library, need not be included in conveying the object code work. A "User Product" is either (1) a "consumer product", which means any tangible personal property which is normally used for personal, family, or household purposes, or (2) anything designed or sold for incorporation into a dwelling. In determining whether a product is a consumer product, doubtful cases shall be resolved in favor of coverage. For a particular product received by a particular user, "normally used" refers to a typical or common use of that class of product, regardless of the status of the particular user or of the way in which the particular user actually uses, or expects or is expected to use, the product. A product is a consumer product regardless of whether the product has substantial commercial, industrial or non-consumer uses, unless such uses represent the only significant mode of use of the product. "Installation Information" for a User Product means any methods, procedures, authorization keys, or other information required to install and execute modified versions of a covered work in that User Product from a modified version of its Corresponding Source. The information must suffice to ensure that the continued functioning of the modified object code is in no case prevented or interfered with solely because modification has been made. If you convey an object code work under this section in, or with, or specifically for use in, a User Product, and the conveying occurs as part of a transaction in which the right of possession and use of the User Product is transferred to the recipient in perpetuity or for a fixed term (regardless of how the transaction is characterized), the Corresponding Source conveyed under this section must be accompanied by the Installation Information. But this requirement does not apply if neither you nor any third party retains the ability to install modified object code on the User Product (for example, the work has been installed in ROM). The requirement to provide Installation Information does not include a requirement to continue to provide support service, warranty, or updates for a work that has been modified or installed by the recipient, or for the User Product in which it has been modified or installed. Access to a network may be denied when the modification itself materially and adversely affects the operation of the network or violates the rules and protocols for communication across the network. Corresponding Source conveyed, and Installation Information provided, in accord with this section must be in a format that is publicly documented (and with an implementation available to the public in source code form), and must require no special password or key for unpacking, reading or copying. 7. Additional Terms. "Additional permissions" are terms that supplement the terms of this License by making exceptions from one or more of its conditions. Additional permissions that are applicable to the entire Program shall be treated as though they were included in this License, to the extent that they are valid under applicable law. If additional permissions apply only to part of the Program, that part may be used separately under those permissions, but the entire Program remains governed by this License without regard to the additional permissions. When you convey a copy of a covered work, you may at your option remove any additional permissions from that copy, or from any part of it. (Additional permissions may be written to require their own removal in certain cases when you modify the work.) You may place additional permissions on material, added by you to a covered work, for which you have or can give appropriate copyright permission. Notwithstanding any other provision of this License, for material you add to a covered work, you may (if authorized by the copyright holders of that material) supplement the terms of this License with terms: a) Disclaiming warranty or limiting liability differently from the terms of sections 15 and 16 of this License; or b) Requiring preservation of specified reasonable legal notices or author attributions in that material or in the Appropriate Legal Notices displayed by works containing it; or c) Prohibiting misrepresentation of the origin of that material, or requiring that modified versions of such material be marked in reasonable ways as different from the original version; or d) Limiting the use for publicity purposes of names of licensors or authors of the material; or e) Declining to grant rights under trademark law for use of some trade names, trademarks, or service marks; or f) Requiring indemnification of licensors and authors of that material by anyone who conveys the material (or modified versions of it) with contractual assumptions of liability to the recipient, for any liability that these contractual assumptions directly impose on those licensors and authors. All other non-permissive additional terms are considered "further restrictions" within the meaning of section 10. If the Program as you received it, or any part of it, contains a notice stating that it is governed by this License along with a term that is a further restriction, you may remove that term. If a license document contains a further restriction but permits relicensing or conveying under this License, you may add to a covered work material governed by the terms of that license document, provided that the further restriction does not survive such relicensing or conveying. If you add terms to a covered work in accord with this section, you must place, in the relevant source files, a statement of the additional terms that apply to those files, or a notice indicating where to find the applicable terms. Additional terms, permissive or non-permissive, may be stated in the form of a separately written license, or stated as exceptions; the above requirements apply either way. 8. Termination. You may not propagate or modify a covered work except as expressly provided under this License. Any attempt otherwise to propagate or modify it is void, and will automatically terminate your rights under this License (including any patent licenses granted under the third paragraph of section 11). However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation. Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice. Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, you do not qualify to receive new licenses for the same material under section 10. 9. Acceptance Not Required for Having Copies. You are not required to accept this License in order to receive or run a copy of the Program. Ancillary propagation of a covered work occurring solely as a consequence of using peer-to-peer transmission to receive a copy likewise does not require acceptance. However, nothing other than this License grants you permission to propagate or modify any covered work. These actions infringe copyright if you do not accept this License. Therefore, by modifying or propagating a covered work, you indicate your acceptance of this License to do so. 10. Automatic Licensing of Downstream Recipients. Each time you convey a covered work, the recipient automatically receives a license from the original licensors, to run, modify and propagate that work, subject to this License. You are not responsible for enforcing compliance by third parties with this License. An "entity transaction" is a transaction transferring control of an organization, or substantially all assets of one, or subdividing an organization, or merging organizations. If propagation of a covered work results from an entity transaction, each party to that transaction who receives a copy of the work also receives whatever licenses to the work the party's predecessor in interest had or could give under the previous paragraph, plus a right to possession of the Corresponding Source of the work from the predecessor in interest, if the predecessor has it or can get it with reasonable efforts. You may not impose any further restrictions on the exercise of the rights granted or affirmed under this License. For example, you may not impose a license fee, royalty, or other charge for exercise of rights granted under this License, and you may not initiate litigation (including a cross-claim or counterclaim in a lawsuit) alleging that any patent claim is infringed by making, using, selling, offering for sale, or importing the Program or any portion of it. 11. Patents. A "contributor" is a copyright holder who authorizes use under this License of the Program or a work on which the Program is based. The work thus licensed is called the contributor's "contributor version". A contributor's "essential patent claims" are all patent claims owned or controlled by the contributor, whether already acquired or hereafter acquired, that would be infringed by some manner, permitted by this License, of making, using, or selling its contributor version, but do not include claims that would be infringed only as a consequence of further modification of the contributor version. For purposes of this definition, "control" includes the right to grant patent sublicenses in a manner consistent with the requirements of this License. Each contributor grants you a non-exclusive, worldwide, royalty-free patent license under the contributor's essential patent claims, to make, use, sell, offer for sale, import and otherwise run, modify and propagate the contents of its contributor version. In the following three paragraphs, a "patent license" is any express agreement or commitment, however denominated, not to enforce a patent (such as an express permission to practice a patent or covenant not to sue for patent infringement). To "grant" such a patent license to a party means to make such an agreement or commitment not to enforce a patent against the party. If you convey a covered work, knowingly relying on a patent license, and the Corresponding Source of the work is not available for anyone to copy, free of charge and under the terms of this License, through a publicly available network server or other readily accessible means, then you must either (1) cause the Corresponding Source to be so available, or (2) arrange to deprive yourself of the benefit of the patent license for this particular work, or (3) arrange, in a manner consistent with the requirements of this License, to extend the patent license to downstream recipients. "Knowingly relying" means you have actual knowledge that, but for the patent license, your conveying the covered work in a country, or your recipient's use of the covered work in a country, would infringe one or more identifiable patents in that country that you have reason to believe are valid. If, pursuant to or in connection with a single transaction or arrangement, you convey, or propagate by procuring conveyance of, a covered work, and grant a patent license to some of the parties receiving the covered work authorizing them to use, propagate, modify or convey a specific copy of the covered work, then the patent license you grant is automatically extended to all recipients of the covered work and works based on it. A patent license is "discriminatory" if it does not include within the scope of its coverage, prohibits the exercise of, or is conditioned on the non-exercise of one or more of the rights that are specifically granted under this License. You may not convey a covered work if you are a party to an arrangement with a third party that is in the business of distributing software, under which you make payment to the third party based on the extent of your activity of conveying the work, and under which the third party grants, to any of the parties who would receive the covered work from you, a discriminatory patent license (a) in connection with copies of the covered work conveyed by you (or copies made from those copies), or (b) primarily for and in connection with specific products or compilations that contain the covered work, unless you entered into that arrangement, or that patent license was granted, prior to 28 March 2007. Nothing in this License shall be construed as excluding or limiting any implied license or other defenses to infringement that may otherwise be available to you under applicable patent law. 12. No Surrender of Others' Freedom. If conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot convey a covered work so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not convey it at all. For example, if you agree to terms that obligate you to collect a royalty for further conveying from those to whom you convey the Program, the only way you could satisfy both those terms and this License would be to refrain entirely from conveying the Program. 13. Use with the GNU Affero General Public License. Notwithstanding any other provision of this License, you have permission to link or combine any covered work with a work licensed under version 3 of the GNU Affero General Public License into a single combined work, and to convey the resulting work. The terms of this License will continue to apply to the part which is the covered work, but the special requirements of the GNU Affero General Public License, section 13, concerning interaction through a network will apply to the combination as such. 14. Revised Versions of this License. The Free Software Foundation may publish revised and/or new versions of the GNU General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Program specifies that a certain numbered version of the GNU General Public License "or any later version" applies to it, you have the option of following the terms and conditions either of that numbered version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of the GNU General Public License, you may choose any version ever published by the Free Software Foundation. If the Program specifies that a proxy can decide which future versions of the GNU General Public License can be used, that proxy's public statement of acceptance of a version permanently authorizes you to choose that version for the Program. Later license versions may give you additional or different permissions. However, no additional obligations are imposed on any author or copyright holder as a result of your choosing to follow a later version. 15. Disclaimer of Warranty. THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 16. Limitation of Liability. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. 17. Interpretation of Sections 15 and 16. If the disclaimer of warranty and limitation of liability provided above cannot be given local legal effect according to their terms, reviewing courts shall apply local law that most closely approximates an absolute waiver of all civil liability in connection with the Program, unless a warranty or assumption of liability accompanies a copy of the Program in return for a fee. END OF TERMS AND CONDITIONS How to Apply These Terms to Your New Programs If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms. To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively state the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found. Copyright (C) This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program. If not, see . Also add information on how to contact you by electronic and paper mail. If the program does terminal interaction, make it output a short notice like this when it starts in an interactive mode: Copyright (C) This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. This is free software, and you are welcome to redistribute it under certain conditions; type `show c' for details. The hypothetical commands `show w' and `show c' should show the appropriate parts of the General Public License. Of course, your program's commands might be different; for a GUI interface, you would use an "about box". You should also get your employer (if you work as a programmer) or school, if any, to sign a "copyright disclaimer" for the program, if necessary. For more information on this, and how to apply and follow the GNU GPL, see . The GNU General Public License does not permit incorporating your program into proprietary programs. If your program is a subroutine library, you may consider it more useful to permit linking proprietary applications with the library. If this is what you want to do, use the GNU Lesser General Public License instead of this License. But first, please read . ././@PaxHeader0000000000000000000000000000003400000000000011452 xustar000000000000000028 mtime=1657362368.1581807 goobook-3.5.2/README.rst0000644000000000000000000001411200000000000012775 0ustar0000000000000000::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: GooBook -- Access your Google contacts from the command line. ::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: .. contents:: **Table of Contents** :depth: 1 About ===== The purpose of GooBook is to make it possible to use your Google Contacts from the command-line and from MUAs such as Mutt. It can be used from Mutt the same way as abook. .. NOTE:: GooBook is looking for a new maintainer see https://gitlab.com/goobook/goobook/-/issues/90 Installation Instructions ========================= There is a number of ways to install Python software. - Using pip - Using a source tarball - Using source directly from gitorius - From a distribution specific repository Which version to use -------------------- If you only have Python 2.7 you need to use GooBook 1.x. If you have Python 3.7+ you need to use GooBook 3.x. There will be no further feature releases in the 1.x series. pip --- This is the recommended way to install goobook for most users that don't have it available in their distribution. When installing this way you will not need to download anything manually. Install like this:: $ pip install --user goobook This will install goobook as ~/.local/bin/goobook (In a UNIX environment). Poetry ------ This is the recommended way if you want to run from a git checkout. Install poetry if you don't have it, https://python-poetry.org. clone the git repos, cd into in, and run:: $ poetry install Goobook is now installed in a virtualenv created by poetry. You can test goobook by running:: $ poetry run goobook To locate the virtualenv where goobook is installed:: $ poetry env list --full-path Source installation from tarball -------------------------------- Download the source tarball, uncompress it, then run the install command:: $ tar -xzvf goobook-*.tar.gz $ cd goobook-* $ sudo python ./setup.py install Configuration ============= First you need to authenticate yourself: - Go to https://developers.google.com/people/quickstart/python - and click "Enable the People API" - select a name (ex. GooBook) - select desktop app and create - save the client_id and client_secret to be used below run:: $ goobook authenticate -- CLIENT_ID CLIENT_SECRET and follow the instructions, this part is web based. If the procedure above to get client_id and secret stops working this is an alternative way to do it: - Go to the Google developer console https://console.developers.google.com/ - Create a new project (drop down at the top of the screen) (you are free to use an existing one if you so prefer) - Select the newly created project - Go to OAuth consent screen from sidebar - Select the interal user type if you can but most will only be able to select external. - On next screen give it a name (ex. GooBook) - select Add scope, click manually paste and write "https://www.googleapis.com/auth/contacts" inte the lower text box. - and hit hit add and then save - Go to Credentials from sidebar - Click Create Credentials from top, then OAuth Client ID in the dropdown - Choose Desktop app, enter any name you want, and hit create - save the client_id and client_secret to be used with goobook authenticate To get access too more settings you can create a configuration file:: goobook config-template > ~/.config/goobookrc It will look like this:: # Use this template to create your ~/.goobookrc # "#" or ";" at the start of a line makes it a comment. [DEFAULT] # The following are optional, defaults are shown when not other specified. # This file is written by the oauth library, and should be kept secure, # it's like a password to your google contacts. # default is to place it in the XDG_DATA_HOME ;oauth_db_filename: ~/.goobook_auth.json ;cache_filename: ~/.goobook_cache # default is in the XDG_CACHE_HOME ;cache_expiry_hours: 24 ;filter_groupless_contacts: yes # New contacts will be added to this group in addition to "My Contacts" # Note that the group has to already exist on google or an error will occur. # One use for this is to add new contacts to an "Unsorted" group, which can # be sorted easier than all of "My Contacts". ;default_group: Files ----- GooBook is using three files, the optional config file that can be placed in the ``XDG_CONFIG_HOME`` (``~/.config/goobookrc``) or in the home directory (``~/.goobookrc``). The authentication file that is created by running goobook authenticate in ``XDG_DATA_HOME`` (``~/.local/share/goobook_auth.json``) but can also be placed in the home directory (``~/.goobook_auth.json``). The contacts cache file that is created in ``XDG_CACHE_HOME`` (``~/.cache/goobook_cache``) but can also be placed in the home directory (``~/.goobook_cache``). Proxy settings -------------- If you use a proxy you need to set the ``https_proxy`` environment variable. Mutt ---- If you want to use goobook from mutt. Set in your .muttrc file:: set query_command="goobook query %s" to query address book. (Normally bound to "Q" key.) If you want to be able to use to complete email addresses instead of Ctrl-t add this:: bind editor complete-query To add email addresses (with "a" key normally bound to create-alias command):: macro index,pager a "goobook add" "add the sender address to Google contacts" If you want to add an email's sender to Contacts, press a while it's selected in the index or pager. Usage ===== To query your contacts:: $ goobook query QUERY The add command reads a email from STDIN and adds the From address to your Google contacts:: $ goobook add The cache is updated automatically according to the configuration but you can also force an update:: $ goobook reload For more commands see:: $ goobook -h and:: $ goobook COMMAND -h Links, Feedback and getting involved ==================================== - PyPI home: https://pypi.org/project/goobook/ - Code Repository: http://gitlab.com/goobook/goobook - Issue tracker: https://gitlab.com/goobook/goobook/issues - Mailing list: http://groups.google.com/group/goobook ././@PaxHeader0000000000000000000000000000003400000000000011452 xustar000000000000000028 mtime=1433276509.0109475 goobook-3.5.2/goobook/__init__.py0000644000000000000000000000023200000000000015054 0ustar0000000000000000# -*- coding: UTF-8 -*- # vim: fileencoding=UTF-8 filetype=python ff=unix et ts=4 sw=4 sts=4 tw=120 # author: Christer Sjöholm -- hcs AT furuvik DOT net ././@PaxHeader0000000000000000000000000000003400000000000011452 xustar000000000000000028 mtime=1656502976.8842475 goobook-3.5.2/goobook/application.py0000755000000000000000000002016200000000000015627 0ustar0000000000000000#!/usr/bin/env python # -*- coding: UTF-8 -*- # vim: fileencoding=UTF-8 filetype=python ff=unix et ts=4 sw=4 sts=4 tw=120 # author: Christer Sjöholm -- hcs AT furuvik DOT net import argparse import datetime import locale import logging import pathlib import json import sys import oauth2client.client import oauth2client.file import oauth2client.tools import pkg_resources import goobook.config from goobook.goobook import GooBook, Cache, GoogleContacts, parse_groups, parse_contacts from goobook.storage import unstorageify log = logging.getLogger(__name__) # pylint: disable=invalid-name SCOPES = 'https://www.google.com/m8/feeds' # read/write access to Contacts and Contact Groups AUTHENTICATE_HELP_STRING = '''Google OAuth authentication. Before running goobook authenticate you need a client_id and a client_secret, get it like this: Go to https://developers.google.com/people/quickstart/python and click "Enable the People API" select a name (ex. GooBook) select desktop application save the client_id and client_secret to be used below:: $ goobook authenticate -- CLIENT_ID CLIENT_SECRET and follow the instructions. if it doesn't open a webbrowser use goobook authenticate --noauth_local_webserver -- CLIENT_ID CLIENT_SECRET If you get the page "This app isn't verified" select Advanced and the "Go to GooBook (unsafe)" at the bottom. ''' def main(): locale.setlocale(locale.LC_TIME, '') # Use system configured locale parser = argparse.ArgumentParser(description='Search you Google contacts from mutt or the command-line.') parser.add_argument('-c', '--config', help='Specify alternative configuration file.', metavar="FILE") parser.add_argument('-v', '--verbose', dest="log_level", action='store_const', const=logging.INFO, help='Be verbose about what is going on (stderr).') parser.add_argument('-V', '--version', action='version', version='%%(prog)s %s' % pkg_resources.get_distribution("goobook").version, help="Print version and exit") parser.add_argument('-d', '--debug', dest="log_level", action='store_const', const=logging.DEBUG, help='Output debug info (stderr).') parser.set_defaults(log_level=logging.ERROR) subparsers = parser.add_subparsers() parser_add = subparsers.add_parser('add', description='Create new contact, if name and email is not given the' ' sender of a mail read from stdin will be used.') parser_add.add_argument('name', nargs='?', metavar='NAME', help='Name to use.') parser_add.add_argument('email', nargs='?', metavar='EMAIL', help='E-mail to use.') parser_add.add_argument('phone', nargs='?', metavar='PHONE', help='Phone number to use.') parser_add.set_defaults(func=do_add) parser_config_template = subparsers.add_parser('config-template', description='Prints a template for .goobookrc to stdout') parser_config_template.set_defaults(func=do_config_template) parser_dump_contacts = subparsers.add_parser('dump_contacts', description='Dump contacts as JSON.') parser_dump_contacts.add_argument('-p', '--parse', action='store_true', help='Dump parsed contact instead of raw.') parser_dump_contacts.set_defaults(func=do_dump_contacts) parser_dump_groups = subparsers.add_parser('dump_groups', description='Dump groups as JSON.') parser_dump_groups.add_argument('-p', '--parse', action='store_true', help='Dump parsed contact instead of raw.') parser_dump_groups.set_defaults(func=do_dump_groups) parser_query = subparsers.add_parser('query', description='Search contacts using query (regex).') parser_query.add_argument('-s', '--simple', action='store_true', help='Simple output format instead of mutt compatible') parser_query.add_argument('query', help='regex to search for.', metavar='QUERY') parser_query.set_defaults(func=do_query) parser_query_details = subparsers.add_parser( 'dquery', description='Search contacts using query (regex) and print out all info.') parser_query_details.add_argument('query', help='regex to search for.') parser_query_details.set_defaults(func=do_query_details) parser_reload = subparsers.add_parser('reload', description='Force reload of the cache.') parser_reload.set_defaults(func=do_reload) parser_auth = subparsers.add_parser('authenticate', description=AUTHENTICATE_HELP_STRING, formatter_class=argparse.RawDescriptionHelpFormatter, parents=[oauth2client.tools.argparser]) parser_auth.add_argument('client_id', metavar='CLIENT_ID', help='Client ID') parser_auth.add_argument('client_secret', metavar='CLIENT_SECRET', help='Client secret') parser_auth.set_defaults(func=do_authenticate) parser_unauth = subparsers.add_parser('unauthenticate', description="Removed authentication data (logout).") parser_unauth.set_defaults(func=do_unauthenticate) args = parser.parse_args() logging.basicConfig(level=args.log_level) if 'func' not in args: parser.error('To few arguments.') try: if args.func is do_config_template: config = None else: config = goobook.config.read_config(args.config) args.func(config, args) except goobook.config.ConfigError as err: sys.exit('Configuration error: ' + str(err)) ############################################################################## # sub commands def do_add(config, args): goobk = GooBook(config) if args.name and args.email: goobk.add_mail_contact(args.name, args.email, args.phone) else: goobk.add_email_from(sys.stdin) goobk.cache.load(force_update=True) def do_config_template(_config, _args): print(goobook.config.TEMPLATE) def do_dump_contacts(config, args): goco = GoogleContacts(config) contacts = goco.fetch_contacts() if args.parse: groupname_by_id = parse_groups(goco.fetch_contact_groups()) contacts = unstorageify(list(parse_contacts(goco.fetch_contacts(), groupname_by_id))) class DateEncoder(json.JSONEncoder): def default(self, obj): if isinstance(obj, datetime.date): return str(obj) # Let the base class default method raise the TypeError return json.JSONEncoder.default(self, obj) print(json.dumps(contacts, sort_keys=True, indent=4, ensure_ascii=False, cls=DateEncoder)) def do_dump_groups(config, args): goco = GoogleContacts(config) groups = goco.fetch_contact_groups() if args.parse: groupname_by_id = parse_groups(goco.fetch_contact_groups()) groups = unstorageify(list(groupname_by_id.values())) print(json.dumps(groups, sort_keys=True, indent=4, ensure_ascii=False)) def do_query(config, args): goobk = GooBook(config) goobk.query(args.query, simple=args.simple) def do_query_details(config, args): goobk = GooBook(config) goobk.query_details(args.query) def do_reload(config, _args): cache = Cache(config) cache.load(force_update=True) def do_authenticate(config, args): store = config.store creds = config.creds if not creds or creds.invalid: flow = oauth2client.client.OAuth2WebServerFlow(args.client_id, args.client_secret, SCOPES) creds = oauth2client.tools.run_flow(flow, store, args) else: print('You are already authenticated.') def do_unauthenticate(config, _args): oauth_db = pathlib.Path(config.oauth_db_filename) if oauth_db.exists(): oauth_db.unlink() print("deleted", oauth_db) if __name__ == '__main__': main() ././@PaxHeader0000000000000000000000000000003400000000000011452 xustar000000000000000028 mtime=1657362368.1591806 goobook-3.5.2/goobook/config.py0000644000000000000000000001356700000000000014601 0ustar0000000000000000# -*- coding: UTF-8 -*- # vim: fileencoding=UTF-8 filetype=python ff=unix et ts=4 sw=4 sts=4 tw=120 # author: Christer Sjöholm -- hcs AT furuvik DOT net import os import pathlib import sys from os.path import realpath, expanduser import configparser import logging import oauth2client.client from xdg.BaseDirectory import (xdg_cache_home, xdg_config_home, xdg_config_dirs, xdg_data_dirs, xdg_data_home) from goobook.storage import Storage log = logging.getLogger(__name__) # pylint: disable=invalid-name LEGACY_CONFIG_FILE = pathlib.Path('~/.goobookrc').expanduser() LEGACY_AUTH_FILE = pathlib.Path('~/.goobook_auth.json').expanduser() LEGACY_CACHE_FILE = pathlib.Path('~/.goobook_cache').expanduser() TEMPLATE = '''\ # Use this template to create your ~/.goobookrc # "#" or ";" at the start of a line makes it a comment. [DEFAULT] # The following are optional, defaults are shown when not other specified. # This file is written by the oauth library, and should be kept secure, # it's like a password to your google contacts. # default is to place it in the XDG_DATA_HOME ;oauth_db_filename: ~/.goobook_auth.json ;cache_filename: ~/.goobook_cache # default is in the XDG_CACHE_HOME ;cache_expiry_hours: 24 ;filter_groupless_contacts: yes # New contacts will be added to this group in addition to "My Contacts" # Note that the group has to already exist on google or an error will occur. # One use for this is to add new contacts to an "Unsorted" group, which can # be sorted easier than all of "My Contacts". ;default_group: ''' def topath(x): if isinstance(x, list): return [pathlib.Path(_x) for _x in x] else: return pathlib.Path(x) def read_config(config_file=None): """Reads the ~/.goobookrc and any authentication data. returns the configuration as a dictionary. """ config = Storage({ # Default values 'cache_filename': None, 'oauth_db_filename': None, 'cache_expiry_hours': '24', 'filter_groupless_contacts': True, 'default_group': ''}) # Search for config file to use if config_file: # config file explicitly given on the commandline config_file = os.path.expanduser(config_file) else: # search for goobookrc in XDG dirs and homedir config_files = [dir_ / "goobookrc" for dir_ in [topath(xdg_config_home)] + topath(xdg_config_dirs)] + [LEGACY_CONFIG_FILE] log.debug("config file search path: %s", config_files) for config_file_ in config_files: if config_file_.exists(): config_file = str(config_file_) log.debug("found config file: %s", config_file) break else: log.debug("no config file found") config_file = None # else: # .goobookrc in home directory # config_file = os.path.expanduser(CONFIG_FILE) if config_file: parser = _get_config(config_file) else: parser = None if parser: config.get_dict().update(dict(parser.items('DEFAULT', raw=True))) # Handle not string fields if parser.has_option('DEFAULT', 'filter_groupless_contacts'): config.filter_groupless_contacts = parser.getboolean('DEFAULT', 'filter_groupless_contacts') if "client_secret_filename" in config: print("WARNING: setting client_secret_filename in {} is deprecated".format(config_file), file=sys.stderr) # Search for cache file to use if config.cache_filename: # If explicitly specified in config file config.cache_filename = realpath(expanduser(config.cache_filename)) else: # search for goobook_cache in XDG dirs and homedir cache_files = [topath(xdg_cache_home) / "goobook_cache", LEGACY_CACHE_FILE] log.debug("cache file search path: %s", cache_files) for cache_file in cache_files: cache_file = cache_file.resolve() if cache_file.exists(): log.debug("found cache file: %s", cache_file) break else: # If there is none, create in XDG_CACHE_HOME cache_file = topath(xdg_cache_home) / "goobook_cache" log.debug("no cache file found, will use %s", cache_file) config.cache_filename = str(cache_file) # Search for auth file to use if config.oauth_db_filename: # If explicitly specified in config file config.oauth_db_filename = realpath(expanduser(config.oauth_db_filename)) auth_file = pathlib.Path(config.oauth_db_filename) else: # search for goobook_auth.json in XDG dirs and homedir auth_files = [dir_ / "goobook_auth.json" for dir_ in [topath(xdg_data_home)] + topath(xdg_data_dirs)] + [LEGACY_AUTH_FILE] log.debug("auth file search path: %s", auth_files) for auth_file in auth_files: auth_file = auth_file.resolve() if auth_file.exists(): log.debug("found auth file: %s", auth_file) break else: # If there is none, create in XDG_DATA_HOME auth_file = topath(xdg_data_home) / "goobook_auth.json" log.debug("no auth file found, will use %s", auth_file) config.oauth_db_filename = str(auth_file) config.store = oauth2client.file.Storage(config.oauth_db_filename) config.creds = config.store.get() if auth_file.exists() else None log.debug(config) return config def _get_config(config_file): """find, read and parse configuraton.""" parser = configparser.SafeConfigParser() if os.path.lexists(config_file): try: log.info('Reading config: %s', config_file) inp = open(config_file) parser.read_file(inp) return parser except (IOError, configparser.ParsingError) as err: raise ConfigError("Failed to read configuration %s\n%s" % (config_file, err)) return None class ConfigError(Exception): pass ././@PaxHeader0000000000000000000000000000003400000000000011452 xustar000000000000000028 mtime=1656502976.8852477 goobook-3.5.2/goobook/goobook.py0000755000000000000000000004175400000000000014775 0ustar0000000000000000# vim: fileencoding=UTF-8 filetype=python ff=unix expandtab sw=4 sts=4 tw=120 # maintainer: Christer Sjöholm -- goobook AT furuvik DOT net # authors: Marcus Nitzschke -- marcus.nitzschke AT gmx DOT com # # Copyright (C) 2009 Carlos José Barroso # Copyright (C) 2010 Christer Sjöholm # # This program is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with this program. If not, see . """The idea is make an interface to google contacts that mimics the behaviour of abook for mutt.""" import collections import datetime import email.parser import email.header import logging import os import pickle import re import sys import time import httplib2 from googleapiclient.discovery import build from goobook.storage import Storage, storageify, unstorageify log = logging.getLogger(__name__) # pylint: disable=invalid-name CACHE_FORMAT_VERSION = '5.1' TypedValue = collections.namedtuple('TypedValue', ['value', 'type']) class GooBook(): """Application logic. This class can't be used as a library as it looks now, it uses sys.stdin print and sys.exit(). """ def __init__(self, config): self.__config = config self.cache = Cache(config) self.cache.load() def query(self, query, simple=False): """Do the query, and print it out in specified format. simple=False is the mutt format simple format is: "Name " simple format for group matches is a , separated list of Name the group name is not printed using simple format. """ # query contacts matching_contacts = sorted(self.__query_contacts(query), key=lambda c: c.display_name) # query groups matching_groups = sorted(self.__query_groups(query), key=lambda g: g[0]) if not simple: # mutt's query_command expects the first line to be a message, # which it discards. print('') for contact in matching_contacts: if contact.emails: emailaddrs = sorted(contact.emails) groups = set(contact.groups) groups = groups.difference(('My Contacts',)) groups_str = ', '.join(('"' + g + '"' for g in groups)) for (emailaddr, kind) in emailaddrs: extra_str = kind if groups_str: extra_str = extra_str + ' groups: ' + groups_str if simple: print(f"{contact.display_name} <{emailaddr}>") else: print('\t'.join((emailaddr, contact.display_name, extra_str))) for title, contacts in matching_groups: emails = ['%s <%s>' % (c.display_name, c.emails[0][0]) for c in contacts if c.emails] emails = ', '.join(emails) if not emails: continue if simple: print(emails) else: print('%s\t%s (group)' % (emails, title)) def query_details(self, query): """Method for querying the contacts and printing a detailed view.""" out = sys.stdout # query contacts matching_contacts = list(self.__query_contacts(query)) # query groups for group in self.__query_groups(query): for contact in group[1]: if contact not in matching_contacts: matching_contacts.append(contact) matching_contacts = sorted(matching_contacts, key=lambda c: c.display_name) for contact in matching_contacts: print("-------------------------", file=out) print(contact.display_name, file=out) for org in contact.organizations: if org.name: print("Organization: ", org.name, file=out) if org.department: print("Department: ", org.department, file=out) if org.title: print("Title: ", org.title, file=out) if contact.birthday: print("Birthday: ", contact.birthday.strftime("%x"), file=out) if contact.phonenumbers: print("Phone:", file=out) for (number, kind) in contact.phonenumbers: print("\t", number, " (" + kind + ")", file=out) if contact.emails: print("EMail:", file=out) emailaddrs = sorted(contact.emails) for (emailaddr, kind) in emailaddrs: print("\t", emailaddr, " (" + kind + ")", file=out) if contact.im: print("IM:", file=out) for (nick, protocol) in contact.im: print("\t", nick, " (", protocol, ")", file=out) if contact.addresses: print("Address:", file=out) for (address, kind) in contact.addresses: lines = address.splitlines() lines[0] = '%s ( %s )' % (lines[0], kind) print("\t" + '\n\t'.join(lines), file=out) groups = set(contact.groups).difference(('My Contacts',)) if groups: print("Groups:", file=out) groups_str = '\n\t'.join(groups) print("\t" + groups_str, file=out) def __query_contacts(self, query): match = re.compile(query.replace(' ', '.*'), re.I).search # create a match function for contact in self.cache.contacts: if self.__config.filter_groupless_contacts and not contact.groups: continue # Skip contacts without groups if any(map(match, list(contact.all_names) + [str(number) for (number, kind) in contact.phonenumbers])): yield contact continue matching_addrs = [(email, kind) for (email, kind) in contact.emails if match(email)] if matching_addrs: contact.emails = matching_addrs # only show matching yield contact continue for org in contact.organizations: for field in ('name', 'title', 'department'): if org[field] and match(org[field]): yield contact continue def __query_groups(self, query): match = re.compile(query.replace(' ', '.*'), re.I).search # create a match function for group in self.cache.groups: # Collect all values to match against all_values = (group,) if any(map(match, all_values)): contacts = list(self.__get_group_contacts(group)) yield group, contacts def __get_group_contacts(self, group): for contact in self.cache.contacts: if group in contact.groups: yield contact def add_mail_contact(self, name, mailaddr, phone=None): contact = { 'names': [{'givenName': name}], 'emailAddresses': [{'value': mailaddr}], 'phoneNumbers': [{'value': phone}], } gcont = GoogleContacts(self.__config) log.debug('Going to create contact name: %s email: %s phone: %s', name, mailaddr, phone) gcont.create_contact(contact) log.info('Created contact name: %s email: %s %s', name, mailaddr, phone) def add_email_from(self, lines): """Add an address from From: field of a mail. This assumes a single mail file is supplied through. Args: ---- lines: A generator of lines, usually a open file. """ parser = email.parser.HeaderParser() headers = parser.parse(lines) if 'From' not in headers: print("Not a valid mail file!") sys.exit(2) (name, mailaddr) = email.utils.parseaddr(headers['From']) if not name: name = mailaddr else: # This decodes headers like "=?iso-8859-1?q?p=F6stal?=" values = email.header.decode_header(name) if not values: # Can't this be possible? name = mailaddr else: # There should be only one element anyway (name, encoding) = values[0] if encoding is not None: name = name.decode(encoding) self.add_mail_contact(name, mailaddr) class Cache(): def __init__(self, config): self.__config = config self.contacts = None # list of Storage self.groups = None # list of Storage def load(self, force_update=False): """Load the cached addressbook feed, or fetch it (again) if it is old or missing or invalid or anything. Args: ---- force_update: force update of cache """ cache = {} # if cache newer than cache_expiry_hours if not force_update and (os.path.exists(self.__config.cache_filename) and ((time.time() - os.path.getmtime(self.__config.cache_filename)) < (int(self.__config.cache_expiry_hours) * 60 * 60))): try: log.debug('Loading cache: %s', self.__config.cache_filename) cache = pickle.load(open(self.__config.cache_filename, 'rb')) if cache.get('goobook_cache') != CACHE_FORMAT_VERSION: log.info('Detected old cache format') cache = None # Old cache format except Exception as err: log.info('Failed to read the cache file: %s', err) raise if cache: self.contacts = storageify(cache.get('contacts')) self.groups = storageify(cache.get('groups')) else: self.update() if not self.contacts: raise Exception('Failed to find any contacts') # TODO def update(self): log.info('Retrieving contact data from Google.') gcs = GoogleContacts(self.__config) groupname_by_id = parse_groups(gcs.fetch_contact_groups()) self.contacts = list(parse_contacts(gcs.fetch_contacts(), groupname_by_id)) self.groups = list(groupname_by_id.values()) self.save() def save(self): """Pickle the addressbook and a timestamp.""" if self.contacts: # never write a empty addressbook cache = {'contacts': unstorageify(self.contacts), 'groups': unstorageify(self.groups), 'goobook_cache': CACHE_FORMAT_VERSION} pickle.dump(cache, open(self.__config.cache_filename, 'wb')) def parse_contact(person, groupname_by_id): """Extracts interesting contact info from cache. https://developers.google.com/people/api/rest/v1/people """ contact = Storage() contact.emails = [] contact.birthday = None # datetime.date contact.im = [] contact.addresses = [] contact.display_name = None contact.all_names = [] contact.groups = [] contact.phonenumbers = [] # [TypedValue] contact.organizations = [] # [Storage()] for emaila in person.get('emailAddresses', []): contact.emails.append(TypedValue(emaila['value'], emaila.get('type', ''))) if 'birthdays' in person.keys() and person['birthdays'] and 'date' in person['birthdays'][0]: birthday = person['birthdays'][0]['date'] if len(birthday) == 3: # we skip incomplete birthdates contact.birthday = datetime.date(birthday['year'], birthday['month'], birthday['day']) for name in person.get('names', []): if 'displayName' in name and contact.display_name is None: # use first displayName found contact.display_name = name['displayName'] for field in ("displayName", "displayNameLastFirst", "familyName", "givenName", "middleName", "honorificPrefix", "honorificSuffix", "phoneticFullName", "phoneticFamilyName", "phoneticGivenName", "phoneticMiddleName", "phoneticHonorificPrefix", "phoneticHonorificSuffix"): if field in name: contact.all_names.append(name[field]) if contact.display_name is None and contact.emails: # if there is no displayName use a email address contact.display_name = contact.emails[0].value for membership in person.get('memberships', []): if "contactGroupMembership" in membership: contact.groups.append(groupname_by_id['contactGroups/' + membership['contactGroupMembership']['contactGroupId']]) for phone in person.get('phoneNumbers', []): contact.phonenumbers.append(TypedValue(phone['value'], phone.get('type', ''))) for address in person.get('addresses', []): if 'formattedValue' in address: contact.addresses.append(TypedValue(address['formattedValue'], address.get('type', ''))) for item in person.get('imClients', []): if 'username' in item: contact.im.append(TypedValue(item['username'], item.get('protocol', ''))) if 'organizations' in person.keys() and person['organizations']: for org in person['organizations']: if not contact.display_name: contact.display_name = org.get('name') contact.organizations.append(Storage(name=org.get('name'), title=org.get('title'), department=org.get('department'))) log.debug('Parsed contact %s', contact) if not contact.display_name: log.info('Skipping contact because of no name/e-mail/organization: %s', person) return None return contact def parse_contacts(raw_contacts, groupname_by_id): for contact in raw_contacts: parsed = parse_contact(contact, groupname_by_id) if parsed: yield parsed def parse_groups(raw_groups): groupname_by_id = {} for entry in raw_groups: groupname_by_id[entry['resourceName']] = entry['formattedName'] return groupname_by_id class GoogleContacts(): def __init__(self, config): http_client = self.__get_client(config.creds) self.service = build('people', 'v1', http=http_client) # self.__additional_headers = { # 'GData-Version': GDATA_VERSION, # 'Content-Type': 'application/atom+xml' # } @staticmethod def __get_client(credentials): """Login to Google and return a ContactsClient object.""" if not credentials or credentials.invalid: sys.exit('No or invalid credentials, run "goobook authenticate"') # TODO raise exception instead http_auth = credentials.authorize(httplib2.Http()) return http_auth def fetch_contacts(self): connections = [] request = self.service.people().connections().list( resourceName='people/me', pageSize=2000, # Number of connections in response x__xgafv=None, pageToken=None, sortOrder=None, personFields=('names,nicknames,emailAddresses,memberships,' 'phoneNumbers,birthdays,imClients,organizations,addresses'), requestSyncToken=None, syncToken=None, requestMask_includeField=None) # Loop until all pages have been processed. while request is not None: # Get the next page. response = request.execute() # Accessing the response like a dict object with an 'items' key # returns a list of item objects (connections). connections.extend(response.get('connections', [])) # Get the next request object by passing the previous request object to # the list_next method. request = self.service.people().connections().list_next(request, response) return connections def fetch_contact_groups(self): groups = [] request = self.service.contactGroups().list(pageSize=500) # Loop until all pages have been processed. while request is not None: # Get the next page. response = request.execute() # Accessing the response like a dict object with an 'items' key # returns a list of item objects (groups). groups.extend(response.get('contactGroups', [])) # Get the next request object by passing the previous request object to # the list_next method. request = self.service.contactGroups().list_next(request, response) return groups def create_contact(self, contact): self.service.people().createContact(body=contact).execute() ././@PaxHeader0000000000000000000000000000003400000000000011452 xustar000000000000000028 mtime=1656502976.8852477 goobook-3.5.2/goobook/storage.py0000644000000000000000000001603200000000000014766 0ustar0000000000000000# -*- coding: UTF-8 -*- # vim: fileencoding=UTF-8 filetype=python ff=unix et ts=4 sw=4 sts=4 tw=120 # author: Christer Sjöholm -- hcs AT furuvik DOT net import collections import json class Storage(object): """ A Storage object wraps a dictionary. In addition to `obj['foo']`, `obj.foo` can also be used for accessing values. Wraps the dictionary instead of extending it so that the number of names that can conflict with keys in the dict is kept minimal. >>> o = Storage(a=1) >>> o.a 1 >>> o['a'] 1 >>> 'a' in o True >>> o.a = 2 >>> o['a'] 2 >>> del o.a >>> o.a Traceback (most recent call last): ... AttributeError: 'a' Based on Storage in web.py (public domain) """ __internal_vars = ('_dict', '_normalize', '_denormalize') def __init__(self, dict_=None, default_factory=None, normalize=None, denormalize=None, case_insensitive=False, **kwargs): ''' dict_: Dict to use as backend for Storage object, normalize will not be called for existing items. case_insensitive: All given keys will be converted to lower case before trying to set/access the dict. If a populated dict_ is given it must already have all keys in lower case. default_factory: if dict_ is None and default_factory is set then a defaultdict will be used with the specified default_factory. normalize: function that normalizes keys, case_insensitive for example is implemented as a normalizer that lower cases each key. denormalize: function that is called on each key before it is returned to the caller(iteritems and __iter__). ''' if dict_ is not None: self._dict = dict_ elif default_factory: self._dict = collections.defaultdict(default_factory, **kwargs) else: self._dict = dict(**kwargs) if normalize and case_insensitive: self._normalize = lambda key: normalize(key.lower()) elif case_insensitive: self._normalize = lambda key: key.lower() elif normalize: self._normalize = normalize else: self._normalize = lambda key: key # Do nothing if denormalize: self._denormalize = denormalize else: self._denormalize = lambda key: key # Do nothing for key, value in list(kwargs.items()): self[key] = value def get_dict(self): ''' Get the contained dict. all keys will be in their normalized form. ''' return self._dict def iteritems(self): ''' Iterate over all (key, value) pairs. All keys will be denormalized. ''' for key, value in list(self._dict.items()): yield self._denormalize(key), value def __getattr__(self, key): try: # prevent recursion (triggered by pickle.load() if key in Storage.__internal_vars: raise AttributeError('No such attribute: ' + repr(key)) key = self._normalize(key) return self[key] except KeyError as err: raise AttributeError(err) def __setattr__(self, key, value): # prevent recursion (triggered by pickle.load() if key in Storage.__internal_vars: object.__setattr__(self, key, value) else: key = self._normalize(key) self[key] = value def __delattr__(self, key): try: key = self._normalize(key) del self[key] except KeyError as err: raise AttributeError(err) # For container methods pass-through to the underlying dict. def __getitem__(self, key): key = self._normalize(key) return self._dict[key] def __setitem__(self, key, value): key = self._normalize(key) self._dict[key] = value def __delitem__(self, key): key = self._normalize(key) del self._dict[key] def __contains__(self, key): key = self._normalize(key) return key in self._dict def __iter__(self): for key in self._dict: yield self._denormalize(key) def __len__(self): return self._dict.__len__() def __eq__(self, other): return isinstance(other, Storage) and self._dict == other._dict __hash__ = None def __repr__(self): items = [] if isinstance(self._dict, collections.defaultdict): items.append('default_factory={0}'.format(self._dict.default_factory)) items.extend('{0}={1}'.format(self._denormalize(i[0]), repr(i[1])) for i in sorted(self._dict.items())) return '{0}({1})'.format(self.__class__.__name__, ', '.join(items)) def json_loads_storage(str_): ''' >>> json_loads_storage('[{"a":1}]') [Storage(a=1)] ''' return json.loads(str_, object_hook=Storage) def json_load_storage(fp_): return json.load(fp_, object_hook=Storage) def json_dumps_storage(job): ''' >>> json_dumps_storage(Storage(a=2)) '{\\n "a": 2\\n}' >>> json_dumps_storage([Storage(a=2)]) '[\\n {\\n "a": 2\\n }\\n]' >>> json_dumps_storage({'a':2}) '{\\n "a": 2\\n}' ''' return json.dumps(job, default=_storage_to_dict, indent=2) def json_dump_storage(obj, fp_): return json.dump(obj, fp_, default=_storage_to_dict, indent=2) def _storage_to_dict(obj): ''' >>> _storage_to_dict(Storage(a=1)) {'a': 1} >>> _storage_to_dict('') Traceback (most recent call last): ... TypeError: not a Storage object ''' if isinstance(obj, Storage): return obj.get_dict() else: raise TypeError('not a Storage object') def storageify(obj, storageFactory=Storage): ''' takes a json style datastructure and converts all dicts to Storage. ''' if isinstance(obj, dict): res = storageFactory() for key, value in list(obj.items()): res[key] = storageify(value, storageFactory=storageFactory) elif isinstance(obj, list): res = [] for element in obj: res.append(storageify(element, storageFactory=storageFactory)) else: res = obj return res def unstorageify(obj): ''' make a deep copy of Storage, dict, and lists and convert all Storage to dict Good when you want to convert to json or yaml ''' if isinstance(obj, Storage): res = {} for key, value in list(obj.get_dict().items()): res[key] = unstorageify(value) elif isinstance(obj, dict): res = {} for key, value in list(obj.items()): res[key] = unstorageify(value) elif isinstance(obj, list): res = [] for element in obj: res.append(unstorageify(element)) else: res = obj return res ././@PaxHeader0000000000000000000000000000003400000000000011452 xustar000000000000000028 mtime=1657362368.1611807 goobook-3.5.2/pyproject.toml0000644000000000000000000000205600000000000014226 0ustar0000000000000000[tool.poetry] name = "goobook" version = "3.5.2" description = "Search your google contacts from the command-line or mutt." authors = ["Christer Sjöholm "] license = "GPL-3.0-only" readme = "README.rst" repository = "http://gitlab.com/goobook/goobook" keywords=[ "abook", "mutt", "e-mail", "gmail", "google", "address-book" ] classifiers = [ "Development Status :: 5 - Production/Stable", "Environment :: Console", "Operating System :: OS Independent", "Intended Audience :: End Users/Desktop", "Topic :: Communications :: Email :: Address Book" ] [tool.poetry.dependencies] python = "^3.7" google-api-python-client = "^1.7.12" simplejson = "^3.16.0" oauth2client = ">=1.5.0,<5.0.0dev" setuptools = "^62.6.0" pyxdg = "^0.28" [tool.poetry.dev-dependencies] prospector = "^1.7.7" pytest = "^7.1.2" docutils = "^0.18.1" pyroma = "^4.0" vulture = "^2.4" [tool.poetry.scripts] goobook = "goobook.application:main" [build-system] requires = ["poetry-core>=1.0.0"] build-backend = "poetry.core.masonry.api" ././@PaxHeader0000000000000000000000000000003300000000000011451 xustar000000000000000027 mtime=1657363892.575548 goobook-3.5.2/setup.py0000644000000000000000000001627500000000000013034 0ustar0000000000000000# -*- coding: utf-8 -*- from setuptools import setup packages = \ ['goobook'] package_data = \ {'': ['*']} install_requires = \ ['google-api-python-client>=1.7.12,<2.0.0', 'oauth2client>=1.5.0,<5.0.0dev', 'pyxdg>=0.28,<0.29', 'setuptools>=62.6.0,<63.0.0', 'simplejson>=3.16.0,<4.0.0'] entry_points = \ {'console_scripts': ['goobook = goobook.application:main']} setup_kwargs = { 'name': 'goobook', 'version': '3.5.2', 'description': 'Search your google contacts from the command-line or mutt.', 'long_description': ':::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::\nGooBook -- Access your Google contacts from the command line.\n:::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::\n\n.. contents:: **Table of Contents**\n :depth: 1\n\nAbout\n=====\n\nThe purpose of GooBook is to make it possible to use your Google Contacts from\nthe command-line and from MUAs such as Mutt.\nIt can be used from Mutt the same way as abook.\n\n.. NOTE:: GooBook is looking for a new maintainer see https://gitlab.com/goobook/goobook/-/issues/90\n\nInstallation Instructions\n=========================\n\nThere is a number of ways to install Python software.\n\n- Using pip\n- Using a source tarball\n- Using source directly from gitorius\n- From a distribution specific repository\n\nWhich version to use\n--------------------\n\nIf you only have Python 2.7 you need to use GooBook 1.x.\nIf you have Python 3.7+ you need to use GooBook 3.x.\n\nThere will be no further feature releases in the 1.x series.\n\npip\n---\n\nThis is the recommended way to install goobook for most users that\ndon\'t have it available in their distribution.\nWhen installing this way you will not need to download anything manually.\n\nInstall like this::\n\n $ pip install --user goobook\n\nThis will install goobook as ~/.local/bin/goobook (In a UNIX environment).\n\n\nPoetry\n------\n\nThis is the recommended way if you want to run from a git checkout.\nInstall poetry if you don\'t have it, https://python-poetry.org.\n\nclone the git repos, cd into in, and run::\n\n $ poetry install\n\nGoobook is now installed in a virtualenv created by poetry.\nYou can test goobook by running::\n\n $ poetry run goobook\n\nTo locate the virtualenv where goobook is installed::\n\n $ poetry env list --full-path\n\nSource installation from tarball\n--------------------------------\n\nDownload the source tarball, uncompress it, then run the install command::\n\n $ tar -xzvf goobook-*.tar.gz\n $ cd goobook-*\n $ sudo python ./setup.py install\n\n\nConfiguration\n=============\n\nFirst you need to authenticate yourself:\n\n- Go to https://developers.google.com/people/quickstart/python\n- and click "Enable the People API"\n- select a name (ex. GooBook)\n- select desktop app and create\n- save the client_id and client_secret to be used below\n\nrun::\n\n $ goobook authenticate -- CLIENT_ID CLIENT_SECRET\n\nand follow the instructions, this part is web based.\n\n\nIf the procedure above to get client_id and secret stops working this is an alternative way to do it:\n\n- Go to the Google developer console https://console.developers.google.com/\n- Create a new project (drop down at the top of the screen) (you are free to use an existing one if you so prefer)\n- Select the newly created project\n- Go to OAuth consent screen from sidebar\n- Select the interal user type if you can but most will only be able to select external.\n- On next screen give it a name (ex. GooBook)\n- select Add scope, click manually paste and write "https://www.googleapis.com/auth/contacts" inte the lower text box.\n- and hit hit add and then save\n- Go to Credentials from sidebar\n- Click Create Credentials from top, then OAuth Client ID in the dropdown\n- Choose Desktop app, enter any name you want, and hit create\n- save the client_id and client_secret to be used with goobook authenticate\n\n\nTo get access too more settings you can create a configuration file::\n\n goobook config-template > ~/.config/goobookrc\n\nIt will look like this::\n\n # Use this template to create your ~/.goobookrc\n\n # "#" or ";" at the start of a line makes it a comment.\n\n [DEFAULT]\n # The following are optional, defaults are shown when not other specified.\n\n # This file is written by the oauth library, and should be kept secure,\n # it\'s like a password to your google contacts.\n # default is to place it in the XDG_DATA_HOME\n ;oauth_db_filename: ~/.goobook_auth.json\n\n ;cache_filename: ~/.goobook_cache # default is in the XDG_CACHE_HOME\n ;cache_expiry_hours: 24\n ;filter_groupless_contacts: yes\n\n # New contacts will be added to this group in addition to "My Contacts"\n # Note that the group has to already exist on google or an error will occur.\n # One use for this is to add new contacts to an "Unsorted" group, which can\n # be sorted easier than all of "My Contacts".\n ;default_group:\n\n\nFiles\n-----\n\nGooBook is using three files, the optional config file that can be placed in\nthe ``XDG_CONFIG_HOME`` (``~/.config/goobookrc``) or in the home directory\n(``~/.goobookrc``).\n\nThe authentication file that is created by running goobook authenticate in\n``XDG_DATA_HOME`` (``~/.local/share/goobook_auth.json``) but can also be placed\nin the home directory (``~/.goobook_auth.json``).\n\nThe contacts cache file that is created in ``XDG_CACHE_HOME``\n(``~/.cache/goobook_cache``) but can also be placed in the home directory\n(``~/.goobook_cache``).\n\nProxy settings\n--------------\n\nIf you use a proxy you need to set the ``https_proxy`` environment variable.\n\nMutt\n----\n\nIf you want to use goobook from mutt.\n\nSet in your .muttrc file::\n\n set query_command="goobook query %s"\n\nto query address book. (Normally bound to "Q" key.)\n\nIf you want to be able to use to complete email addresses instead of Ctrl-t add this::\n\n bind editor complete-query\n\nTo add email addresses (with "a" key normally bound to create-alias command)::\n\n macro index,pager a "goobook add" "add the sender address to Google contacts"\n\nIf you want to add an email\'s sender to Contacts, press a while it\'s selected in the index or pager.\n\nUsage\n=====\n\nTo query your contacts::\n\n $ goobook query QUERY\n\nThe add command reads a email from STDIN and adds the From address to your Google contacts::\n\n $ goobook add\n\nThe cache is updated automatically according to the configuration but you can also force an update::\n\n $ goobook reload\n\nFor more commands see::\n\n $ goobook -h\n\nand::\n\n $ goobook COMMAND -h\n\nLinks, Feedback and getting involved\n====================================\n\n- PyPI home: https://pypi.org/project/goobook/\n- Code Repository: http://gitlab.com/goobook/goobook\n- Issue tracker: https://gitlab.com/goobook/goobook/issues\n- Mailing list: http://groups.google.com/group/goobook\n', 'author': 'Christer Sjöholm', 'author_email': 'goobook@furuvik.net', 'maintainer': None, 'maintainer_email': None, 'url': 'http://gitlab.com/goobook/goobook', 'packages': packages, 'package_data': package_data, 'install_requires': install_requires, 'entry_points': entry_points, 'python_requires': '>=3.7,<4.0', } setup(**setup_kwargs) ././@PaxHeader0000000000000000000000000000003400000000000011452 xustar000000000000000028 mtime=1657363892.5767872 goobook-3.5.2/PKG-INFO0000644000000000000000000001635000000000000012411 0ustar0000000000000000Metadata-Version: 2.1 Name: goobook Version: 3.5.2 Summary: Search your google contacts from the command-line or mutt. Home-page: http://gitlab.com/goobook/goobook License: GPL-3.0-only Keywords: abook,mutt,e-mail,gmail,google,address-book Author: Christer Sjöholm Author-email: goobook@furuvik.net Requires-Python: >=3.7,<4.0 Classifier: Development Status :: 5 - Production/Stable Classifier: Environment :: Console Classifier: Intended Audience :: End Users/Desktop Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3) Classifier: Operating System :: OS Independent Classifier: Programming Language :: Python :: 3 Classifier: Programming Language :: Python :: 3.7 Classifier: Programming Language :: Python :: 3.8 Classifier: Programming Language :: Python :: 3.9 Classifier: Topic :: Communications :: Email :: Address Book Requires-Dist: google-api-python-client (>=1.7.12,<2.0.0) Requires-Dist: oauth2client (>=1.5.0,<5.0.0dev) Requires-Dist: pyxdg (>=0.28,<0.29) Requires-Dist: setuptools (>=62.6.0,<63.0.0) Requires-Dist: simplejson (>=3.16.0,<4.0.0) Project-URL: Repository, http://gitlab.com/goobook/goobook Description-Content-Type: text/x-rst ::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: GooBook -- Access your Google contacts from the command line. ::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: .. contents:: **Table of Contents** :depth: 1 About ===== The purpose of GooBook is to make it possible to use your Google Contacts from the command-line and from MUAs such as Mutt. It can be used from Mutt the same way as abook. .. NOTE:: GooBook is looking for a new maintainer see https://gitlab.com/goobook/goobook/-/issues/90 Installation Instructions ========================= There is a number of ways to install Python software. - Using pip - Using a source tarball - Using source directly from gitorius - From a distribution specific repository Which version to use -------------------- If you only have Python 2.7 you need to use GooBook 1.x. If you have Python 3.7+ you need to use GooBook 3.x. There will be no further feature releases in the 1.x series. pip --- This is the recommended way to install goobook for most users that don't have it available in their distribution. When installing this way you will not need to download anything manually. Install like this:: $ pip install --user goobook This will install goobook as ~/.local/bin/goobook (In a UNIX environment). Poetry ------ This is the recommended way if you want to run from a git checkout. Install poetry if you don't have it, https://python-poetry.org. clone the git repos, cd into in, and run:: $ poetry install Goobook is now installed in a virtualenv created by poetry. You can test goobook by running:: $ poetry run goobook To locate the virtualenv where goobook is installed:: $ poetry env list --full-path Source installation from tarball -------------------------------- Download the source tarball, uncompress it, then run the install command:: $ tar -xzvf goobook-*.tar.gz $ cd goobook-* $ sudo python ./setup.py install Configuration ============= First you need to authenticate yourself: - Go to https://developers.google.com/people/quickstart/python - and click "Enable the People API" - select a name (ex. GooBook) - select desktop app and create - save the client_id and client_secret to be used below run:: $ goobook authenticate -- CLIENT_ID CLIENT_SECRET and follow the instructions, this part is web based. If the procedure above to get client_id and secret stops working this is an alternative way to do it: - Go to the Google developer console https://console.developers.google.com/ - Create a new project (drop down at the top of the screen) (you are free to use an existing one if you so prefer) - Select the newly created project - Go to OAuth consent screen from sidebar - Select the interal user type if you can but most will only be able to select external. - On next screen give it a name (ex. GooBook) - select Add scope, click manually paste and write "https://www.googleapis.com/auth/contacts" inte the lower text box. - and hit hit add and then save - Go to Credentials from sidebar - Click Create Credentials from top, then OAuth Client ID in the dropdown - Choose Desktop app, enter any name you want, and hit create - save the client_id and client_secret to be used with goobook authenticate To get access too more settings you can create a configuration file:: goobook config-template > ~/.config/goobookrc It will look like this:: # Use this template to create your ~/.goobookrc # "#" or ";" at the start of a line makes it a comment. [DEFAULT] # The following are optional, defaults are shown when not other specified. # This file is written by the oauth library, and should be kept secure, # it's like a password to your google contacts. # default is to place it in the XDG_DATA_HOME ;oauth_db_filename: ~/.goobook_auth.json ;cache_filename: ~/.goobook_cache # default is in the XDG_CACHE_HOME ;cache_expiry_hours: 24 ;filter_groupless_contacts: yes # New contacts will be added to this group in addition to "My Contacts" # Note that the group has to already exist on google or an error will occur. # One use for this is to add new contacts to an "Unsorted" group, which can # be sorted easier than all of "My Contacts". ;default_group: Files ----- GooBook is using three files, the optional config file that can be placed in the ``XDG_CONFIG_HOME`` (``~/.config/goobookrc``) or in the home directory (``~/.goobookrc``). The authentication file that is created by running goobook authenticate in ``XDG_DATA_HOME`` (``~/.local/share/goobook_auth.json``) but can also be placed in the home directory (``~/.goobook_auth.json``). The contacts cache file that is created in ``XDG_CACHE_HOME`` (``~/.cache/goobook_cache``) but can also be placed in the home directory (``~/.goobook_cache``). Proxy settings -------------- If you use a proxy you need to set the ``https_proxy`` environment variable. Mutt ---- If you want to use goobook from mutt. Set in your .muttrc file:: set query_command="goobook query %s" to query address book. (Normally bound to "Q" key.) If you want to be able to use to complete email addresses instead of Ctrl-t add this:: bind editor complete-query To add email addresses (with "a" key normally bound to create-alias command):: macro index,pager a "goobook add" "add the sender address to Google contacts" If you want to add an email's sender to Contacts, press a while it's selected in the index or pager. Usage ===== To query your contacts:: $ goobook query QUERY The add command reads a email from STDIN and adds the From address to your Google contacts:: $ goobook add The cache is updated automatically according to the configuration but you can also force an update:: $ goobook reload For more commands see:: $ goobook -h and:: $ goobook COMMAND -h Links, Feedback and getting involved ==================================== - PyPI home: https://pypi.org/project/goobook/ - Code Repository: http://gitlab.com/goobook/goobook - Issue tracker: https://gitlab.com/goobook/goobook/issues - Mailing list: http://groups.google.com/group/goobook