| Name | fossl JSON |
| Version |
0.12.0
JSON |
| download |
| home_page | None |
| Summary | Access Free Open Source License information on the command line |
| upload_time | 2023-11-18 19:18:20 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.9,<4 |
| license | None |
| keywords |
cli
console
licensing
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# fossl
[](https://pypi.org/project/fossl/)
[](https://pypi.org/project/fossl/)
[](https://pypi.org/project/fossl/)
fossl provides descriptions of the most common free open source (FOSS) licenses. Instructions on how to apply a license to the source code are included. The information is obtained from GitHub i.e. is always up-to-date. The license texts for "LICENSE" files can also be downloaded.
```sh
% fossl list
AGPL-3.0 - GNU Affero General Public License v3.0
Apache-2.0 - Apache License 2.0
BSD-2-Clause - BSD 2-Clause "Simplified" License
BSD-3-Clause - BSD 3-Clause "New" or "Revised" License
CC0-1.0 - Creative Commons Zero v1.0 Universal
EPL-2.0 - Eclipse Public License 2.0
GPL-2.0 - GNU General Public License v2.0
GPL-3.0 - GNU General Public License v3.0
LGPL-2.1 - GNU Lesser General Public License v2.1
LGPL-3.0 - GNU Lesser General Public License v3.0
MIT - MIT License
MPL-2.0 - Mozilla Public License 2.0
Unlicense - The Unlicense
```
```sh
% fossl show Apache-2.0
SPDX ID: │ Apache-2.0
Name: │ Apache License 2.0
Description: │ A permissive license whose main conditions require
│ preservation of copyright and license notices.
│ Contributors provide an express grant of patent rights.
│ Licensed works, modifications, and larger works may be
│ distributed under different terms and without source
│ code.
Implementation: │ Create a text file (typically named LICENSE or
│ LICENSE.txt) in the root of your source code and copy
│ the text of the license into the file.
Permissions: │ commercial-use, modifications, distribution, patent-use,
│ private-use
Conditions │ include-copyright, document-changes
Limitations: │ trademark-use, liability, warranty
HTML URL: │ http://choosealicense.com/licenses/apache-2.0/
GitHub API URL: │ https://api.github.com/licenses/apache-2.0
Featured on GitHub: │ Yes
```
Finally,
```sh
% fossl show MIT -text > LICENSE
```
creates a LICENSE file for a new project.
`fossl` can also be used as a Python package, allowing Python code to access license information.
## Limitations
GitHub limits the number of queries a user may make per hour. For unauthenticated users like `fossl`, that [rate limit](https://docs.github.com/en/rest/overview/resources-in-the-rest-api?apiVersion=2022-11-28#rate-limiting) is 60 / hour. `fossl` caches license information locally (`~/.config/fossl.toml`) to work around the rate limit. The license cache is updated every 90 days or if the cache file is deleted.
Raw data
{
"_id": null,
"home_page": null,
"name": "fossl",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9,<4",
"maintainer_email": null,
"keywords": "cli,console,licensing",
"author": null,
"author_email": "Ralf Luetkemeier <foss@rlue.de>",
"download_url": "https://files.pythonhosted.org/packages/a8/aa/cf4b231828f4c8a98621614e32b846052ce69d2c7b3beee6eb0bb665cb9c/fossl-0.12.0.tar.gz",
"platform": null,
"description": "# fossl\n\n[](https://pypi.org/project/fossl/)\n[](https://pypi.org/project/fossl/)\n[](https://pypi.org/project/fossl/)\n\nfossl provides descriptions of the most common free open source (FOSS) licenses. Instructions on how to apply a license to the source code are included. The information is obtained from GitHub i.e. is always up-to-date. The license texts for \"LICENSE\" files can also be downloaded.\n\n```sh\n% fossl list\nAGPL-3.0 - GNU Affero General Public License v3.0\nApache-2.0 - Apache License 2.0\nBSD-2-Clause - BSD 2-Clause \"Simplified\" License\nBSD-3-Clause - BSD 3-Clause \"New\" or \"Revised\" License\nCC0-1.0 - Creative Commons Zero v1.0 Universal\nEPL-2.0 - Eclipse Public License 2.0\nGPL-2.0 - GNU General Public License v2.0\nGPL-3.0 - GNU General Public License v3.0\nLGPL-2.1 - GNU Lesser General Public License v2.1\nLGPL-3.0 - GNU Lesser General Public License v3.0\nMIT - MIT License\nMPL-2.0 - Mozilla Public License 2.0\nUnlicense - The Unlicense\n```\n\n```sh\n% fossl show Apache-2.0\nSPDX ID: \u2502 Apache-2.0\nName: \u2502 Apache License 2.0\nDescription: \u2502 A permissive license whose main conditions require\n \u2502 preservation of copyright and license notices.\n \u2502 Contributors provide an express grant of patent rights.\n \u2502 Licensed works, modifications, and larger works may be\n \u2502 distributed under different terms and without source\n \u2502 code.\nImplementation: \u2502 Create a text file (typically named LICENSE or\n \u2502 LICENSE.txt) in the root of your source code and copy\n \u2502 the text of the license into the file.\nPermissions: \u2502 commercial-use, modifications, distribution, patent-use,\n \u2502 private-use\nConditions \u2502 include-copyright, document-changes\nLimitations: \u2502 trademark-use, liability, warranty\nHTML URL: \u2502 http://choosealicense.com/licenses/apache-2.0/\nGitHub API URL: \u2502 https://api.github.com/licenses/apache-2.0\nFeatured on GitHub: \u2502 Yes\n```\n\nFinally,\n\n```sh\n% fossl show MIT -text > LICENSE\n```\n\ncreates a LICENSE file for a new project.\n\n`fossl` can also be used as a Python package, allowing Python code to access license information.\n\n## Limitations\n\nGitHub limits the number of queries a user may make per hour. For unauthenticated users like `fossl`, that [rate limit](https://docs.github.com/en/rest/overview/resources-in-the-rest-api?apiVersion=2022-11-28#rate-limiting) is 60 / hour. `fossl` caches license information locally (`~/.config/fossl.toml`) to work around the rate limit. The license cache is updated every 90 days or if the cache file is deleted.\n",
"bugtrack_url": null,
"license": null,
"summary": "Access Free Open Source License information on the command line",
"version": "0.12.0",
"project_urls": null,
"split_keywords": [
"cli",
"console",
"licensing"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "2852bb81f44036ae1659f59b881e4a75ae3fdadb092e2bf3a0dfbaa126ce49e3",
"md5": "70e12915533c6fe9ab8023e5d89db070",
"sha256": "b5736fdd2052827950b82af6b5ec18427bd9e53222245385460b6b81cd223bfb"
},
"downloads": -1,
"filename": "fossl-0.12.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "70e12915533c6fe9ab8023e5d89db070",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9,<4",
"size": 9551,
"upload_time": "2023-11-18T19:18:18",
"upload_time_iso_8601": "2023-11-18T19:18:18.331369Z",
"url": "https://files.pythonhosted.org/packages/28/52/bb81f44036ae1659f59b881e4a75ae3fdadb092e2bf3a0dfbaa126ce49e3/fossl-0.12.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "a8aacf4b231828f4c8a98621614e32b846052ce69d2c7b3beee6eb0bb665cb9c",
"md5": "bfd62999482b3edd6a7d7e7333f69910",
"sha256": "c7609738ac2a5121565fd064c1430757005d31d409e0502d0b0c3e115d38cfc4"
},
"downloads": -1,
"filename": "fossl-0.12.0.tar.gz",
"has_sig": false,
"md5_digest": "bfd62999482b3edd6a7d7e7333f69910",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9,<4",
"size": 13814,
"upload_time": "2023-11-18T19:18:20",
"upload_time_iso_8601": "2023-11-18T19:18:20.006294Z",
"url": "https://files.pythonhosted.org/packages/a8/aa/cf4b231828f4c8a98621614e32b846052ce69d2c7b3beee6eb0bb665cb9c/fossl-0.12.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-18 19:18:20",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "fossl"
}
