Skip to main content

Access Free Open Source License information on the command line

Project description

fossl

Python versions PyPI version License

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.

% 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
% 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,

% 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 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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

fossl-0.12.0.tar.gz (13.8 kB view hashes)

Uploaded Source

Built Distribution

fossl-0.12.0-py3-none-any.whl (9.6 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page