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
source run-coverage.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

Copyright (C) 2013, 2014 CERN.

setuptools-bower is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

setuptools-bower is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with setuptools-bower; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.

In applying this licence, 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.

The full license text can be found in COPYING file.

Fork me on GitHub