Metadata-Version: 1.0
Name: spark-package
Version: 0.2
Summary: A command line tool for creating Spark Packages and generating release distributions
Home-page: https://github.com/databricks/spark-package-cmd-tool
Author: Burak Yavuz
Author-email: feedback@spark-packages.org
License: Apache-2.0
Description: spark-package Command Line Tool
        ===============================
        
        Command Line Tool for working with `Spark Packages`_
        
        .. _Spark Packages: http://spark-packages.org
        
        Usage
        -----
        
        The `spark-package` command line tool is your helper when developing new `Spark Packages`.
        
        The tool provides two methods: `init` and `zip`. Use `spark-package -h` to see the list of available
        commands and options.
        
        init
        ----
        
        Initializes an empty project. Sets up the recommended directory layout and provides templates for
        required files. The tool will prompt the user to select a license, but users may skip this process 
        by selecting the value for `other license (decide later)`. 
        
        A name must be supplied with the flag `-n` or `--name`. The name must match the name of the github 
        repository of the package. The layout for python can be generated with the flag `-p` or `--python`, 
        scala can be generated with `-s` or `--scala` and java folders can be generated with `-j` or `--java`. 
        An output directory for the package can be supplied with `-o` or `--out`. The default for the output 
        path is the current working directory.
        Example usage:
         
        Generate a folder called "package" in the current directory setup with all files regarding to scala.
        
        ```
        spark-package init -n "test/package"
        ```
        
        Generate a folder called "package" in $PACKAGE_PATH setup with all files regarding to scala and python.
        
        ```
        spark-package init -s -p -n "test/package" -o $PACKAGE_PATH
        ```
        
        zip
        ---
        
        Creates a zip file for distribution on the Spark Packages website. If your package has java or 
        scala code, use the `sbt-spark-package` plugin as it is more advanced. If your package is comprised 
        of just python code, use this command.
        
        The package name must be supplied with `-n` or `--name`. In addition, the root directory of the 
        package must be supplied with `-f` or `--folder`. In addition, users must supply the version of the 
        release they want to distribute with the flag `-v` or `--version`. The output directory of the 
        zip file can be configured through `-o` or `--out`. The default path is the current working directory.
        
        Example Usage:
        
        Generate a zip file for distribution on the Spark Packages website with release version 0.2.1.
        
        ```
        spark-package zip -f $PACKAGE_PATH -n "test/package" -v "0.2.1"
        ```
        
        Contributions
        -------------
        If you encounter bugs or want to contribute, feel free to submit an issue or pull request.
        
        
Platform: UNKNOWN
