diff --git a/.gitignore b/.gitignore deleted file mode 100644 index 43b2d61..0000000 --- a/.gitignore +++ /dev/null @@ -1,13 +0,0 @@ -*~ -build -.coverage -dist -*.egg-info/ -.eggs/ -.hypothesis -*.pyc -__pycache__ -.pytest_cache -*.sw? -.tox -version.txt diff --git a/AUTHORS b/AUTHORS deleted file mode 100644 index 2d0a34a..0000000 --- a/AUTHORS +++ /dev/null @@ -1,3 +0,0 @@ -Copyright (C) 2015 The Software Heritage developers - -See http://www.softwareheritage.org/ for more information. diff --git a/LICENSE b/LICENSE deleted file mode 100644 index 94a9ed0..0000000 --- a/LICENSE +++ /dev/null @@ -1,674 +0,0 @@ - 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 -. diff --git a/Makefile.local b/Makefile.local deleted file mode 100644 index 249d0ef..0000000 --- a/Makefile.local +++ /dev/null @@ -1,2 +0,0 @@ -FLAG=-v -NOSEFLAGS=-v -s diff --git a/PKG-INFO b/PKG-INFO index 3a4aa50..8f98a0e 100644 --- a/PKG-INFO +++ b/PKG-INFO @@ -1,38 +1,38 @@ Metadata-Version: 2.1 Name: swh.model -Version: 0.0.29 +Version: 0.0.30 Summary: Software Heritage data model Home-page: https://forge.softwareheritage.org/diffusion/DMOD/ Author: Software Heritage developers Author-email: swh-devel@inria.fr License: UNKNOWN Project-URL: Bug Reports, https://forge.softwareheritage.org/maniphest -Project-URL: Funding, https://www.softwareheritage.org/donate Project-URL: Source, https://forge.softwareheritage.org/source/swh-model +Project-URL: Funding, https://www.softwareheritage.org/donate Description: swh-model ========= Implementation of the Data model of the Software Heritage project, used to archive source code artifacts. This module defines the notion of Persistent Identifier (PID) and provides tools to compute them: ```sh $ swh-identify fork.c kmod.c sched/deadline.c swh:1:cnt:2e391c754ae730bd2d8520c2ab497c403220c6e3 fork.c swh:1:cnt:0277d1216f80ae1adeed84a686ed34c9b2931fc2 kmod.c swh:1:cnt:57b939c81bce5d06fa587df8915f05affbe22b82 sched/deadline.c $ swh-identify --no-filename /usr/src/linux/kernel/ swh:1:dir:f9f858a48d663b3809c9e2f336412717496202ab ``` Platform: UNKNOWN Classifier: Programming Language :: Python :: 3 Classifier: Intended Audience :: Developers Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3) Classifier: Operating System :: OS Independent Classifier: Development Status :: 5 - Production/Stable Description-Content-Type: text/markdown Provides-Extra: testing diff --git a/bin/git-revhash b/bin/git-revhash deleted file mode 100755 index 69d1d1c..0000000 --- a/bin/git-revhash +++ /dev/null @@ -1,7 +0,0 @@ -#!/usr/bin/env bash - -# Use -# git-revhash 'tree 4b825dc642cb6eb9a060e54bf8d69288fbee4904\nparent 22c0fa5195a53f2e733ec75a9b6e9d1624a8b771\nauthor seanius 1138341044 +0000\ncommitter seanius 1138341044 +0000\n\nmaking dir structure...\n' # noqa -# output: 17a631d474f49bbebfdf3d885dcde470d7faafd7 - -echo -ne $* | git hash-object --stdin -t commit diff --git a/bin/swh-hashtree b/bin/swh-hashtree deleted file mode 100755 index faf258f..0000000 --- a/bin/swh-hashtree +++ /dev/null @@ -1,58 +0,0 @@ -#!/usr/bin/env python3 - -# Use sample: -# swh-hashtree --path . --ignore '.svn' --ignore '.git-svn' \ -# --ignore-empty-folders -# 38f8d2c3a951f6b94007896d0981077e48bbd702 - -import click -import os - -from swh.model import from_disk, hashutil - - -def combine_filters(*filters): - """Combine several ignore filters""" - if len(filters) == 0: - return from_disk.accept_all_directories - elif len(filters) == 1: - return filters[0] - - def combined_filter(*args, **kwargs): - return all(filter(*args, **kwargs) for filter in filters) - - return combined_filter - - -@click.command() -@click.option('--path', default='.', - help='Optional path to hash.') -@click.option('--ignore-empty-folder', is_flag=True, default=False, - help='Ignore empty folder.') -@click.option('--ignore', multiple=True, - help='Ignore pattern.') -def main(path, ignore_empty_folder=False, ignore=None): - - filters = [] - if ignore_empty_folder: - filters.append(from_disk.ignore_empty_directories) - if ignore: - filters.append( - from_disk.ignore_named_directories( - [os.fsencode(name) for name in ignore] - ) - ) - - try: - d = from_disk.Directory.from_disk(path=os.fsencode(path), - dir_filter=combine_filters(*filters)) - hash = d.hash - except Exception as e: - print(e) - return - else: - print(hashutil.hash_to_hex(hash)) - - -if __name__ == '__main__': - main() diff --git a/bin/swh-revhash b/bin/swh-revhash deleted file mode 100755 index c7e2998..0000000 --- a/bin/swh-revhash +++ /dev/null @@ -1,31 +0,0 @@ -#!/usr/bin/env python3 - -# Use: -# swh-revhash 'tree 4b825dc642cb6eb9a060e54bf8d69288fbee4904\nparent 22c0fa5195a53f2e733ec75a9b6e9d1624a8b771\nauthor seanius 1138341044 +0000\ncommitter seanius 1138341044 +0000\n\nmaking dir structure...\n' # noqa -# output: 17a631d474f49bbebfdf3d885dcde470d7faafd7 - -# To compare with git: -# git-revhash 'tree 4b825dc642cb6eb9a060e54bf8d69288fbee4904\nparent 22c0fa5195a53f2e733ec75a9b6e9d1624a8b771\nauthor seanius 1138341044 +0000\ncommitter seanius 1138341044 +0000\n\nmaking dir structure...\n' # noqa -# output: 17a631d474f49bbebfdf3d885dcde470d7faafd7 - - -import sys - -from swh.model import identifiers, hashutil - - -def revhash(revision_raw): - """Compute the revision hash. - - """ - if b'\\n' in revision_raw: # HACK: string have somehow their \n - # expanded to \\n - revision_raw = revision_raw.replace(b'\\n', b'\n') - - h = hashutil.hash_git_data(revision_raw, 'commit') - return identifiers.identifier_to_str(h) - - -if __name__ == '__main__': - revision_raw = sys.argv[1].encode('utf-8') - print(revhash(revision_raw)) diff --git a/docs/.gitignore b/docs/.gitignore deleted file mode 100644 index 58a761e..0000000 --- a/docs/.gitignore +++ /dev/null @@ -1,3 +0,0 @@ -_build/ -apidoc/ -*-stamp diff --git a/docs/Makefile b/docs/Makefile deleted file mode 100644 index b97c753..0000000 --- a/docs/Makefile +++ /dev/null @@ -1,2 +0,0 @@ -include ../../swh-docs/Makefile.sphinx --include Makefile.local diff --git a/docs/Makefile.local b/docs/Makefile.local deleted file mode 100644 index 352ffd3..0000000 --- a/docs/Makefile.local +++ /dev/null @@ -1,14 +0,0 @@ -sphinx/html: images -sphinx/clean: clean-images - -images: - make -C images/ -clean-images: - make -C images/ clean - -.PHONY: images clean-images - - -# Local Variables: -# mode: makefile -# End: diff --git a/docs/_static/.placeholder b/docs/_static/.placeholder deleted file mode 100644 index e69de29..0000000 diff --git a/docs/_templates/.placeholder b/docs/_templates/.placeholder deleted file mode 100644 index e69de29..0000000 diff --git a/docs/conf.py b/docs/conf.py deleted file mode 100644 index 190deb7..0000000 --- a/docs/conf.py +++ /dev/null @@ -1 +0,0 @@ -from swh.docs.sphinx.conf import * # NoQA diff --git a/docs/data-model.rst b/docs/data-model.rst deleted file mode 100644 index fc1639d..0000000 --- a/docs/data-model.rst +++ /dev/null @@ -1,257 +0,0 @@ -.. _data-model: - -Data model -========== - -.. note:: The text below is adapted from §7 of the article `Software Heritage: - Why and How to Preserve Software Source Code - `_ (in proceedings of `iPRES - 2017 `_, 14th International Conference on Digital - Preservation, by Roberto Di Cosmo and Stefano Zacchiroli), which also - provides a more general description of Software Heritage for the digital - preservation research community. - -In any archival project the choice of the underlying data model—at the logical -level, independently from how data is actually stored on physical media—is -paramount. The data model adopted by Software Heritage to represent the -information that it collects is centered around the notion of *software -artifact*, described below. - -It is important to notice that according to our principles, we must store with -every software artifact full information on where it has been found -(provenance), that is also captured in our data model, so we start by providing -some basic information on the nature of this provenance information. - - -Source code hosting places --------------------------- - -Currently, Software Heritage uses of a curated list of source code hosting -places to crawl. The most common entries we expect to place in such a list are -popular collaborative development forges (e.g., GitHub, Bitbucket), package -manager repositories that host source package (e.g., CPAN, npm), and FOSS -distributions (e.g., Fedora, FreeBSD). But we may of course allow also more -niche entries, such as URLs of personal or institutional project collections -not hosted on major forges. - -While currently entirely manual, the curation of such a list might easily be -semi-automatic, with entries suggested by fellow archivists and/or concerned -users that want to notify Software Heritage of the need of archiving specific -pieces of endangered source code. This approach is entirely compatible with -Web-wide crawling approaches: crawlers capable of detecting the presence of -source code might enrich the list. In both cases the list will remain curated, -with (semi-automated) review processes that will need to pass before a hosting -place starts to be used. - - -Software artifacts ------------------- - -Once the hosting places are known, they will need to be periodically looked at -in order to add to the archive missing software artifacts. Which software -artifacts will be found there? - -In general, each software distribution mechanism hosts multiple releases of a -given software at any given time. For VCS (Version Control Systems), this is -the natural behaviour; for software packages, while a single version of a -package is just a snapshot of the corresponding software product, one can often -retrieve both current and past versions of the package from its distribution -site. - -By reviewing and generalizing existing VCS and source package formats, we have -identified the following recurrent artifacts as commonly found at source code -hosting places. They form the basic ingredients of the Software Heritage -archive. As the terminology varies quite a bit from technology to technology, -we provide below both the canonical name used in Software Heritage and popular -synonyms. - -**contents** (AKA "blobs") - the raw content of (source code) files as a sequence of bytes, without file - names or any other metadata. File contents are often recurrent, e.g., across - different versions of the same software, different directories of the same - project, or different projects all together. - -**directories** - a list of named directory entries, each of which pointing to other artifacts, - usually file contents or sub-directories. Directory entries are also - associated to arbitrary metadata, which vary with technologies, but usually - includes permission bits, modification timestamps, etc. - -**revisions** (AKA "commits") - software development within a specific project is essentially a time-indexed - series of copies of a single "root" directory that contains the entire - project source code. Software evolves when a developer modifies the content - of one or more files in that directory and record their changes. - - Each recorded copy of the root directory is known as a "revision". It points - to a fully-determined directory and is equipped with arbitrary metadata. Some - of those are added manually by the developer (e.g., commit message), others - are automatically synthesized (timestamps, preceding commit(s), etc). - -**releases** (AKA "tags") - some revisions are more equals than others and get selected by developers as - denoting important project milestones known as "releases". Each release - points to the last commit in project history corresponding to the release and - might carry arbitrary metadata—e.g., release name and version, release - message, cryptographic signatures, etc. - - -Additionally, the following crawling-related information are stored as -provenance information in the Software Heritage archive: - -**origins** - code "hosting places" as previously described are usually large platforms - that host several unrelated software projects. For software provenance - purposes it is important to be more specific than that. - - Software origins are fine grained references to where source code artifacts - archived by Software Heritage have been retrieved from. They take the form of - ``(type, url)`` pairs, where ``url`` is a canonical URL (e.g., the address at - which one can ``git clone`` a repository or download a source tarball) and - ``type`` the kind of software origin (e.g., git, svn, or dsc for Debian - source packages). - -.. - **projects** - as commonly intended are more abstract entities that precise software - origins. Projects relate together several development resources, including - websites, issue trackers, mailing lists, as well as software origins as - intended by Software Heritage. - - The debate around the most apt ontologies to capture project-related - information for software hasn't settled yet, but the place projects will take - in the Software Heritage archive is fairly clear. Projects are abstract - entities, which will be arbitrarily nestable in a versioned - project/sub-project hierarchy, and that can be associated to arbitrary - metadata as well as origins where their source code can be found. - -**snapshots** - any kind of software origin offers multiple pointers to the "current" state - of a development project. In the case of VCS this is reflected by branches - (e.g., master, development, but also so called feature branches dedicated to - extending the software in a specific direction); in the case of package - distributions by notions such as suites that correspond to different maturity - levels of individual packages (e.g., stable, development, etc.). - - A "snapshot" of a given software origin records all entry points found there - and where each of them was pointing at the time. For example, a snapshot - object might track the commit where the master branch was pointing to at any - given time, as well as the most recent release of a given package in the - stable suite of a FOSS distribution. - -**visits** - links together software origins with snapshots. Every time an origin is - consulted a new visit object is created, recording when (according to - Software Heritage clock) the visit happened and the full snapshot of the - state of the software origin at the time. - - -Data structure --------------- - -.. _swh-merkle-dag: -.. figure:: images/swh-merkle-dag.svg - :width: 1024px - :align: center - - Software Heritage archive as a Merkle DAG, augmented with crawling - information (click to zoom). - - -With all the bits of what we want to archive in place, the next question is how -to organize them, i.e., which logical data structure to adopt for their -storage. A key observation for this decision is that source code artifacts are -massively duplicated. This is so for several reasons: - -* code hosting diaspora (i.e., project development moving to the most - recent/cool collaborative development technology over time); -* copy/paste (AKA "vendoring") of parts or entire external FOSS software - components into other software products; -* large overlap between revisions of the same project: usually only a very - small amount of files/directories are modified by a single commit; -* emergence of DVCS (distributed version control systems), which natively work - by replicating entire repository copies around. GitHub-style pull requests - are the pinnacle of this, as they result in creating an additional repository - copy at each change done by a new developer; -* migration from one VCS to another—e.g., migrations from Subversion to Git, - which are really popular these days—resulting in additional copies, but in a - different distribution format, of the very same development histories. - -These trends seem to be neither stopping nor slowing down, and it is reasonable -to expect that they will be even more prominent in the future, due to the -decreasing costs of storage and bandwidth. - -For this reason we argue that any sustainable storage layout for archiving -source code in the very long term should support deduplication, allowing to pay -for the cost of storing source code artifacts that are encountered more than -once only once. For storage efficiency, deduplication should be supported for -all the software artifacts we have discussed, namely: file contents, -directories, revisions, releases, snapshots. - -Realizing that principle, the Software Heritage archive is conceptually a -single (big) `Merkle Direct Acyclic Graph (DAG) -`_, as depicted in Figure -:ref:`Software Heritage Merkle DAG `. In such a graph each of -the artifacts we have described—from file contents up to entire -snapshots—correspond to a node. Edges between nodes emerge naturally: -directory entries point to other directories or file contents; revisions point -to directories and previous revisions, releases point to revisions, snapshots -point to revisions and releases. Additionally, each node contains all metadata -that are specific to the node itself rather than to pointed nodes; e.g., commit -messages, timestamps, or file names. Note that the structure is really a DAG, -and not a tree, due to the fact that the line of revisions nodes might be -forked and merged back. - -.. - directory: fff3cc22cb40f71d26f736c082326e77de0b7692 - parent: e4feb05112588741b4764739d6da756c357e1f37 - author: Stefano Zacchiroli - date: 1443617461 +0200 - committer: Stefano Zacchiroli - commiter_date: 1443617461 +0200 - message: - objstorage: fix tempfile race when adding objects - - Before this change, two workers adding the same - object will end up racing to write .tmp. - [...] - - revisionid: 64a783216c1ec69dcb267449c0bbf5e54f7c4d6d - A revision node in the Software Heritage DAG - -In a Merkle structure each node is identified by an intrinsic identifier -computed as a cryptographic hash of the node content. In the case of Software -Heritage identifiers are computed taking into account both node-specific -metadata and the identifiers of child nodes. - -Consider the revision node in the picture whose identifier starts with -`c7640e08d..`. it points to a directory (identifier starting with -`45f0c078..`), which has also been archived. That directory contains a full -copy, at a specific point in time, of a software component—in the example the -`Hello World `_ software -component available on our forge. The revision node also points to the -preceding revision node (`43ef7dcd..`) in the project development history. -Finally, the node contains revision-specific metadata, such as the author and -committer of the given change, its timestamps, and the message entered by the -author at commit time. - -The identifier of the revision node itself (`c7640e08d..`) is computed as a -cryptographic hash of a (canonical representation of) all the information shown -in figure. A change in any of them—metadata and/or pointed nodes—would result -in an entirely different node identifier. All other types of nodes in the -Software Heritage archive behave similarly. - -The Software Heritage archive inherits useful properties from the underlying -Merkle structure. In particular, deduplication is built-in. Any software -artifacts encountered in the wild gets added to the archive only if a -corresponding node with a matching intrinsic identifier is not already -available in the graph—file content, commits, entire directories or project -snapshots are all deduplicated incurring storage costs only once. - -Furthermore, as a side effect of this data model choice, the entire development -history of all the source code archived in Software Heritage—which ambitions to -match all published source code in the world—is available as a unified whole, -making emergent structures such as code reuse across different projects or -software origins, readily available. Further reinforcing the Software Heritage -use cases, this object could become a veritable "map of the stars" of our -entire software commons. diff --git a/docs/images/.gitignore b/docs/images/.gitignore deleted file mode 100644 index e9c694c..0000000 --- a/docs/images/.gitignore +++ /dev/null @@ -1,2 +0,0 @@ -swh-merkle-dag.pdf -swh-merkle-dag.svg diff --git a/docs/images/Makefile b/docs/images/Makefile deleted file mode 100644 index ddc859d..0000000 --- a/docs/images/Makefile +++ /dev/null @@ -1,17 +0,0 @@ - -MERKLE_DAG = swh-merkle-dag.pdf swh-merkle-dag.svg - -BUILD_TARGETS = -BUILD_TARGETS += $(MERKLE_DAG) - -all: $(BUILD_TARGETS) - - -%.svg: %.dia - inkscape -l $@ $< - -%.pdf: %.dia - inkscape -A $@ $< - -clean: - -rm -f $(BUILD_TARGETS) diff --git a/docs/images/swh-merkle-dag.dia b/docs/images/swh-merkle-dag.dia deleted file mode 100644 index 00edd64..0000000 Binary files a/docs/images/swh-merkle-dag.dia and /dev/null differ diff --git a/docs/index.rst b/docs/index.rst deleted file mode 100644 index 55ab5fd..0000000 --- a/docs/index.rst +++ /dev/null @@ -1,26 +0,0 @@ -.. _swh-model: - -Software Heritage - Data model -============================== - -Implementation of the :ref:`data-model` to archive source code artifacts. - - -.. toctree:: - :maxdepth: 2 - :caption: Contents: - - -Overview --------- - -* :ref:`data-model` -* :ref:`persistent-identifiers` - - -Indices and tables -================== - -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` diff --git a/docs/persistent-identifiers.rst b/docs/persistent-identifiers.rst deleted file mode 100644 index a588e9d..0000000 --- a/docs/persistent-identifiers.rst +++ /dev/null @@ -1,239 +0,0 @@ -.. _persistent-identifiers: - -Persistent identifiers -====================== - -You can point to objects present in the Software Heritage archive by the means -of **persistent identifiers** that are guaranteed to remain stable (persistent) -over time. Their syntax, meaning, and usage is described below. Note that they -are identifiers and not URLs, even though an URL-based resolver for Software -Heritage persistent identifiers is also provided. - -A persistent identifier can point to any software artifact (or "object") -available in the Software Heritage archive. Objects come in different types, -and most notably: - -* contents -* directories -* revisions -* releases -* snapshots - -Each object is identified by an intrinsic, type-specific object identifier that -is embedded in its persistent identifier as described below. Object identifiers -are strong cryptographic hashes computed on the entire set of object properties -to form a `Merkle structure `_. - -See :ref:`data-model` for an overview of object types and how they are linked -together. See :py:mod:`swh.model.identifiers` for details on how intrinsic -object identifiers are computed. - - -Syntax ------- - -Syntactically, persistent identifiers are generated by the ```` -entry point of the grammar: - -.. code-block:: bnf - - ::= "swh" ":" ":" ":" ; - ::= "1" ; - ::= - "snp" (* snapshot *) - | "rel" (* release *) - | "rev" (* revision *) - | "dir" (* directory *) - | "cnt" (* content *) - ; - ::= 40 * ; (* intrinsic object id, as hex-encoded SHA1 *) - ::= "0" | "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9" - ::= | "a" | "b" | "c" | "d" | "e" | "f" ; - - -Semantics ---------- - -``:`` is used as separator between the logical parts of identifiers. The -``swh`` prefix makes explicit that these identifiers are related to *SoftWare -Heritage*. ``1`` (````) is the current version of this -identifier *scheme*; future editions will use higher version numbers, possibly -breaking backward compatibility (but without breaking the resolvability of -identifiers that conform to previous versions of the scheme). - -A persistent identifier points to a single object, whose type is explicitly -captured by ````: - -* ``snp`` identifiers points to **snapshots**, -* ``rel`` to **releases**, -* ``rev`` to **revisions**, -* ``dir`` to **directories**, -* ``cnt`` to **contents**. - -The actual object pointed to is identified by the intrinsic identifier -````, which is a hex-encoded (using lowercase ASCII characters) SHA1 -computed on the content and metadata of the object itself, as follows: - -* for **snapshots**, intrinsic identifiers are computed as per - :py:func:`swh.model.identifiers.snapshot_identifier` - -* for **releases**, as per - :py:func:`swh.model.identifiers.release_identifier` - -* for **revisions**, as per - :py:func:`swh.model.identifiers.revision_identifier` - -* for **directories**, as per - :py:func:`swh.model.identifiers.directory_identifier` - -* for **contents**, the intrinsic identifier is the ``sha1_git`` hash of the - multiple hashes returned by - :py:func:`swh.model.identifiers.content_identifier`, i.e., the SHA1 of a byte - sequence obtained by juxtaposing the ASCII string ``"blob"`` (without - quotes), a space, the length of the content as decimal digits, a NULL byte, - and the actual content of the file. - - -Git compatibility -~~~~~~~~~~~~~~~~~ - -Intrinsic object identifiers for contents, directories, revisions, and releases -are, at present, compatible with the `Git `_ way of -`computing identifiers -`_ for its objects. -A Software Heritage content identifier will be identical to a Git blob -identifier of any file with the same content, a Software Heritage revision -identifier will be identical to the corresponding Git commit identifier, etc. -This is not the case for snapshot identifiers as Git doesn't have a -corresponding object type. - -Note that Git compatibility is incidental and is not guaranteed to be -maintained in future versions of this scheme (or Git). - - -Examples --------- - -* ``swh:1:cnt:94a9ed024d3859793618152ea559a168bbcbb5e2`` points to the content - of a file containing the full text of the GPL3 license -* ``swh:1:dir:d198bc9d7a6bcf6db04f476d29314f157507d505`` points to a directory - containing the source code of the Darktable photography application as it was - at some point on 4 May 2017 -* ``swh:1:rev:309cf2674ee7a0749978cf8265ab91a60aea0f7d`` points to a commit in - the development history of Darktable, dated 16 January 2017, that added - undo/redo supports for masks -* ``swh:1:rel:22ece559cc7cc2364edc5e5593d63ae8bd229f9f`` points to Darktable - release 2.3.0, dated 24 December 2016 -* ``swh:1:snp:c7c108084bc0bf3d81436bf980b46e98bd338453`` points to a snapshot - of the entire Darktable Git repository taken on 4 May 2017 from GitHub - - -Contextual information -====================== - -It is often useful to complement persistent identifiers with **contextual -information** about where the identified object has been found as well as which -specific parts of it are of interest. To that end it is possible, via a -dedicated syntax, to extend persistent identifiers with the following pieces of -information: - -* the **software origin** where an object has been found/observed -* the **line number(s)** of interest, usually within a content object - - -Syntax ------- - -The full-syntax to complement identifiers with contextual information is given -by the ```` entry point of the grammar: - -.. code-block:: bnf - - ::= [] [] - ::= ";" "lines" "=" ["-" ] - ::= ";" "origin" "=" - ::= + - ::= (* RFC 3986 compliant URLs *) - - -Semantics ---------- - -``;`` is used as separator between persistent identifiers and additional -optional contextual information. Each piece of contextual information is -specified as a key/value pair, using ``=`` as a separator. - -The following piece of contextual information are supported: - -* line numbers: it is possible to specify a single line number or a line range, - separating two numbers with ``-``. Note that line numbers are purely - indicative and are not meant to be stable, as in some degenerate cases - (e.g., text files which mix different types of line terminators) it is - impossible to resolve them unambiguously. - -* software origin: where a given object has been found or observed in the wild, - as the URI that was used by Software Heritage to ingest the object into the - archive - - -Resolution -========== - - -Dedicated resolvers -------------------- - -Persistent identifiers can be resolved using the Software Heritage Web -application (see :py:mod:`swh.web`). In particular, the **root endpoint** -``/`` can be given a persistent identifier and will lead to the browsing page -of the corresponding object, like this: -``https://archive.softwareheritage.org/``. - -A **dedicated** ``/resolve`` **endpoint** of the HTTP API is also available to -explicitly request persistent identifier resolution; see: -:http:get:`/api/1/resolve/(swh_id)/`. - -Examples: - -* ``_ -* ``_ -* ``_ -* ``_ -* ``_ - - -External resolvers ------------------- - -The following **independent resolvers** support resolution of Software -Heritage persistent identifiers: - -* `Identifiers.org `_; see: - ``_ (registry identifier `MIR:00000655 - `_). - -* `Name-to-Thing (N2T) `_ - -Examples: - -* ``_ -* ``_ -* ``_ -* ``_ -* ``_ - -Note that resolution via Identifiers.org does not support contextual -information, due to `syntactic incompatibilities -`_. - - -References -========== - -* Roberto Di Cosmo, Morane Gruenpeter, Stefano Zacchiroli. `Identifiers for - Digital Objects: the Case of Software Source Code Preservation - `_. In Proceedings of `iPRES - 2018 `_: 15th International Conference on Digital - Preservation, Boston, MA, USA, September 2018, 9 pages. - - diff --git a/pytest.ini b/pytest.ini deleted file mode 100644 index e86f7f4..0000000 --- a/pytest.ini +++ /dev/null @@ -1,3 +0,0 @@ -[pytest] -addopts = --doctest-modules -norecursedirs = docs diff --git a/requirements-test.txt b/requirements-test.txt deleted file mode 100644 index e079f8a..0000000 --- a/requirements-test.txt +++ /dev/null @@ -1 +0,0 @@ -pytest diff --git a/swh.model.egg-info/PKG-INFO b/swh.model.egg-info/PKG-INFO index 3a4aa50..8f98a0e 100644 --- a/swh.model.egg-info/PKG-INFO +++ b/swh.model.egg-info/PKG-INFO @@ -1,38 +1,38 @@ Metadata-Version: 2.1 Name: swh.model -Version: 0.0.29 +Version: 0.0.30 Summary: Software Heritage data model Home-page: https://forge.softwareheritage.org/diffusion/DMOD/ Author: Software Heritage developers Author-email: swh-devel@inria.fr License: UNKNOWN Project-URL: Bug Reports, https://forge.softwareheritage.org/maniphest -Project-URL: Funding, https://www.softwareheritage.org/donate Project-URL: Source, https://forge.softwareheritage.org/source/swh-model +Project-URL: Funding, https://www.softwareheritage.org/donate Description: swh-model ========= Implementation of the Data model of the Software Heritage project, used to archive source code artifacts. This module defines the notion of Persistent Identifier (PID) and provides tools to compute them: ```sh $ swh-identify fork.c kmod.c sched/deadline.c swh:1:cnt:2e391c754ae730bd2d8520c2ab497c403220c6e3 fork.c swh:1:cnt:0277d1216f80ae1adeed84a686ed34c9b2931fc2 kmod.c swh:1:cnt:57b939c81bce5d06fa587df8915f05affbe22b82 sched/deadline.c $ swh-identify --no-filename /usr/src/linux/kernel/ swh:1:dir:f9f858a48d663b3809c9e2f336412717496202ab ``` Platform: UNKNOWN Classifier: Programming Language :: Python :: 3 Classifier: Intended Audience :: Developers Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3) Classifier: Operating System :: OS Independent Classifier: Development Status :: 5 - Production/Stable Description-Content-Type: text/markdown Provides-Extra: testing diff --git a/swh.model.egg-info/SOURCES.txt b/swh.model.egg-info/SOURCES.txt index 8fa4241..9976003 100644 --- a/swh.model.egg-info/SOURCES.txt +++ b/swh.model.egg-info/SOURCES.txt @@ -1,63 +1,41 @@ -.gitignore -AUTHORS -LICENSE MANIFEST.in Makefile -Makefile.local README.md -pytest.ini requirements-swh.txt -requirements-test.txt requirements.txt setup.py -tox.ini version.txt -bin/git-revhash -bin/swh-hashtree -bin/swh-revhash -docs/.gitignore -docs/Makefile -docs/Makefile.local -docs/conf.py -docs/data-model.rst -docs/index.rst -docs/persistent-identifiers.rst -docs/_static/.placeholder -docs/_templates/.placeholder -docs/images/.gitignore -docs/images/Makefile -docs/images/swh-merkle-dag.dia swh/__init__.py swh.model.egg-info/PKG-INFO swh.model.egg-info/SOURCES.txt swh.model.egg-info/dependency_links.txt swh.model.egg-info/entry_points.txt swh.model.egg-info/requires.txt swh.model.egg-info/top_level.txt swh/model/__init__.py swh/model/cli.py swh/model/exceptions.py swh/model/from_disk.py swh/model/hashutil.py swh/model/identifiers.py swh/model/merkle.py swh/model/toposort.py swh/model/validators.py swh/model/fields/__init__.py swh/model/fields/compound.py swh/model/fields/hashes.py swh/model/fields/simple.py swh/model/tests/__init__.py swh/model/tests/generate_testdata_from_disk.py swh/model/tests/test_cli.py swh/model/tests/test_from_disk.py swh/model/tests/test_hashutil.py swh/model/tests/test_identifiers.py swh/model/tests/test_merkle.py swh/model/tests/test_toposort.py swh/model/tests/test_validators.py swh/model/tests/data/dir-folders/sample-folder.tgz swh/model/tests/fields/__init__.py swh/model/tests/fields/test_compound.py swh/model/tests/fields/test_hashes.py swh/model/tests/fields/test_simple.py \ No newline at end of file diff --git a/swh.model.egg-info/requires.txt b/swh.model.egg-info/requires.txt index 091cefe..30a1eca 100644 --- a/swh.model.egg-info/requires.txt +++ b/swh.model.egg-info/requires.txt @@ -1,5 +1,5 @@ -Click vcversioner +Click [testing] pytest diff --git a/tox.ini b/tox.ini deleted file mode 100644 index 0fb07c6..0000000 --- a/tox.ini +++ /dev/null @@ -1,16 +0,0 @@ -[tox] -envlist=flake8,py3 - -[testenv:py3] -deps = - .[testing] - pytest-cov -commands = - pytest --cov=swh --cov-branch {posargs} - -[testenv:flake8] -skip_install = true -deps = - flake8 -commands = - {envpython} -m flake8 diff --git a/version.txt b/version.txt index 8eba90c..8e5fdc0 100644 --- a/version.txt +++ b/version.txt @@ -1 +1 @@ -v0.0.29-0-gfa140b2 \ No newline at end of file +v0.0.30-0-gb8fadd1 \ No newline at end of file