Metadata-Version: 2.1
Name: listcondalic
Version: 0.1.0
Summary: List license requirement of a project based on configuration file.
Home-page: https://github.com/we-taper/listcondalic
Author: Taper
Author-email: hongxiang.chen.94@gmail.com
License: UNKNOWN
Project-URL: Bug Reports, https://github.com/we-taper/listcondalic/issues
Project-URL: Source, https://github.com/we-taper/listcondalic/
Description: # List license information from package specification file
        
        ## Conda
        
        For Conda environment:
        
        1. Create an environment specification file. Please follow [this guide](https://conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html#exporting-the-environment-yml-file)
           to create this file.
        2. Edit the file and remove all unnecessary dependencies (very important, otherwise the
           it is easy to get inundated with too much packages). For example, remove things like `ipython`,
           `ipykernel`, which are used for purpose other than the library itself.
        3. Install this package.
        4. Run:
        
        ```bash
        listcondalic conda environment.yml > output.json
        ```
        
        Here `environment.yml` should be the environment specification file.
        The package licence information will be saved at `output.json`.
        
        ## Pip
        
        Note: We use [liccheck](https://pypi.org/project/liccheck/) internally to produce the analysis.
        
        1. Create your package specification file (e.g. `requirements.txt`) 
           including all the packages required.
           [pipreqs](https://pypi.org/project/pipreqs/) is a good helping tool for this as well.
        2. Install this package
        3. Run:
        
        ```bash
        listcondalic pip requirements.txt > output.json
        ```
        
        The package licence information will be saved at `output.json`.
        
        ## Existing problems
        
        This packages isn't quite clever yet:
        
        - It tries to skip a few packages such as `python', 'setuptools', 'wheel' and 'pip`.
          Hopefully, we won't neglect any important packages.
        - It only understand very basic package specifications in the conda environment file.
          Complicated package sources (e.g. `-e .`, `git`-based packages) will likely create
          bugs in the result.
        
Keywords: license,compliance,development
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Build Tools
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3 :: Only
Requires-Python: >=3.7, <4
Description-Content-Type: text/markdown
