Skip to main content

Verify software licenses of your open source software

Project description

License: MIT CircleCI

The goal of this repository is to create a simple utility that you can simply run in your repository to check compliance of your 3rd party dependencies.

https://webscopeio.github.io/license.sh/#/

License compliance tool for your software. We're currently in Beta phase, please feel free to help us with providing bugreports & submitting PRs.

Installation

  1. 🐍 Install pip https://pip.pypa.io/en/stable/installing/
  2. 💻 pip install license-sh

Usage

Run the following command inside your repository.

license-sh

Screenshot

Supported Lanaguages & Package managers

  • Javascript
    • NPM
    • Yarn
  • Python
    • pipenv
  • Java
    • maven

Contribution guide

You need to set-up a repository and install dependencies using pipenv.

# clone the repo
$ git clone git@github.com:webscopeio/license.sh.git
# install pipenv
$ pipenv install
# run the project
$ pipenv run ./license-sh <path_to_test_project>

Running tests

pipenv run python -m unittest

Documentation

docsify serve ./docs

Packaging

Read https://packaging.python.org/tutorials/packaging-projects/

  1. Run python3 setup.py sdist bdist_wheel.
  1. It will generate .tar.gz file in dist/ directory which you can
  2. install with pip install <file.tar.gz>

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

license-sh-1.0.11.tar.gz (190.6 kB view hashes)

Uploaded Source

Built Distribution

license_sh-1.0.11-py3-none-any.whl (186.2 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