diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..163eb75 --- /dev/null +++ b/.editorconfig @@ -0,0 +1,9 @@ +root = true + +[*.cr] +charset = utf-8 +end_of_line = lf +insert_final_newline = true +indent_style = space +indent_size = 2 +trim_trailing_whitespace = true diff --git a/.gitignore b/.gitignore index dbde338..0bb75ea 100644 --- a/.gitignore +++ b/.gitignore @@ -1,30 +1,5 @@ -# General stuff to ignore. -*.pyc -/dist/ -/*.egg-info/ -/build/ -__pycache__/ -.eggs - -# For easy updating of stuff. -update_pypi_and_github.py - -# Currently in progress -/flexx-app/ -/.idea/ -*test.py - -# Temporarily downloaded files -*.mp3 -*.zip -*.part -*.webm - -# Coverage files -.coverage - -# Temporarily built binaries -ffmpeg binaries/ - -# vscode work space -.vscode/ \ No newline at end of file +/docs/ +/lib/ +/bin/ +/.shards/ +*.dwarf diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 0000000..765f0e9 --- /dev/null +++ b/.travis.yml @@ -0,0 +1,6 @@ +language: crystal + +# Uncomment the following if you'd like Travis to run specs and check code formatting +# script: +# - crystal spec +# - crystal tool format --check diff --git a/LICENSE b/LICENSE index 9cecc1d..191c7f4 100644 --- a/LICENSE +++ b/LICENSE @@ -1,674 +1,21 @@ - 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. - - {one line to give the program's name and a brief idea of what it does.} - Copyright (C) {year} {name of author} - - 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: - - {project} Copyright (C) {year} {fullname} - 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 -. +The MIT License (MIT) + +Copyright (c) 2019 Cooper Hammond + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. diff --git a/README.md b/README.md index 7818c0f..38f9dfa 100644 --- a/README.md +++ b/README.md @@ -1,85 +1,27 @@ -# Ironic Redistribution System +# irs -[![License: GNU](https://img.shields.io/badge/license-gnu-yellow.svg?style=flat-square)](http://www.gnu.org/licenses/gpl.html) -[![Stars](https://img.shields.io/github/stars/kepoorhampond/irs.svg?style=flat-square)](https://github.com/kepoorhampond/irs/stargazers) -[![Say Thanks](https://img.shields.io/badge/say-thanks-ff69b4.svg?style=flat-square)](https://saythanks.io/to/kepoorhampond) -[![PyPI](https://img.shields.io/badge/pypi-irs-blue.svg?style=flat-square)](https://pypi.python.org/pypi/irs) +TODO: Write a description here -> A music downloader that understands your metadata needs. +## Installation -A tool to download your music with metadata. It uses [Spotify](https://www.spotify.com/) for finding metadata and [Youtube](https://www.youtube.com/) for the actual audio source. You will need to have some Spotify tokens, the instructions to set them up are [here](https://github.com/kepoorhampond/irs#spotify-tokens). +TODO: Write installation instructions here -Works with Python 2 and 3. +## Usage -## Install and Setup -``` -$ sudo pip install irs -$ irs --setup -``` +TODO: Write usage instructions here -**You will need to have some Spotify tokens, the instructions to set them up are [here](https://github.com/kepoorhampond/irs#spotify-tokens).** +## Development +TODO: Write development instructions here -## Demo and Usages +## Contributing -The usages can be found with the `-h` or `--help` flag: -``` -usage: irs [-h] [-S] [-a ARTIST] [-s SONG] [-A ALBUM] [-p PLAYLIST] - [-u USERNAME] [-o ORGANIZATION] +1. Fork it () +2. Create your feature branch (`git checkout -b my-new-feature`) +3. Commit your changes (`git commit -am 'Add some feature'`) +4. Push to the branch (`git push origin my-new-feature`) +5. Create a new Pull Request -optional arguments: - -h, --help show this help message and exit - -S, --setup Run this by itself to setup config files and folder - for irs and download the ffmpeg binaries - -a ARTIST, --artist ARTIST - Specify artist name. Must be used with -s/--song or - -A/--album - -s SONG, --song SONG Specify song name. Must be used with -a/--artist - -A ALBUM, --album ALBUM - Specify album name. Can be used by itself. - -p PLAYLIST, --playlist PLAYLIST - Specify playlist name. Must be used with -A/--album - -u USERNAME, --username USERNAME - Specify user name for playlist. Must be used with - -A/--album - -o ORGANIZATION, --organization ORGANIZATION - Specify type of organization for list. Used when - downloading spotify playlist/album -``` +## Contributors -So all of these are valid commands: -``` -$ irs -a "Brandon Flowers" -s "Lonely Town" -$ irs -u "spotify" -p "Brain Food" -$ irs -A "Suicide Squad: The Album" -``` -But these are not: -``` -$ irs -s "Bohemian Rhapsody" -$ irs -p "Best Nirvana" -``` - -## Spotify Tokens - -To download metadata through spotify, you'll want to head to their Dev Apps page, [here](https://developer.spotify.com/my-applications/). After doing that you'll want to create a new app. Name it whatever you want and then once you've done that, find the `Client ID` and `Client Secret` keys. You'll want to take those keys and paste them into your system's environment variables as `SPOTIFY_CLIENT_ID` and `SPOTIFY_CLIENT_SECRET`, correspondingly. Voilà! You can now download metadata with IRS! - -## Metadata - -Currently, the program attaches the following metadata to the downloaded files: - - Title - - Artist - - Album - - Album Art - - Genre - - Track Number - - Disc Number - -## Wishlist - - - [x] Full album downloading - - [x] Album art metadata correctly displayed - - [x] Spotify playlist downloading - - [ ] Comment metadata - - [ ] Compilation metadata - - [ ] GUI/Console interactive version - *in progress* - - [ ] Lyric metadata +- [Cooper Hammond](https://github.com/your-github-user) - creator and maintainer diff --git a/irs/__init__.py b/irs/__init__.py deleted file mode 100644 index e69de29..0000000 diff --git a/irs/cli/__init__.py b/irs/cli/__init__.py deleted file mode 100644 index e69de29..0000000 diff --git a/irs/cli/cli.py b/irs/cli/cli.py deleted file mode 100644 index 8079625..0000000 --- a/irs/cli/cli.py +++ /dev/null @@ -1,51 +0,0 @@ -import argparse - -from ..glue.song import Song -from ..glue.album import Album -from ..glue.playlist import Playlist -from ..install.setup import set_it_up -from .config_parser import parse_config - -def main(): - """The main cli method. Parses arguments from the command line.""" - - parser = argparse.ArgumentParser() - - parser.add_argument("-S", "--setup", dest="setup", action='store_true', - help="Run this by itself to setup config files " - "and folder for irs and download the ffmpeg binaries") - - parser.add_argument("-a", "--artist", dest="artist", - help="Specify artist name. Must be used with -s/--song or -A/--album") - - parser.add_argument("-s", "--song", dest="song", - help="Specify song name. Must be used with -a/--artist") - - parser.add_argument("-A", "--album", dest="album", - help="Specify album name. Can be used by itself.") - - parser.add_argument("-p", "--playlist", dest="playlist", - help="Specify playlist name. Must be used with -A/--album") - - parser.add_argument("-u", "--username", dest="username", - help="Specify user name for playlist. Must be used with -A/--album") - - parser.add_argument("-o", "--organization", dest="organization", - default="single-folder", help="Specify type of organization for list." - " Used when downloading spotify playlist/album") - - args = parser.parse_args() - - if args.setup: - set_it_up() - - parse_config() - - if args.song and args.artist: # single song - Song(args.song, args.artist).grab_it() - elif args.album and args.artist: # album with an artist - Album(args.album, args.artist).grab_it() - elif args.album: # album without artist - Album(args.album).grab_it() - elif args.playlist and args.username: # playlist - Playlist(args.playlist, args.username, args.organization).grab_it() diff --git a/irs/cli/config_parser.py b/irs/cli/config_parser.py deleted file mode 100644 index 6104591..0000000 --- a/irs/cli/config_parser.py +++ /dev/null @@ -1,52 +0,0 @@ -import os -import sys - -import yaml - - -def parse_config(): - """Parses config using environment variables.""" - - home = os.environ.get("HOME") or os.path.expanduser("~/") - - check_for_and_set("irs_config_dir", home + "/.irs", ".irs/") - - check_for = [home + "/.irs/config.yml", home + "/.irs/bin/ffmpeg", - home + "/.irs/bin/ffprobe"] - - for path in check_for: - if not os.path.exists(path): - print("There's no config set up. Set up a configuration folder by " - "running `irs --setup`") - sys.exit(1) - - config = {} - - with open(os.environ["irs_config_dir"] + "/config.yml", "r") as stream: - try: - config = yaml.safe_load(stream) - except yaml.YAMLError as exc: - print(exc) - - check_for_and_set("SPOTIFY_CLIENT_ID", config.get( - "SPOTIFY_KEYS").get("CLIENT_ID"), None) - check_for_and_set("SPOTIFY_CLIENT_SECRET", config.get( - "SPOTIFY_KEYS").get("CLIENT_SECRET"), None) - - check_for_and_set("irs_music_dir", os.path.expanduser(config.get("music_directory")), - home + "/Music") - check_for_and_set("irs_ffmpeg_dir", os.environ["irs_config_dir"] + "/bin", None) - - -def check_for_and_set(key, val, else_): - """Checks for an environment variable and if it doesn't exist, then set it - equal to the val given. - :param key: string, key to check for existence - :param val: value to replace key value with if it doesn't exists - :param else_: if val doesn't exist, use else_ instead - """ - if not os.environ.get(key): - if key: - os.environ[key] = val - else: - os.environ[key] = else_ diff --git a/irs/glue/__init__.py b/irs/glue/__init__.py deleted file mode 100644 index e69de29..0000000 diff --git a/irs/glue/album.py b/irs/glue/album.py deleted file mode 100644 index 8f6af7a..0000000 --- a/irs/glue/album.py +++ /dev/null @@ -1,14 +0,0 @@ -from .list import SpotifyList - -class Album(SpotifyList): - """A class for downloading albums as a whole.""" - - def _SpotifyList__find_it(self): - album = self.spotify_searcher.find_album( - self.list_title, - self.list_author - ) - return album - - def _SpotifyList__set_organization(self, song_index, song): - pass \ No newline at end of file diff --git a/irs/glue/list.py b/irs/glue/list.py deleted file mode 100644 index b7f9a7b..0000000 --- a/irs/glue/list.py +++ /dev/null @@ -1,51 +0,0 @@ -import sys -import abc - -from ..search import spotify -from .song import Song - -class SpotifyList(object): - """A parent class for downloading spotify albums and playlists""" - - def __init__(self, list_title, list_author=None): - self.spotify_searcher = spotify.SpotifySearcher().authorize() - self.list_title = list_title - self.list_author = list_author - self.file_names = [] - - def grab_it(self): - """Downloads the songs! - """ - spotify_list = self.__find_it() - list_contents = spotify_list["tracks"]["items"] - - for index, s in enumerate(list_contents): - # if it's a playlist, get the actual track, not the metadata of - # the playlist - if s.get("track"): - s = s["track"] - - song = Song(s["name"], s["artists"][0]["name"]) - song.provide_spotify(self.spotify_searcher) - song.provide_metadata(self.spotify_searcher.song(s["uri"])) - song.get_relevant_tags() - self.__set_organization(index, song) - song.grab_it() - - # These following functions are named weird b/c PEP8 and python are in - # conflict. An error gets raised when private methods - # (prefix = __ due to PEP8) are overriden by child class with the same - # name b/c python is dumb with how it concatenates class names and method - # names with underscores - - def __find_it(self): - """Finds the list and return it""" - raise NotImplementedError("Must override __find_it with" - "_SpotifyList__find_it") - - def __set_organization(self, song_index, song): - """Post processing method for a single song - :param song: Song class - """ - raise NotImplementedError("Must override __post_process with" - "_SpotifyList__set_organization") \ No newline at end of file diff --git a/irs/glue/playlist.py b/irs/glue/playlist.py deleted file mode 100644 index 1c2695a..0000000 --- a/irs/glue/playlist.py +++ /dev/null @@ -1,39 +0,0 @@ -import os - -from .list import SpotifyList - -class Playlist(SpotifyList): - """A class for downloading albums as a whole. - The majority of specs for methods can be found in the SpotifyList file""" - - def __init__(self, playlist_name, username, organization="single-folder"): - """ - :param playlist_name: a string, the name of the playlist - :param username: a string, the username of the creator of the playlist - :param organization: a string, following options: - "single-folder": All of the songs downloaded will be put into a - single folder. root-music-dir>playlist-name - "standard": All of the songs downloaded will be - organized by root-music-dir>artist>album - """ - super(Playlist, self).__init__(playlist_name, username) - self.organization = organization - - def _SpotifyList__find_it(self): - playlist = self.spotify_searcher.find_playlist( - self.list_title, - self.list_author - ) - return playlist - - def _SpotifyList__set_organization(self, song_index, song): - if self.organization == "standard": - song.set_standard_organization() - elif self.organization == "single-folder": - # reindex the file names in order to keep them in alphabetical order - song.provide_new_file_name("{} - {}.mp3".format( - song_index + 1, song.tags["title"] - )) - song.provide_new_location(os.path.join( - os.getcwd(), self.list_title - )) \ No newline at end of file diff --git a/irs/glue/song.py b/irs/glue/song.py deleted file mode 100644 index 1486a2f..0000000 --- a/irs/glue/song.py +++ /dev/null @@ -1,193 +0,0 @@ -import os -import sys -import errno -import string - -from ..search import spotify, youtube -from ..interact import ripper, tagger - - -class Song(object): - """A grabber for a single song. Unless provided, gets metadata, finds url, - downloads, converts, tags, and moves it.""" - def __init__(self, song_title, artist_name): - self.song_title = song_title - self.artist_name = artist_name - - self.spotify_searcher = None - self.spotify_authenticated = False - - self.metadata = None - self.tags = {} - self.parsed_tags = False - - self.file_name = song_title + ".mp3" - self.end_file_name = None - - self.current_location = os.getcwd() - self.end_location = None - - def grab_it(self, post_process=True): - """The main method to call for this class. Unless provided, grabs - metadata, finds the url, downloads the video, converts it, and - tags it. - :param post_process: boolean, - :rtype: a string, the file_name - """ - - self.metadata = self.__parse_data() - - self.tags = self.get_relevant_tags() - - print("'{}' by {}:".format(self.tags["title"], self.tags["artist"])) - - print("Searching youtube ...") - song_url = youtube.find_url(self.tags["title"], self.tags["artist"]) - - if self.metadata: - self.file_name = '{} - {}.mp3'.format( - self.tags["tracknumber"], - self.tags["title"] - ) - - print("Downloading ...") - ripper.rip_from_url(song_url, self.file_name) - print("Converting to mp3 ...") # TODO: add this into a hook for ydl - - print("Tagging ...") - song_tags = tagger.Tagger(self.file_name) - - for tag in self.tags: - if tag is "albumart": - song_tags.add_album_art(self.tags[tag]) - else: - song_tags.add_tag(tag, self.tags[tag]) - - if post_process: - self.__organize() - - def provide_spotify(self, spotify_searcher): - """This function will set this class's spotify searcher to the one - provided to prevent the need to authenticate twice - :param spotify_searcher: an instance of - irs.searcher.spotify.SpotifySearcher, the spotify searcher to use - :rtype: self class - """ - self.spotify_searcher = spotify_searcher - self.spotify_authenticated = True - return self - - def provide_metadata(self, metadata): - """Provides metadata for the song so searches don't have to be - performed twice. If this is called with new metadata, - other metadata won't be searched. - :param metadata: a dict, the new metadata from a spotipy track search - :rtype: self class - """ - self.metadata = metadata - return self - - def provide_tag(self, key, value): - """Provides tags for the song. Tags will still be parsed, but will not - overwrite these provided tags. - :param: a dict, the tags that will overwrite the metadata provided tags - :rtype: self class - """ - self.tags[key] = value - return self - - def provide_new_location(self, new_loc): - """Provides a new, non-default location for the song. - :param new_loc: a string, the path of the new location WITHOUT filename - :rtype: self class - """ - self.end_location = new_loc - return self - - def provide_new_file_name(self, new_name): - """Provides a new file name for the song file. DOESNT append .mp3 - :param new_name: string - :rtype: self class - """ - self.end_file_name = new_name - return self - - def set_standard_organization(self): - """Sets standard organization for the file, which is - root-music-dir>artist-folder>album-folder>song - """ - if not self.parsed_tags: - self.tags = self.get_relevant_tags() - self.end_location = os.path.join( - os.environ.get("irs_music_dir"), self.tags["artist"], - self.tags["album"] - ) - self.end_file_name = "{} - {}.mp3".format( - self.tags["tracknumber"], self.tags["title"] - ) - - def get_relevant_tags(self): - """Sorts relevant info from the spotipy metadata. Merges with any - provided tags from provide_tags method. - :rtype: a dict, parsed tags - """ - # TODO: come up with fallback solution if there's no metadata found - # follows this pattern: - # if this does not exist: - # set the thing that doesn't exist to a - # specific value from the metadata dict - tags = self.tags - metadata = self.metadata - - if not tags.get("title"): - tags["title"] = metadata["name"] - if not tags.get("artist"): - tags["artist"] = metadata["artists"][0]["name"] - if not tags.get("album"): - tags["album"] = metadata["album"]["name"] - if not tags.get("tracknumber"): - tags["tracknumber"] = str(metadata["track_number"]) - if not tags.get("albumart"): - tags["albumart"] = metadata["album"]["images"][0]["url"] - if not tags.get("genre") and self.spotify_searcher: - tags["genre"] = string.capwords(self.spotify_searcher.artist( - metadata["artists"][0]["uri"])["genres"][0]) - - self.tags = tags - return self.tags - - def __organize(self): - """Based off of self.current_location, self.end_location, and self. - file_name, this function creates folders for the end location and moves - the file there. - """ - if not self.end_location: - self.set_standard_organization() - - if not os.path.exists(self.end_location): - # try loop to prevent against race conditions with os.path.exists - # and os.makedirs - try: - os.makedirs(self.end_location) - except OSError as exc: - if exc.errno != errno.EEXIST: - raise - - os.rename( - self.current_location + "/" + self.file_name, - self.end_location + "/" + self.end_file_name, - ) - - def __parse_data(self): - """If a spotify searcher has not been provided, create one.""" - if not self.spotify_authenticated and not self.metadata: - self.spotify_searcher = spotify.SpotifySearcher().authorize() - self.spotify_authenticated = True - - """If metadata has not been provided, search for it.""" - if not self.metadata: - self.metadata = self.spotify_searcher.find_song( - self.song_title, self.artist_name - ) - - return self.metadata diff --git a/irs/install b/irs/install deleted file mode 160000 index 3a8323f..0000000 --- a/irs/install +++ /dev/null @@ -1 +0,0 @@ -Subproject commit 3a8323f39eda597ac5c4b4e2559577ca757aedc0 diff --git a/irs/interact/__init__.py b/irs/interact/__init__.py deleted file mode 100644 index e69de29..0000000 diff --git a/irs/interact/ripper.py b/irs/interact/ripper.py deleted file mode 100644 index b6dd57e..0000000 --- a/irs/interact/ripper.py +++ /dev/null @@ -1,50 +0,0 @@ -import os -import sys -import glob -import shutil - -import youtube_dl - - -def rip_from_url(video_url, output_name): - """This method downloads a video, converts it to an MP3 and renames it - :param video_url: a string, youtube url of the video you want to download - :param output_name: a string, the name of the output file - """ - - ydl_opts = { - 'format': 'bestaudio/best', - 'postprocessors': [{ - 'key': 'FFmpegExtractAudio', - 'preferredcodec': 'mp3', - 'preferredquality': '192', - }], - 'logger': _DownloadLogger(), - 'progress_hooks': [_download_hook], - 'output': "tmp_file", - 'prefer-ffmpeg': True, - 'ffmpeg_location': os.environ["irs_ffmpeg_dir"], - } - - with youtube_dl.YoutubeDL(ydl_opts) as ydl: - ydl.download([video_url]) - - for f in glob.glob("./*%s*" % video_url.split("/watch?v=")[-1]): - shutil.move(f, output_name) - - -class _DownloadLogger(object): - def debug(self, msg): - pass - - def warning(self, msg): - pass - - def error(self, msg): - print(msg) - - -# TODO: update the download log -def _download_hook(d): - if d['status'] == 'finished': - print("Done!") \ No newline at end of file diff --git a/irs/interact/tagger.py b/irs/interact/tagger.py deleted file mode 100644 index 26a6409..0000000 --- a/irs/interact/tagger.py +++ /dev/null @@ -1,67 +0,0 @@ -import sys - -if sys.version_info[0] >= 3: - from urllib.request import urlopen -elif sys.version_info[0] < 3: - from urllib import quote_plus, quote - from urllib import urlopen - -from mutagen.mp3 import EasyMP3 -from mutagen.easyid3 import EasyID3, EasyID3KeyError -from mutagen.id3 import APIC, ID3 - - -class Tagger(object): - """Attaches ID3 tags to MP3 files.""" - - def __init__(self, location): - """Initializes the class and generates ID3 tags for the mp3 - :param location: a string, the location of the mp3 that you want ID3 - tags on - """ - EasyID3.RegisterTextKey("comment", "COMM") - self.location = location - self.mp3 = EasyID3(self.location) - - def add_tag(self, tag, data): - """Adds a tag to the mp3 file you specified in __init__ and saves it - :param tag: a string, the name of the tag you want to add to the mp3 - valid tag names: - "title", "artist", "album", "genre", "tracknumber" (string), - "discnumber" (string), - "compilation" ("1" for true, "" for false) - :param data: a string, the data that you want to attach to the mp3 - under the specified tag name - """ - # For valid tags: `EasyID3.valid_keys.keys()` - self.mp3[tag] = data - self.mp3.save() - - def read_tag(self, tag): - """Tries to read a tag from the initialized mp3 file - :param tag: a string, the name of the tag you want to read - :rtype: an array with a string inside. The string inside the array is - the data you're requesting. If there's no tag associated or no data - attached with your requested tag, a blank array will be returned. - """ - try: - return self.mp3[tag] - except EasyID3KeyError or KeyError: - return [] - - def add_album_art(self, image_url): - """Adds album art to the initialized mp3 file - :param image_url: a string, the url of the image you want to attach to - the mp3 - """ - mp3 = EasyMP3(self.location, ID3=ID3) - mp3.tags.add( - APIC( - encoding = 3, - mime = 'image/png', - type = 3, - desc = 'cover', - data = urlopen(image_url).read() - ) - ) - mp3.save() \ No newline at end of file diff --git a/irs/search/__init__.py b/irs/search/__init__.py deleted file mode 100644 index e69de29..0000000 diff --git a/irs/search/spotify.py b/irs/search/spotify.py deleted file mode 100644 index 742ea9f..0000000 --- a/irs/search/spotify.py +++ /dev/null @@ -1,119 +0,0 @@ -import os -import sys -import re - -import spotipy -from spotipy.oauth2 import SpotifyClientCredentials - - -class SpotifySearcher(object): - """Searches spotify for song, album, and playlist metadata.""" - - def authorize(self, client_id=None, client_secret=None): - """Authorizes this class with spotify using client ids - :rtype: returns self class - """ - - # TODO: remove these when you finish config files - if not client_id: - client_id = os.environ["SPOTIFY_CLIENT_ID"] - if not client_secret: - client_secret = os.environ["SPOTIFY_CLIENT_SECRET"] - - try: - creds = SpotifyClientCredentials(client_id, client_secret) - self.authorized = True - self.spotify = spotipy.Spotify(client_credentials_manager=creds) - except Exception: - self.authorized = False - self.spotify = spotipy.Spotify() - - return self - - def find_song(self, song_title, artist_name, limit=50, offset=0): - """Searches spotify for a song and grabs its metadata - :param song_title: a string, the title of the song you're looking for - :param artist_name: a string, the artist of the above song - :rtype: a dictionary of metadata about the song - """ - songs = self.spotify.search(q=song_title, type="track")["tracks"] - - for song in songs["items"]: - if _simplify(song_title) in _simplify(song["name"]) and \ - _simplify(artist_name) in _simplify(song["artists"][0]["name"]): - return song - - if songs['next']: - return self.find_song(song_title, artist_name, - offset=offset + limit) - else: - print("There were no songs found by that name with that artist.") - sys.exit(1) - - def find_album(self, album_title, artist_name=None, limit=50, offset=0): - """Searches spotify for an album and grabs its contents and metadata - :param album_title: a string, the title of the album - :param artist_name: a string, the name of the artist of the album - :rtype: a dictionary of metadata about the album - """ - query = album_title - if artist_name: - query += " " + artist_name - albums = self.spotify.search(q=query, type="album")['albums'] - - for album in albums['items']: - if _simplify(album_title) in _simplify(album["name"]): - return self.spotify.album(album['uri']) - - if albums['next']: - return self.find_album(album_title, artist_name, - offset=offset + limit) - else: - print("There were no albums found by that name with that artist.") - sys.exit(1) - - def find_playlist(self, playlist_title, username, limit=50, offset=0): - """Searches spotify for a playlist and grabs its contents and metadata - :param playlist_title: a string, the title of the playlist - :param username: a string, the username of the playlist creator/owner - :rtype: a dictionary of metadata about the playlist - """ - playlists = [] - playlists = self.spotify.user_playlists(username, limit, offset) - - for playlist in playlists['items']: - if _simplify(playlist_title) in _simplify(playlist['name']): - return self.spotify.user_playlist(username, playlist['id']) - - if playlists['next']: - return self.find_playlist(playlist_title, username, - offset=offset + limit) - else: - print("There were no playlists by that name found.") - sys.exit(1) - - def artist(self, artist_uri): - """Gets artist metadata from uri - :param artist_uri: the spotify uri for the artist - :rtype: a dict of info about the artist - """ - return self.spotify.artist(artist_uri) - - def song(self, song_uri): - """Gets song metadata from uri - :param song_uri: the spotify uri for the artist - :rtype: a dict of info about the artist - """ - return self.spotify.track(song_uri) - - - -# TODO: export this function to a utilities file -def _simplify(string): - """Lowercases and strips all non alphanumeric characters from the string - :param string: a string to be modified - :rtype: the modified string - """ - if type(string) == bytes: - string = string.decode() - return re.sub(r'[^a-zA-Z0-9]+', '', string.lower()) \ No newline at end of file diff --git a/irs/search/youtube.py b/irs/search/youtube.py deleted file mode 100644 index 3cecc33..0000000 --- a/irs/search/youtube.py +++ /dev/null @@ -1,191 +0,0 @@ -import sys -import re - -if sys.version_info[0] >= 3: - from urllib.parse import urlencode - from urllib.request import urlopen -elif sys.version_info[0] < 3: - from urllib import urlencode - from urllib import urlopen -else: - print("Must be using Python 2 or 3") - sys.exit(1) - -from bs4 import BeautifulSoup - - -def find_url(song_title, artist_name, search_terms=None, caught_by_google=False, download_first=False): - """Finds the youtube video url for the requested song. The youtube - query is constructed like this: - " " - so plugging in "Bohemian Rhapsody", "Queen", and "lyrics" would end - up with a search for "Bohemian Rhapsody Queen lyrics" on youtube - :param-required song: song name - :param-required artist: artist name - :param search_terms: any additional search terms you may want to - add to the search query - :param caught_by_google: a boolean, if not false or none, turns on - the captcha catcher - :param download_first: a boolean, if true, downloads first video - that youtube returns - :rtype: A string of the youtube url for the song - """ - - query = artist_name + " " + song_title - if search_terms: - query += " " + search_terms - - encoded_query = urlencode({"search_query": query}) - - url = "http://www.youtube.com/results?" + encoded_query - - soup = _get_url_data(url, caught_by_google) - - # if you want to inspect the html being requested - # print(soup.prettify()) - # with open("index.html", "wb") as f: - # f.write(soup.prettify().encode('utf-8')) - - # Each of the tags in the results list have the following relevant - # attributes: - # "title": the title of the youtube video - # "href": the youtube video code, namely the X's of - # https://www.youtube.com/watch?v=XXXXXXXXXXX - # "class": the classes of the link, used to identify the youtube title - results = _find_links(soup) - - best_guess = None - total_tries_counter = 0 - - if len(results) <= 0: - raise Exception('There were no search results for "{}"'.format(query)) - - if download_first == True: - return "https://youtube.com" + results[0]["href"] - - scores = [] - - for index, link in enumerate(results): - scores.append([ - index, - _score_song(song_title, artist_name, link["title"]), - link["href"] - ]) - - # sort by the score of the song - sorted(scores, key=lambda x: x[1]) - - return "https://youtube.com" + results[scores[0][0]]["href"] - - -def _score_song(song_title, artist_name, video_title): - """Scores the likelihood of the song audio being in the video based off of - the video title. - :param song_title: a string, the title of the song that you're looking for - :param video_title: a string, the title of the video you're analyzing - :rtype: an integer, the score of the song - """ - points = 0 - - song_title = _simplify(song_title) - artist_name = _simplify(artist_name) - video_title = _simplify(video_title) - - if song_title in video_title: - points += 3 - - if artist_name in video_title: - points += 3 - - points -= _count_garbage_phrases(video_title, song_title) - - return points - - -def _simplify(string): - """Lowercases and strips all non alphanumeric characters from the string - :param string: a string to be modified - :rtype: the modified string - """ - if type(string) == bytes: - string = string.decode() - return re.sub(r'[^a-zA-Z0-9]+', '', string.lower()) - - -def _count_garbage_phrases(video_title, song_title): - """Checks if there are any phrases in the title of the video that would - indicate it doesn't have the audio we want - :param string: a string, the youtube video title - :param title: a string, the actual title of the song we're looking for - :rtype: an integer, of the number of bad phrases in the song - """ - - # Garbage phrases found through experiences of downloading the wrong song - # TODO: add this into the config so the user can mess with it if they want - garbage_phrases = ( - "cover album live clean rare version full full album row at " - "@ session how to npr music reimagined hr version" - ).split(" ") - - bad_phrases = 0 - - for gphrase in garbage_phrases: - # make sure we're not invalidating part of the title of the song - if gphrase in song_title.lower(): - continue - - # check if the garbage phrase is not in the video title - if gphrase in video_title.lower(): - bad_phrases += 1 - - return bad_phrases - - -def _find_links(soup): - """Finds youtube video links in the html soup - :param soup: a BeautifulSoup(...) element - :rtype: returns a list of valid youtube video links - """ - return list(filter(None, map(_find_link, soup.find_all("a")))) - - -def _find_link(link): - """Tests html tags to see if they contain a youtube video link. - Should be used only with the find_links function in a map func. - :param link: accepts an element from BeautifulSoup(...).find_all(...) - :rtype: returns the link if it's an actual video link, otherwise, None - """ - try: - class_to_check = str(" ".join(link["class"])) - except KeyError: - return - - # these classes are found by inspecting the html soup of a youtube search. - valid_classes = [ - "yt-simple-endpoint style-scope ytd-video-renderer", - ("yt-uix-tile-link yt-ui-ellipsis yt-ui-ellipsis-2 " - "yt-uix-sessionlink spf-link ") - ] - - try: - # Make sure it's not a playlist - if "&list=" in link["href"]: - return - - for valid_class in valid_classes: - if valid_class in class_to_check: - return link - except KeyError: - pass - - -# TODO: build in the captcha cheater if the user is "caught" by google -def _get_url_data(url, caught_by_google): - """Gets parsed html from the specified url - :param url: A string, the url to request and parse. - :param caught_by_google: A boolean, will open and use the captcha - cheat to get around google's captcha. - :rtype: A BeautifulSoup class - """ - html_content = urlopen(url).read() - return BeautifulSoup(html_content, 'html.parser') \ No newline at end of file diff --git a/setup.cfg b/setup.cfg deleted file mode 100644 index 79bc678..0000000 --- a/setup.cfg +++ /dev/null @@ -1,5 +0,0 @@ -[bdist_wheel] -# This flag says that the code is written to work on both Python 2 and Python -# 3. If at all possible, it is good practice to do this. If you cannot, you -# will need to generate wheels for each Python version that you support. -universal=1 diff --git a/setup.py b/setup.py deleted file mode 100644 index 05a66af..0000000 --- a/setup.py +++ /dev/null @@ -1,25 +0,0 @@ -from setuptools import setup - -setup( - name = 'irs', - version = '7.0.2', - description = 'A music downloader that gets metadata too.', - url = 'https://github.com/kepoorhampond/irs', - author = 'Kepoor Hampond', - author_email = 'kepoorh@gmail.com', - license = 'GPL', - packages = ['irs', 'irs.search', 'irs.interact', 'irs.glue', - 'irs.install', 'irs.cli'], - install_requires = [ - 'bs4', # HTML parsing - 'mutagen', # MP3 tags - 'argparse', # CLI arg parsing - 'spotipy', # Interfacing w/ Spotify API - 'ydl-binaries', # Downloading ffmpeg/ffprobe binaries - 'pyyaml', # Config files done simply - 'youtube-dl' # Download youtube videos - ], - entry_points = { - 'console_scripts': ['irs = irs.cli.cli:main'], - }, -) diff --git a/shard.lock b/shard.lock new file mode 100644 index 0000000..de2e9e8 --- /dev/null +++ b/shard.lock @@ -0,0 +1,6 @@ +version: 1.0 +shards: + spotify: + github: marceloboeira/spotify.cr + commit: 347727a4ebe4f3f4e55f6032de17cdd554a676bd + diff --git a/shard.yml b/shard.yml new file mode 100644 index 0000000..c54c51d --- /dev/null +++ b/shard.yml @@ -0,0 +1,17 @@ +name: irs +version: 0.1.0 + +authors: + - Cooper Hammond + +targets: + irs: + main: src/irs.cr + +crystal: 0.28.0 + +license: MIT + +dependencies: + spotify: + github: marceloboeira/spotify.cr \ No newline at end of file diff --git a/spec/irs_spec.cr b/spec/irs_spec.cr new file mode 100644 index 0000000..9562b57 --- /dev/null +++ b/spec/irs_spec.cr @@ -0,0 +1,9 @@ +require "./spec_helper" + +describe Irs do + # TODO: Write tests + + it "works" do + false.should eq(true) + end +end diff --git a/spec/spec_helper.cr b/spec/spec_helper.cr new file mode 100644 index 0000000..5c3c333 --- /dev/null +++ b/spec/spec_helper.cr @@ -0,0 +1,2 @@ +require "spec" +require "../src/irs" diff --git a/src/irs.cr b/src/irs.cr new file mode 100644 index 0000000..e493a31 --- /dev/null +++ b/src/irs.cr @@ -0,0 +1,6 @@ +# TODO: Write documentation for `IRS` +module IRS + VERSION = "0.1.0" + + # TODO: Put your code here +end diff --git a/src/search/spotify.cr b/src/search/spotify.cr new file mode 100644 index 0000000..edfe811 --- /dev/null +++ b/src/search/spotify.cr @@ -0,0 +1,104 @@ +require "base64" + +require "spotify" + + +class SpotifySearcher + @root_url = Path["https://api.spotify.com/v1/"] + + @access_header : (HTTP::Headers | Nil) = nil + @authorized = false + + # Saves an access token for future program use with spotify using client IDs. + # Specs defined on spotify's developer api: + # https://developer.spotify.com/documentation/general/guides/authorization-guide/#client-credentials-flow + # + # ``` + # SpotifySearcher.new().authorize("XXXXXXXXXX", "XXXXXXXXXX") + # ``` + def authorize(client_id : String, client_secret : String) + auth_url = "https://accounts.spotify.com/api/token" + + headers = HTTP::Headers{ + "Authorization" => "Basic " + + Base64.strict_encode "#{client_id}:#{client_secret}" + } + + payload = "grant_type=client_credentials" + + response = HTTP::Client.post(auth_url, headers: headers, form: payload) + + if response.status_code == 200 + access_token = JSON.parse(response.body)["access_token"] + + @access_header = HTTP::Headers{ + "Authorization" => "Bearer #{access_token}" + } + + @authorized = true + + end + + return self + end + + # Searches spotify and returns track metadata in `Hash` format. + # + # ``` + # spotify_searcher.find_track("Bohemian Rhapsody", "Queen") + # => hash of metadata + # ``` + def find_track(track_name : String, artist_name : String) + + query = "track:#{track_name.sub(" ", "+")}+" + + "artist:#{artist_name.sub(" ", "+")}" + + "&type=track" + + url = @root_url.join("search?q=#{query}").to_s() + + response = HTTP::Client.get(url, headers: @access_header) + + puts response.body + + end + + # Searches spotify with the specified parameters for the specified items + # + # ``` + # spotify_searcher.find_item("track", { + # "artist" => "Queen", + # "track" => "Bohemian Rhapsody" + # }) + # ``` + def find_item(item_type : String, item_parameters : Hash) + query = "" + + item_parameters.keys.each do |i| + query += "#{i.sub(" ", "+")}:#{item_parameters[i].sub(" ", "+")}+" + end + query += "&type=#{item_type}" + + url = @root_url.join("search?q=#{query}").to_s() + + response = HTTP::Client.get(url, headers: @access_header) + + if response.status_code != 200 + puts "There was an error with your request." + puts "Status code #{response.status_code}" + return nil + end + + items = JSON.parse(response.body)[item_type + "s"] + + end + +end + + +SpotifySearcher.new + .authorize("e4198f6a3f7b48029366f22528b5dc66", + "ba057d0621a5496bbb64edccf758bde5") + .find_item("track", { + "artist" => "Queen", + "track" => "Bohemian Rhapsody" + }) \ No newline at end of file