Contributions are welcome and are greatly appreciated! Every little bit helps, and credit will always be given.
You can contribute in many ways:
Report bugs through Github
If you are reporting a bug, please include:
Look through the GitHub issues for bugs. Anything tagged with “bug” is open to whoever wants to implement it.
Look through the GitHub issues for features. Anything tagged with “feature” is open to whoever wants to implement it.
Caravel could always use better documentation, whether as part of the official Caravel docs, in docstrings, docs/*.rst or even on the web as blog posts or articles.
The best way to send feedback is to file an issue on Github.
If you are proposing a feature:
Check the OS dependencies before follows these steps.
# fork the repo on github and then clone it # alternatively you may want to clone the main repo but that won't work # so well if you are planning on sending PRs # git clone git@github.com:airbnb/caravel.git # [optional] setup a virtual env and activate it virtualenv env source env/bin/activate # install for development python setup.py develop # Create an admin user fabmanager create-admin --app caravel # Initialize the database caravel db upgrade # Create default roles and permissions caravel init # Load some data to play with caravel load_examples # start a dev web server caravel runserver -d
caravel/assets contains all npm-managed, front end assets. Flask-Appbuilder itself comes bundled with jQuery and bootstrap. While these may be phased out over time, these packages are currently not managed with npm.
First, npm must be available in your environment. If it is not you can run the following commands (taken from this source)
brew install node --without-npm echo prefix=~/.npm-packages >> ~/.npmrc curl -L https://www.npmjs.com/install.sh | sh
The final step is to add ~/.node/bin to your PATH so commands you install globally are usable. Add something like this to your .bashrc file.
export PATH="$HOME/.node/bin:$PATH"
To install third party libraries defined in package.json, run the following within the caravel/assets/ directory which will install them in a new node_modules/ folder within assets/.
npm install
To parse and generate bundled files for caravel, run either of the following commands. The dev flag will keep the npm script running and re-run it upon any changes within the assets directory.
# Compiles the production / optimized js & css npm run prod # Start a web server that manages and updates your assets as you modify them npm run dev
For every development session you will have to start a flask dev server as well as an npm watcher
caravel runserver -d -p 8081 npm run dev
Tests can then be run with:
./run_unit_tests.sh
Lint the project with:
# for python changes flake8 changes tests # for javascript npm run lint
Generate the documentation with:
cd docs && ./build.sh
As part of the npm build process, CSS for Caravel is compiled from Less, a dynamic stylesheet language.
It's possible to customize or add your own theme to Caravel, either by overriding CSS rules or preferably by modifying the Less variables or files in assets/stylesheets/less/.
The variables.less and bootswatch.less files that ship with Caravel are derived from Bootswatch and thus extend Bootstrap. Modify variables in these files directly, or swap them out entirely with the equivalent files from other Bootswatch (themes)[https://github.com/thomaspark/bootswatch.git]
Before you submit a pull request from your forked repo, check that it meets these guidelines:
from __future__ import will be required in every .py file soon.