Code Monkey home page Code Monkey logo

grablib's Introduction

grablib

Build Status codecov.io PyPI Status license

Copyright (C) 2013-2020 Samuel Colvin

Kind of like bower, but in Python, and simpler, and with some more features.

grablib can:

  • download files from urls, including extracting selectively from zip files.
  • create .grablib.lock which retains hashes of all downloaded files meaning assets can't change unexpectedly.
  • compile sass/scss/css using libsass.
  • concatenate and minify javascript using jsmin.

Definition files can either be JSON or YAML (see examples).

Installation

grablib requires python 3.6+.

pip install grablib[build]

(You can also use simply pip install grablib to install without build requirements, this is useful when you're not using grablib for building as it avoids installing jsmin and libsass which can be slow.)

CLI Usage

Define your static files thus: (grablib.yml)

download_root: 'static/libs'
download:
  'http://code.jquery.com/jquery-1.11.3.js': 'js/jquery.js'
  'https://github.com/twbs/bootstrap-sass/archive/v3.3.6.zip':
    'bootstrap-sass-3.3.6/assets/(.+)$': 'bootstrap-sass/'

  'GITHUB/codemirror/CodeMirror/5.8.0/lib/codemirror.js': 'codemirror/'
  # simple scss file to import and compile bootstrap from above,
  # generally this would be in your code
  # this file just reads "@import 'bootstrap-sass/stylesheets/bootstrap';"
  'https://git.io/v1Z5J': 'build_bootstrap.scss'

debug: true
build_root: 'static/prod'
build:
  # delete the entire static/prod directory before building, this is required for sass,
  # and generally safer
  wipe: '.*'
  cat:
    # concatenate jquery and codemirror into "libraries.js"
    # it won't get minified as debug is true, but without that it would
    'libraries.js':
      - 'DL/js/jquery.js'
      - 'DL/codemirror/codemirror.js'
  sass:
    # compile all css, scss and sass files which don't start with _ from the "download_root"
    # into the "css" directory, here that will just be build_bootstrap.scss which will
    # build the whole of bootstrap.
    # debug: true means you'll get map files and a copy of sass files so maps work properly.
    'css': 'DL/'

Then download and build you static files with just:

grablib

Library Usage

You can also call grablib from python:

from grablib import Grab

grab = Grab('path/to/definitions.json|yml')
grab.download()
grab.build()

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.