{ "info": { "author": "Patrick Senti", "author_email": "patrick.senti@productaize.io", "bugtrack_url": null, "classifiers": [ "License :: OSI Approved :: Apache Software License", "Programming Language :: Python", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.6", "Programming Language :: Python :: Implementation :: CPython" ], "description": "PyLicenses\n==========\n\nFind license types and texts for all installed packages in conda and pip\nenvironments, producing a distribution-ready file THIRDPARTY-LICENSES\nwith required details on all packages, including their respective license texts.\n\nWhy yet another tool?\n---------------------\n\nThere are several packages with similar intents, however I did not find any\nto match the particular usecase PyLicenses covers. Specifically to produce\na complete set of licenses for all installed packages, at the package level\n(as opposed to the file level as many other such tools do).Also I wanted to have\na focused tool that is easily extensible to any framework, in any language.\n\nFeatures\n--------\n\nPyLicense\n\n* produces the THIRDPARTY-LICENSES file as a report on all packages\n* collects data from conda, pip, pypi and github to retrieve information\n on authorship, package homepage, license style and - most importantly -\n the actual license text.\n* uses a pipeline of scanners/data collectors. Adding a new framework to\n scan (e.g. to include npm modules) is a matter of writing a new PackageProvider\n class with a single method.\n* produces reports and statistics on primary packages (direct dependency) and\n secondary packages (pulled-in through a dependency), notably this works across\n conda and pip. Statistics currently include counts per license type.\n* highlights packages were the license information or license text is missing\n* can map packages to a fixed license URL for packages that do not include\n the license text or where the LICENSE file is difficult to find by automated\n means.\n\n\nHow to use\n----------\n\nWithin your conda or pip virtualenv, run\n\n $ python -m pylicense\n\nTo see options\n\n $ python -m pylicense -h\n usage: __main__.py [-h] [--github GITHUB] [--stats STATS]\n\n optional arguments:\n -h, --help show this help message and exit\n --github GITHUB specify github user,password\n --stats STATS print statistics\n\nSample output\n-------------\n\nSee the THIRDPARTY-LICENSES file in this repository for the full license\ncollection report of this package.\n\nThe direct output looks something like this\n\n $ python -m pylicense\n Packages directly required:\n\n name author license\n ---------- -------------------------- -----------------------\n pylicenses Patrick Senti Apache 2.0\n wheel Daniel Holth Other\n urllib3 Andrey Petrov MIT\n tabulate Sergey Astanin MIT\n sh Andrew Moffat MIT\n setuptools Python Packaging Authority MIT License\n requests Kenneth Reitz Apache Software License\n pip The pip developers MIT\n certifi Kenneth Reitz MPL-2.0\n libedit NetBSD\n python PSF\n\n Packages pulled in through other requirements:\n\n name author license\n --------------- ---------------- --------------------------------------\n idna Kim Davies BSD Like\n chardet Daniel Blanchard GNU Lesser General Public License v2.1\n ca-certificates ISC\n libffi MIT\n libgcc-ng GPL\n libstdcxx-ng GPL3 with runtime exception\n ncurses Free software - X11 License\n openssl OpenSSL\n readline GPL3\n sqlite Public-Domain\n xz Public-Domain, GPL\n zlib zlib\n\n **SUCCESS** Good news. There are no packages without license texts\n\n **SUCCESS** The full license report is available in THIRDPARTY-LICENSES\n\n\nHow to implement a new scanner\n------------------------------\n\n1. Add a class in `pylicenses.provider`, e.g.\n\n class MyPackageScanner(PackageProvider):\n def get_packages_info(self, packages, subset=None)\n ... your code to update packages ...\n return packages\n\n `packages` is a dictionary mapping `name=>data`, where `name` is either\n the package's canonical name or the full distribution name (name-version-type),\n and `data` is the data collected so far. For programming convenience all mapping\n of the same package, independent of the key, reference the same `data` object.\n\n Currently there are only very few conventions for the contents of data:\n\n * `name` is the name of package without version or distribution type\n * `dist_name` is the full distribution name (name-version or name-version-type)\n * `license` is the canonical license name (e.g. MIT, Apache-2.0 etc.)\n * `license_text` is the actual license text\n * `license_source` is the filename/URL to the source of the license text\n * `license_trace` is the last scanner to update the data\n\n Any other data can be stored by the scanners as they see fit. Note the\n dependency on `PackageProvider` as a base class is a convenience only.\n\n2. Add the new scanner class to PyLicenses.PROVIDERS\n\n3. Add unit tests\n\nLicense\n-------\n\nMIT License - Copyright (c) 2018 Patrick Senti, productaize.io\nSee LICENSE file\n\n\n", "description_content_type": "", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/miraculixx/pylicenses", "keywords": "", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "pylicenses", "package_url": "https://pypi.org/project/pylicenses/", "platform": "", "project_url": "https://pypi.org/project/pylicenses/", "project_urls": { "Homepage": "https://github.com/miraculixx/pylicenses" }, "release_url": "https://pypi.org/project/pylicenses/0.1/", "requires_dist": [ "sh (==1.12.14)", "requests (==2.21.0)", "tabulate (==0.8.2)" ], "requires_python": "", "summary": "License scanning and documentation for conda and pip envs", "version": "0.1" }, "last_serial": 4599196, "releases": { "0.1": [ { "comment_text": "", "digests": { "md5": "077ce818850a7aa7db3406121d37b68a", "sha256": "90342aa36afdeeb573a12f6148f283d051643d672e4d329f20669e6f26fab3dd" }, "downloads": -1, "filename": "pylicenses-0.1-py3-none-any.whl", "has_sig": false, "md5_digest": "077ce818850a7aa7db3406121d37b68a", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 14471, "upload_time": "2018-12-14T12:52:36", "url": "https://files.pythonhosted.org/packages/57/89/a77f1cccd48c446bd8de3b532de332bef285b43bc3b2df785993f4c24f29/pylicenses-0.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "f7f46b184949997171f17c3bb697cb8b", "sha256": "13e8c13b3edbc88040410bc79c35032da1bf835053836e56fe450dd40f52a9ac" }, "downloads": -1, "filename": "pylicenses-0.1.tar.gz", "has_sig": false, "md5_digest": "f7f46b184949997171f17c3bb697cb8b", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 12339, "upload_time": "2018-12-14T12:52:38", "url": "https://files.pythonhosted.org/packages/d6/c4/8bf60bb12c9d94fda12c34513d14f3d2f02b960b52b2e0ef045919ece11a/pylicenses-0.1.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "077ce818850a7aa7db3406121d37b68a", "sha256": "90342aa36afdeeb573a12f6148f283d051643d672e4d329f20669e6f26fab3dd" }, "downloads": -1, "filename": "pylicenses-0.1-py3-none-any.whl", "has_sig": false, "md5_digest": "077ce818850a7aa7db3406121d37b68a", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 14471, "upload_time": "2018-12-14T12:52:36", "url": "https://files.pythonhosted.org/packages/57/89/a77f1cccd48c446bd8de3b532de332bef285b43bc3b2df785993f4c24f29/pylicenses-0.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "f7f46b184949997171f17c3bb697cb8b", "sha256": "13e8c13b3edbc88040410bc79c35032da1bf835053836e56fe450dd40f52a9ac" }, "downloads": -1, "filename": "pylicenses-0.1.tar.gz", "has_sig": false, "md5_digest": "f7f46b184949997171f17c3bb697cb8b", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 12339, "upload_time": "2018-12-14T12:52:38", "url": "https://files.pythonhosted.org/packages/d6/c4/8bf60bb12c9d94fda12c34513d14f3d2f02b960b52b2e0ef045919ece11a/pylicenses-0.1.tar.gz" } ] }