diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..454f9d9 --- /dev/null +++ b/.gitignore @@ -0,0 +1,19 @@ +.eggs/ +/sgloader/__pycache__/ +/dataset/ +*.pyc +/.coverage +/.coverage.* +/scratch/swhgitloader.cProfile +/scratch/swhgitloader.profile +/scratch/save.p +*.egg-info +version.txt +/resources/repo-linux-to-load.ini +/resources/repo-to-load.ini +build/ +dist/ +.hypothesis +.pytest_cache +.tox/ +.mypy_cache/ diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml new file mode 100644 index 0000000..69b3349 --- /dev/null +++ b/.pre-commit-config.yaml @@ -0,0 +1,40 @@ +repos: +- repo: https://github.com/pre-commit/pre-commit-hooks + rev: v2.4.0 + hooks: + - id: trailing-whitespace + - id: flake8 + - id: check-json + - id: check-yaml + +- repo: https://github.com/codespell-project/codespell + rev: v1.16.0 + hooks: + - id: codespell + +- repo: local + hooks: + - id: mypy + name: mypy + entry: mypy + args: [swh] + pass_filenames: false + language: system + types: [python] + +- repo: https://github.com/python/black + rev: 19.10b0 + hooks: + - id: black + +# unfortunately, we are far from being able to enable this... +# - repo: https://github.com/PyCQA/pydocstyle.git +# rev: 4.0.0 +# hooks: +# - id: pydocstyle +# name: pydocstyle +# description: pydocstyle is a static analysis tool for checking compliance with Python docstring conventions. +# entry: pydocstyle --convention=google +# language: python +# types: [python] + diff --git a/AUTHORS b/AUTHORS new file mode 100644 index 0000000..2d0a34a --- /dev/null +++ b/AUTHORS @@ -0,0 +1,3 @@ +Copyright (C) 2015 The Software Heritage developers + +See http://www.softwareheritage.org/ for more information. diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..0ad22b5 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,78 @@ +# Software Heritage Code of Conduct + +## Our Pledge + +In the interest of fostering an open and welcoming environment, we as Software +Heritage contributors and maintainers pledge to making participation in our +project and our community a harassment-free experience for everyone, regardless +of age, body size, disability, ethnicity, sex characteristics, gender identity +and expression, level of experience, education, socio-economic status, +nationality, personal appearance, race, religion, or sexual identity and +orientation. + +## Our Standards + +Examples of behavior that contributes to creating a positive environment +include: + +* Using welcoming and inclusive language +* Being respectful of differing viewpoints and experiences +* Gracefully accepting constructive criticism +* Focusing on what is best for the community +* Showing empathy towards other community members + +Examples of unacceptable behavior by participants include: + +* The use of sexualized language or imagery and unwelcome sexual attention or + advances +* Trolling, insulting/derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or electronic + address, without explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Our Responsibilities + +Project maintainers are responsible for clarifying the standards of acceptable +behavior and are expected to take appropriate and fair corrective action in +response to any instances of unacceptable behavior. + +Project maintainers have the right and responsibility to remove, edit, or +reject comments, commits, code, wiki edits, issues, and other contributions +that are not aligned to this Code of Conduct, or to ban temporarily or +permanently any contributor for other behaviors that they deem inappropriate, +threatening, offensive, or harmful. + +## Scope + +This Code of Conduct applies within all project spaces, and it also applies when +an individual is representing the project or its community in public spaces. +Examples of representing a project or community include using an official +project e-mail address, posting via an official social media account, or acting +as an appointed representative at an online or offline event. Representation of +a project may be further defined and clarified by project maintainers. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported by contacting the project team at `conduct@softwareheritage.org`. All +complaints will be reviewed and investigated and will result in a response that +is deemed necessary and appropriate to the circumstances. The project team is +obligated to maintain confidentiality with regard to the reporter of an +incident. Further details of specific enforcement policies may be posted +separately. + +Project maintainers who do not follow or enforce the Code of Conduct in good +faith may face temporary or permanent repercussions as determined by other +members of the project's leadership. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, +available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html + +[homepage]: https://www.contributor-covenant.org + +For answers to common questions about this code of conduct, see +https://www.contributor-covenant.org/faq diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..94a9ed0 --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + 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/MANIFEST.in b/MANIFEST.in index fe3bc0d..4f7a412 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -1,7 +1,8 @@ include README.md include Makefile include requirements*.txt include version.txt +include conftest.py recursive-include swh/loader/git/tests/data * recursive-include swh/loader/git/tests/data *.bundle *.tgz recursive-include swh py.typed diff --git a/PKG-INFO b/PKG-INFO index 343d708..e45ea2e 100644 --- a/PKG-INFO +++ b/PKG-INFO @@ -1,101 +1,101 @@ Metadata-Version: 2.1 Name: swh.loader.git -Version: 0.3.3 +Version: 0.3.4 Summary: Software Heritage git loader Home-page: https://forge.softwareheritage.org/diffusion/DLDG/ 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-loader-git Project-URL: Documentation, https://docs.softwareheritage.org/devel/swh-loader-git/ Description: swh-loader-git ============== The Software Heritage Git Loader is a tool and a library to walk a local Git repository and inject into the SWH dataset all contained files that weren't known before. License ------- 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. See top-level LICENSE file for the full text of the GNU General Public License along with this program. Dependencies ------------ ### Runtime - python3 - python3-dulwich - python3-retrying - python3-swh.core - python3-swh.model - python3-swh.storage - python3-swh.scheduler ### Test - python3-nose Requirements ------------ - implementation language, Python3 - coding guidelines: conform to PEP8 - Git access: via dulwich Configuration ------------- You can run the loader from a remote origin (*loader*) or from an origin on disk (*from_disk*) directly by calling: ``` python3 -m swh.loader.git.{loader,from_disk} ``` ### Location Both tools expect a configuration file. Either one of the following location: - /etc/softwareheritage/ - ~/.config/swh/ - ~/.swh/ Note: Will call that location $SWH_CONFIG_PATH ### Configuration sample Respectively the loader from a remote (`git.yml`) and the loader from a disk (`git-disk.yml`), $SWH_CONFIG_PATH/loader/git{-disk}.yml: ``` storage: cls: remote args: url: http://localhost:5002/ ``` 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 Requires-Python: >=3.7 Description-Content-Type: text/markdown Provides-Extra: testing diff --git a/bin/dir-git-repo-meta.sh b/bin/dir-git-repo-meta.sh new file mode 100755 index 0000000..9c5617c --- /dev/null +++ b/bin/dir-git-repo-meta.sh @@ -0,0 +1,31 @@ +#!/usr/bin/env bash + +# count the number of type (tree, blob, tag, commit) +REPO=${1-`pwd`} +TYPE=${2-"all"} + +data() { + git rev-list --objects --all \ + | git cat-file --batch-check='%(objectname) %(objecttype) %(rest)' \ + | cut -f2 -d' ' \ + | grep $1 \ + | wc -l +} + +cd $REPO + +if [ "$TYPE" = "all" ]; then + NB_BLOBS=$(data "blob") + NB_TREES=$(data "tree") + NB_COMMITS=$(data "commit") + NB_TAGS=$(data "tag") + cat < FIXME: find a means to compute docs from sql + +From this point on, `signatures` means: +- the git sha1s, the sha1 and sha256 the object's content for object of type +content +- the git sha1s for all other object types (directories, contents, revisions, +occurrences, releases) + +A worker is one instance running swh-loader-git to parse and load a repository +in the backend. It is not distributed. + +The backend api discuss with one or many workers. +It is distributed. + +# Scenario + +In the following, we will describe with different granularities what will +happen between 1 worker and the backend api. + +## 1 + +A worker parses a repository. +It sends the parsing result to the backend in muliple requests/responses. +The worker sends list of sha1s (git sha1s) encountered. +The server responds with an unknowns sha1s list. +The worker sends those sha1s and their associated data to the server. +The server store what it receives. + +## 2 + +01. Worker parses local repository and build a memory model of it. + +02. HAVE: Worker sends repository's contents signatures to the backend for it +to filter what it knows. +03. WANT: Backend replies with unknown contents sha1s. +04. SAVE: Worker sends all `content` data through 1 (or more) request(s). +05. SAVED: Backend stores them and finish the transaction(s). + +06. HAVE: Worker sends repository's directories' signatures to the backend for +it to filter. +07. WANT: Backend replies with unknown directory sha1s. +08. SAVE: Worker sends all `directory`s' data through 1 (or more) request(s). +09. SAVED: Backend stores them and finish the transaction(s). + +10. HAVE: Worker sends repository's revisions' signatures to the backend. +11. WANT: Backend replies with unknown revisions' sha1s. +12. SAVE: Worker sends the `revision`s' data through 1 (or more) request(s). +13. SAVED: Backend stores them and finish the transaction(s). + +14. SAVE: Worker sends repository's occurrences for the backend to save what it +does not know yet. +15. SAVE: Worker sends repository's releases for the backend to save what it +does not know yet. +16. Worker is done. + +## 3 + +01. Worker parses repository and builds a data memory model. +The data memory model has the following structure for each possible type: +- signatures list +- map indexed by git sha1, object representation. +Type of object; content, directory, revision, release, occurrence is kept. + +02. Worker sends in the api backend's protocol the sha1s. + +03. Api Backend receives the list of sha1s, filters out +unknown sha1s and replies to the worker. + +04. Worker receives the list of unknown sha1s. +The worker builds the unknowns `content`s' list. + +A list of contents, for each content: +- git's sha1 (when parsing git repository) +- sha1 content (as per content's sha1) +- sha256 content +- content's size +- content + +And sends it to the api's backend. + +05. Backend receives the data and: +- computes from the `content` the signatures (sha1, sha256). FIXME: Not implemented yet +- checks the signatures match the client's data FIXME: Not Implemented yet +- Stores the content on the file storage +- Persist in the db the received data +If any errors is detected during the process (checksum do not match, writing +error, ...), the db transaction is rollbacked and a failure is sent to the +client. +Otherwise, the db transaction is committed and a success is sent back to the +client. + +*Note* Optimization possible: slice in multiple queries. + +06. Worker receives the result from the api. +If failure, worker stops. The task is done. +Otherwise, the worker continues by sending the list of `directory` structure. + +A list of directories, for each directory: +- sha1 +- directory's content +- list of directory entries: + - name : relative path to parent entry or root + - sha1 : pointer to the object this directory points to + - type : whether entry is a file or a dir + - perms : unix-like permissions + - atime : time of last access FIXME: Not the right time yet + - mtime : time of last modification FIXME: Not the right time yet + - ctime : time of last status change FIXME: Not the right time yet + - directory: parent directory sha1 + +And sends it to the api's backend. + +*Note* Optimization possible: slice in multiple queries. + +07. Api backend receives the data. +Persists the directory's content on the file storage. +Persist the directory and directory entries on the db's side in respect to the +previous directories and contents stored. + +If any error is raised, the transaction is rollbacked and an error is sent back +to the client (worker). +Otherwise, the transaction is committed and the success is sent back to the +client. + +08. Worker receives the result from the api. +If failure, worker stops. The task is done. +Otherwise, the worker continues by building the list of unknown `revision`s. + +A list of revisions, for each revision: +- sha1, the revision's sha1 +- revision's parent sha1s, the list of revision parents +- content, the revision's content +- revision's date +- directory id the revision points to +- message, the revision's message +- author +- committer + +And sends it to the api's backend. + +*Note* Optimization possible: slice in multiple queries. + +09. Api backend receives data. +Persists the revisions' content on the file storage. +Persist the directory and directory entries on the db's side in respect to the +previous directories and contents stored. + +If any error is raised, the transaction is rollbacked and an error is sent back +to the client (worker). +Otherwise, the transaction is committed and the success is sent back to the +client. + +10. Worker receives the result. Worker sends the complete occurrences list. + +A list of occurrences, for each occurrence: +- sha1, the sha1 the occurrences points to +- reference, the occurrence's name +- url-origin, the origin of the repository + + +11. The backend receives the list of occurrences and persist only what it does +not know. Acks the result to the backend. + +12. Worker sends the complete releases list. + +A list of releases, for each release: +- sha1, the release sha1 +- content, the content of the appointed commit +- revision, the sha1 the release points to +- name, the release's name +- date, the release's date # FIXME: find the tag's date, +- author, the release's author information +- comment, the release's message + +13. The backend receives the list of releases and persists only what it does +not know. Acks the result to the backend. + +14. Worker received the result and stops anyway. The task is done. + +## Protocol details + +- worker serializes the content's payload (python data structure) as pickle +format +- backend unserializes the request's payload as python data structure diff --git a/docs/attic/git-loading-design.txt b/docs/attic/git-loading-design.txt new file mode 100644 index 0000000..dfcaee4 --- /dev/null +++ b/docs/attic/git-loading-design.txt @@ -0,0 +1,136 @@ +Design considerations +===================== + +* **Caching**: our storage contains two main parts: a file storage, and a git + object storage. Both parts are accessible as key-value storage. Whenever + possible we want to avoid checking in content that is provably already in + there. + +* **Concurrency**: our storage will be accessed concurrently for both read and + write purposes. In particular for writing, it is possible that multiple + workers will be in the process, at the same time, of loading into our storage + different git repositories that have a lot of overlap, if not completely + identical. Whenever possible they should be able to benefit from each other's + work, collaborating *de facto*. + +* **Robustness**: workers that load content into our storage might crash before + completion. Wherever possible, the work done before completion should be + preserved by the storage. Eventually another worker (possibly the same as + before) will pickup the same git repository, try it again, and drive it to + completion. + +* **Ctime and Atimes**: for every piece of content we are interested in both + creation time ("ctime", i.e., the first time we have seen a given content and + added it to our storage) and access times ("atime", i.e., every time we see + the same content *elsewhere* we want to be able to store the fact we have + seen it *again*, and again, and again...). + +* **Transactionality**: every content addition should be transactional: only + after having stored the content in full will we tell the world (and other + workers) that the content is available. (Without locking, which is desirable) + This might result in temporary races where multiple workers trying to add the + same content without knowing of each other---this situation should be handled + gracefully. + + Transactionality should apply across different storage media: in particular + the filesystem used to store file content and the DB used to store the + corresponding metadata should cooperate. It is OK for the filesystem to have + content that is not indexed in the DB; but for all purposes that should be + equivalent to not having stored the content *at all*. + + +Git traversal +============= + +To load the whole content of a git repo in our storage we need to traverse the +git object graph, and inject every single version of every single file we find. +We discuss below how we should traverse the git graph to that end. + +For the sake of conciseness we do not distinguish git object types. The actual +code does need to treat differently different kind of git objects though (and +in particular commits -> trees -> and blobs); see the implementation for +details about this. + + +Top-down +-------- + +* Top-down, topological (latest first) traversal of the git object graph + starting from the current refs is optimal from the point of view of caching. + Once a given object is found in the cache we know that we have already loaded + it in the storage and we do not need to treat its parents any further. + +* Top-down however is not good for robustness. If we store the current node + before its parents and the loading fails to complete, in the future we + will believe to have stored all its parents whereas we have not. + FAIL. + +Conclusion: pure top-down traversal is bad for us. + + +Bottom-up +--------- + +* Bottom-up, topological traversal is good for robustness. Once we reach the + top we know we have stored all its parents, so in the future we can + benefit from caching. + +* However, bottom-up is bad for caching. If we always treat parents before + descendants, we will benefit from caching only at the level of individual + objects, and never at the level of whole subgraphs. + +Conclusion: pure bottom-up traversal is OK, but does not allow to benefit from +subgraph caching. + + +Mixed top-down/bottom-up +------------------------ + +To get the best of both worlds we need a mixed approach, something like +(pseudocode): + + let rec load_git_graph node = + if not (node in storage) then + for parent in parents(node) + load_git_graph(parent) + add_to_storage(node, storage) + +Note: non tail-recursive. + +Conclusion: the above offers both robustness w.r.t. loading crashes and +subgraph caching. + + +Atime maintenance +----------------- + +Bad news: with the mixed approach it's easy to maintain ctimes, but atimes +cannot be maintained (because we do not visit at all subgraphs). More +generally: subgraph caching or atime maintenance <- choose one. + +If we do want to maintain atimes (at this level---as opposed to, say, do that +separately from git repo loading) we need to give up on subgraph caching. If we +do that, top-down vs bottom-up doesn't really matter. + + +Cross file system + DB transactions +=================================== + +To ensure file system DB transaction, to add a single file to our storage we +proceed as follows, where KEY is the key of the file to be added, and WORKER_ID +the unique identifier of the worker that is updating the storage: + +1. BEGIN TRANSACTION +2. create file KEY.WORKER_ID, overwriting destination if needed +3. write file content to KEY.WORKER_ID +4. rename(KEY.WORKER_ID, KEY), overwriting destination if needed +5. INSERT KEY INTO ... +6. COMMIT + +any error in the above would cause a transaction ABORT. + +Failure scenarios (that should all be handled properly by the above protocol): + +* worker crash, at any moment during the above +* parallel execution, resulting in one worker failing due to key duplication + upon step (5) or (6) diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 0000000..190deb7 --- /dev/null +++ b/docs/conf.py @@ -0,0 +1 @@ +from swh.docs.sphinx.conf import * # NoQA diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000..2f825fd --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,15 @@ +.. _swh-loader-git: + +Software Heritage - Git loader +============================== + +Loader for `Git `_ repositories. + + +Reference Documentation +----------------------- + +.. toctree:: + :maxdepth: 2 + + /apidoc/swh.loader.git diff --git a/mypy.ini b/mypy.ini new file mode 100644 index 0000000..f916912 --- /dev/null +++ b/mypy.ini @@ -0,0 +1,21 @@ +[mypy] +namespace_packages = True +warn_unused_ignores = True + + +# 3rd party libraries without stubs (yet) + +[mypy-celery.*] +ignore_missing_imports = True + +[mypy-dulwich.*] +ignore_missing_imports = True + +[mypy-pkg_resources.*] +ignore_missing_imports = True + +[mypy-pytest.*] +ignore_missing_imports = True + +[mypy-swh.loader.*] +ignore_missing_imports = True diff --git a/pytest.ini b/pytest.ini new file mode 100644 index 0000000..e085539 --- /dev/null +++ b/pytest.ini @@ -0,0 +1,5 @@ +[pytest] +# Drop this when these fixtures aren't imported automatically +addopts = -p no:pytest_swh_scheduler -p no:pytest_swh_storage + +norecursedirs = docs diff --git a/resources/local-loader-git.ini b/resources/local-loader-git.ini new file mode 100644 index 0000000..da492be --- /dev/null +++ b/resources/local-loader-git.ini @@ -0,0 +1,10 @@ +[main] +# Where to store the logs +log_dir = /tmp/swh-loader-git/log + +# how to access the backend (remote or local) +backend-type = local + +# backend-type remote: url access to api rest's backend +# backend-type local: configuration file to backend file .ini (cf. back.ini file) +backend = ~/.config/swh/back.ini diff --git a/resources/remote-loader-git.ini b/resources/remote-loader-git.ini new file mode 100644 index 0000000..223e9c1 --- /dev/null +++ b/resources/remote-loader-git.ini @@ -0,0 +1,10 @@ +[main] +# Where to store the logs +log_dir = /tmp/swh-loader-git/log + +# how to access the backend (remote or local) +backend-type = remote + +# backend-type remote: url access to api rest's backend +# backend-type local: configuration file to backend file .ini (cf. back.ini file) +backend = http://localhost:5000 diff --git a/resources/test/back.ini b/resources/test/back.ini new file mode 100644 index 0000000..927957e --- /dev/null +++ b/resources/test/back.ini @@ -0,0 +1,22 @@ +[main] + +# where to store blob on disk +content_storage_dir = /tmp/swh-loader-git/test/content-storage + +# Where to store the logs +log_dir = /tmp/swh-loader-git/test/log + +# url access to db: dbname= (host= port= user= password=) +db_url = dbname=softwareheritage-dev-test + +# compute folder's depth on disk aa/bb/cc/dd +#folder_depth = 4 + +# To open to the world, 0.0.0.0 +#host = 127.0.0.1 + +# Debugger (for dev only) +debug = true + +# server port to listen to requests +port = 5001 diff --git a/resources/test/db-manager.ini b/resources/test/db-manager.ini new file mode 100644 index 0000000..679bc8c --- /dev/null +++ b/resources/test/db-manager.ini @@ -0,0 +1,7 @@ +[main] + +# Where to store the logs +log_dir = swh-loader-git/log + +# url access to db +db_url = dbname=softwareheritage-dev-test diff --git a/resources/updater.ini b/resources/updater.ini new file mode 100644 index 0000000..da492be --- /dev/null +++ b/resources/updater.ini @@ -0,0 +1,10 @@ +[main] +# Where to store the logs +log_dir = /tmp/swh-loader-git/log + +# how to access the backend (remote or local) +backend-type = local + +# backend-type remote: url access to api rest's backend +# backend-type local: configuration file to backend file .ini (cf. back.ini file) +backend = ~/.config/swh/back.ini diff --git a/setup.py b/setup.py index 8c29841..eb7ee54 100755 --- a/setup.py +++ b/setup.py @@ -1,71 +1,72 @@ #!/usr/bin/env python3 # Copyright (C) 2015-2020 The Software Heritage developers # See the AUTHORS file at the top-level directory of this distribution # License: GNU General Public License version 3, or any later version # See top-level LICENSE file for more information from setuptools import setup, find_packages from os import path from io import open here = path.abspath(path.dirname(__file__)) # Get the long description from the README file with open(path.join(here, "README.md"), encoding="utf-8") as f: long_description = f.read() def parse_requirements(name=None): if name: reqf = "requirements-%s.txt" % name else: reqf = "requirements.txt" requirements = [] if not path.exists(reqf): return requirements with open(reqf) as f: for line in f.readlines(): line = line.strip() if not line or line.startswith("#"): continue requirements.append(line) return requirements setup( name="swh.loader.git", description="Software Heritage git loader", long_description=long_description, long_description_content_type="text/markdown", python_requires=">=3.7", author="Software Heritage developers", author_email="swh-devel@inria.fr", url="https://forge.softwareheritage.org/diffusion/DLDG/", packages=find_packages(), scripts=[], install_requires=parse_requirements() + parse_requirements("swh"), - setup_requires=["vcversioner"], + setup_requires=["setuptools-scm"], + use_scm_version=True, extras_require={"testing": parse_requirements("test")}, vcversioner={}, include_package_data=True, entry_points=""" [swh.workers] loader.git=swh.loader.git:register """, classifiers=[ "Programming Language :: Python :: 3", "Intended Audience :: Developers", "License :: OSI Approved :: GNU General Public License v3 (GPLv3)", "Operating System :: OS Independent", "Development Status :: 5 - Production/Stable", ], project_urls={ "Bug Reports": "https://forge.softwareheritage.org/maniphest", "Funding": "https://www.softwareheritage.org/donate", "Source": "https://forge.softwareheritage.org/source/swh-loader-git", "Documentation": "https://docs.softwareheritage.org/devel/swh-loader-git/", }, ) diff --git a/swh.loader.git.egg-info/PKG-INFO b/swh.loader.git.egg-info/PKG-INFO index 343d708..e45ea2e 100644 --- a/swh.loader.git.egg-info/PKG-INFO +++ b/swh.loader.git.egg-info/PKG-INFO @@ -1,101 +1,101 @@ Metadata-Version: 2.1 Name: swh.loader.git -Version: 0.3.3 +Version: 0.3.4 Summary: Software Heritage git loader Home-page: https://forge.softwareheritage.org/diffusion/DLDG/ 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-loader-git Project-URL: Documentation, https://docs.softwareheritage.org/devel/swh-loader-git/ Description: swh-loader-git ============== The Software Heritage Git Loader is a tool and a library to walk a local Git repository and inject into the SWH dataset all contained files that weren't known before. License ------- 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. See top-level LICENSE file for the full text of the GNU General Public License along with this program. Dependencies ------------ ### Runtime - python3 - python3-dulwich - python3-retrying - python3-swh.core - python3-swh.model - python3-swh.storage - python3-swh.scheduler ### Test - python3-nose Requirements ------------ - implementation language, Python3 - coding guidelines: conform to PEP8 - Git access: via dulwich Configuration ------------- You can run the loader from a remote origin (*loader*) or from an origin on disk (*from_disk*) directly by calling: ``` python3 -m swh.loader.git.{loader,from_disk} ``` ### Location Both tools expect a configuration file. Either one of the following location: - /etc/softwareheritage/ - ~/.config/swh/ - ~/.swh/ Note: Will call that location $SWH_CONFIG_PATH ### Configuration sample Respectively the loader from a remote (`git.yml`) and the loader from a disk (`git-disk.yml`), $SWH_CONFIG_PATH/loader/git{-disk}.yml: ``` storage: cls: remote args: url: http://localhost:5002/ ``` 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 Requires-Python: >=3.7 Description-Content-Type: text/markdown Provides-Extra: testing diff --git a/swh.loader.git.egg-info/SOURCES.txt b/swh.loader.git.egg-info/SOURCES.txt index df2a14b..088b7d3 100644 --- a/swh.loader.git.egg-info/SOURCES.txt +++ b/swh.loader.git.egg-info/SOURCES.txt @@ -1,34 +1,57 @@ +.gitignore +.pre-commit-config.yaml +AUTHORS +CODE_OF_CONDUCT.md +LICENSE MANIFEST.in Makefile README.md +conftest.py +mypy.ini pyproject.toml +pytest.ini requirements-swh.txt requirements-test.txt requirements.txt setup.cfg setup.py +tox.ini version.txt +bin/dir-git-repo-meta.sh +docs/.gitignore +docs/Makefile +docs/conf.py +docs/index.rst +docs/_static/.placeholder +docs/_templates/.placeholder +docs/attic/api-backend-protocol.txt +docs/attic/git-loading-design.txt +resources/local-loader-git.ini +resources/remote-loader-git.ini +resources/updater.ini +resources/test/back.ini +resources/test/db-manager.ini swh/__init__.py swh.loader.git.egg-info/PKG-INFO swh.loader.git.egg-info/SOURCES.txt swh.loader.git.egg-info/dependency_links.txt swh.loader.git.egg-info/entry_points.txt swh.loader.git.egg-info/requires.txt swh.loader.git.egg-info/top_level.txt swh/loader/__init__.py swh/loader/git/__init__.py swh/loader/git/converters.py swh/loader/git/from_disk.py swh/loader/git/loader.py swh/loader/git/py.typed swh/loader/git/tasks.py swh/loader/git/utils.py swh/loader/git/tests/__init__.py swh/loader/git/tests/conftest.py swh/loader/git/tests/test_converters.py swh/loader/git/tests/test_from_disk.py swh/loader/git/tests/test_loader.py swh/loader/git/tests/test_tasks.py swh/loader/git/tests/test_utils.py swh/loader/git/tests/data/testrepo.tgz swh/loader/git/tests/data/git-repos/example-submodule.bundle \ No newline at end of file diff --git a/tox.ini b/tox.ini new file mode 100644 index 0000000..fcbf344 --- /dev/null +++ b/tox.ini @@ -0,0 +1,40 @@ +[tox] +envlist=black,flake8,mypy,py3 + +[testenv] +extras = + testing +deps = + # the dependency below is needed for now as a workaround for + # https://github.com/pypa/pip/issues/6239 + # TODO: remove when this issue is fixed + swh.core[http] >= 0.0.61 + swh.storage[testing] + swh.scheduler[testing] >= 0.5.0 + pytest-cov +commands = + pytest --cov={envsitepackagesdir}/swh/loader/git \ + {envsitepackagesdir}/swh/loader/git \ + --cov-branch {posargs} + +[testenv:black] +skip_install = true +deps = + black +commands = + {envpython} -m black --check swh + +[testenv:flake8] +skip_install = true +deps = + flake8 +commands = + {envpython} -m flake8 + +[testenv:mypy] +extras = + testing +deps = + mypy +commands = + mypy swh