Metadata-Version: 2.1
Name: pyct
Version: 0.4.3
Summary: python package common tasks for users (e.g. copy examples, fetch data, ...)
Home-page: http://github.com/pyviz/pyct
License: BSD-3
Description: # pyct
        
        A utility package that when installed makes various commands available
        to other packages. (Currently no sophisticated plugin system, just a
        try import/except in the other packages.) The same commands are
        available from within python. Can either add new subcommands to an
        existing argparse based command if the module has an existing command,
        or create the entire command if the module has no existing command.
        
        Currently, there are commands for:
        
          * Copying examples and fetching data
        
        
        ## Copying examples and fetching data
        
        To copy the examples of e.g. datashader and download the required data, use the `examples` command:
        
        ```
        $ datashader examples --help
        usage: datashader examples [-h] [--path PATH] [-v] [--force]
        
        optional arguments:
          -h, --help     show this help message and exit
          --path PATH    location to place examples and data
          -v, --verbose
          --force        if PATH already exists, force overwrite existing examples if older than source examples
        ```
        
        To copy the examples of e.g. datashader but not download the data, use the `copy-examples` command:
        
        ```
        usage: datashader copy-examples [-h] [--path PATH] [-v] [--force]
        
        optional arguments:
          -h, --help     show this help message and exit
          --path PATH    where to copy examples
          -v, --verbose
          --force        if PATH already exists, force overwrite existing examples if older than source examples
        ```
        
        To download the data only, use the `fetch-data` command:
        
        ```
        usage: datashader fetch-data [-h] [--path PATH] [--datasets DATASETS] [-v]
        
        optional arguments:
          -h, --help           show this help message and exit
          --path PATH          where to put data
          --datasets DATASETS  *name* of datasets file; must exist either in path specified by --path or in package/examples/
          -v, --verbose
        ```
        
        Can specify different 'datasets' file:
        
        ```
        $ cat earthsim-examples/test.yml
        ---
        
        data:
        
          - url: http://s3.amazonaws.com/datashader-data/Chesapeake_and_Delaware_Bays.zip
            title: 'Depth data for the Chesapeake and Delaware Bay region of the USA'
            files:
              - Chesapeake_and_Delaware_Bays.3dm
        
        $ earthsim fetch-data --path earthsim-examples --datasets-filename test.yml
        Downloading data defined in /tmp/earthsim-examples/test.yml to /tmp/earthsim-examples/data
        Skipping Depth data for the Chesapeake and Delaware Bay region of the USA
        ```
        
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Classifier: License :: OSI Approved :: BSD License
Requires-Python: >=2.7
Description-Content-Type: text/markdown
Provides-Extra: tests
