setuptools-bower

travis-ci badge coveralls.io badge

About

setuptools-bower provides setuptools commands for integrating bower.

It provides additional setuptools commands build_npm, build_bower, and build_grunt. However, it does not install npm, bower, or grunt itself.

User’s Guide

This part of the documentation will show you how to get started in using setuptools-bower.

Installation

Install setuptools-bower with pip

pip install setuptools-bower

The development version can be downloaded from its page at GitHub.

git clone https://github.com/inveniosoftware/setuptools-bower.git
cd setuptools-bower
python setup.py develop
./run-tests.sh

Requirements

setuptools-bower has the following dependencies:

setuptools-bower requires Python version 2.6, 2.7 or 3.3+

Usage

After you install setuptools-bower you can run from within your Python package:

python setup.py install_bower

This will run bower install in the directory and is thus expecting to find a bower.json and respect any configuration in a .bowerrc file.

In your setup.cfg you may setup aliases to combine bower installation with your normal install:

[aliases]
install_all = install_bower install

API Reference

If you are looking for information on a specific function, class or method, this part of the documentation is for you.

Custom setuptools commands implementation.

class setuptools_bower.setuptools_command.BowerBuildCommand(dist, **kw)

Setuptools command for running bower <command>.

finalize_options()

Finalize options.

initialize_options()

Set default values for options.

run()

Execute bower command.

class setuptools_bower.setuptools_command.GruntBuildCommand(dist, **kw)

Setuptools command for running grunt <command>.

finalize_options()

Finalize options.

initialize_options()

Set default values for options.

run()

Execute grunt command.

class setuptools_bower.setuptools_command.NPMBuildCommand(dist, **kw)

Setuptools command for running npm <command>.

finalize_options()

Finalize options.

initialize_options()

Set default values for options.

run()

Execute npm command.

Additional Notes

Notes on how to contribute, legal information and changelog are here for the interested.

Changelog

Here you can see the full list of changes between each setuptools-bower release.

Version 0.2.0 (released 2014-07-09)

  • Adds support for Python-3.4.
  • Fixes grunt build command.
  • Improves documentation.

Version 0.1

  • Initial public release

License

setuptools-bower is free software; you can redistribute it and/or modify it under the terms of the Revised BSD License quoted below.

Copyright (C) 2013, 2014 CERN.

All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

  • Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
  • Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
  • Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

In applying this license, CERN does not waive the privileges and immunities granted to it by virtue of its status as an Intergovernmental Organization or submit itself to any jurisdiction.