gurugeek / carton Goto Github PK

NAME
    Carton - Perl module dependency manager (aka Bundler for Perl)

SYNOPSIS
      # On your development environment
      > cat cpanfile
      requires 'Plack', 0.9980;
      requires 'Starman', 0.2000;
  
      > carton install
      > git add cpanfile carton.lock
      > git commit -m "add Plack and Starman"

      # Other developer's machine, or on a deployment box
      > carton install
      > carton exec -Ilib -- starman -p 8080 myapp.psgi

WARNING
    This software is under heavy development and considered ALPHA quality
    till its version hits v1.0.0. Things might be broken, not all features
    have been implemented, and APIs are likely to change. YOU HAVE BEEN
    WARNED.

DESCRIPTION
    carton is a command line tool to track the Perl module dependencies for
    your Perl application. The managed dependencies are tracked in a
    *carton.lock* file, which is meant to be version controlled, and the
    lock file allows other developers of your application will have the
    exact same versions of the modules.

TUTORIAL
  Initializing the environment
    carton will use the *.carton* directory for local configuration and the
    *local* directory to install modules into. You're recommended to exclude
    these directories from the version control system.

      > echo .carton/ >> .gitignore
      > echo local/ >> .gitignore
      > git add carton.lock
      > git commit -m "Start using carton"

  Tracking the dependencies
    You can manage the dependencies of your application via *cpanfile*.

      # cpanfile
      requires 'Plack', 0.9980;
      requires 'Starman', 0.2000;

    And then you can install these dependencies via:

      > carton install

    The modules are installed into your *local* directory, and the
    dependencies tree and version information are analyzed and saved into
    *carton.lock* in your directory.

    Make sure you add *carton.lock* to your version controlled repository
    and commit changes as you update dependencies. This will ensure that
    other developers on your app, as well as your deployment environment,
    use exactly the same versions of the modules you just installed.

      > git add cpanfile carton.lock
      > git commit -m "Added Plack and Starman"

  Deploying your application
    Once you've done installing all the dependencies, you can push your
    application directory to a remote machine (excluding *local* and
    *.carton*) and run the following command:

      > carton install

    This will look at the *carton.lock* and install the exact same versions
    of the dependencies into *local*, and now your application is ready to
    run.

  Bundling modules
    carton can bundle all the tarballs for your dependencies into a
    directory so that you can even install dependencies that are not
    available on CPAN, such as internal distribution aka DarkPAN.

      > carton bundle

    will bundle these tarballs into *local/cache* directory, and

      > carton install --cached

    will install modules using this local cache. This way you can avoid a
    dependency on CPAN meta DB and search.cpan.org at a deploy time, or you
    can have dependencies onto private CPAN modules aka DarkPAN.

COMMUNITY
    <https://github.com/miyagawa/carton>
        Code repository, Wiki and Issue Tracker

    <irc://irc.perl.org/#carton>
        IRC chat room

AUTHOR
    Tatsuhiko Miyagawa

COPYRIGHT
    Tatsuhiko Miyagawa 2011-

LICENSE
    This software is licensed under the same terms as Perl itself.

SEE ALSO
    cpanm

    Bundler <http://gembundler.com/>

    pip <http://pypi.python.org/pypi/pip>

    npm <http://npmjs.org/>

    perlrocks <https://github.com/gugod/perlrocks>

    only