Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Bundler or pip freeze for Perl
Perl
Tag: v0.1_0

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
bin
lib
t
xt
.gitignore
.shipit
Changes
MANIFEST
MANIFEST.SKIP
Makefile.PL
README
TODO

README

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

SYNOPSIS
      # During the development
      > cat Makefile.PL
      use inc::Module::Install;
      name 'MyApp';
      version '1.0';
  
      requires 'Plack', 0.9980;
      requires 'Starman', 0.2000;
  
      WriteAll;
  
      > carton install
      > git commit -m "add Plack and Starman" Makefile.PL carton.lock

      # Then elsewhere (on a deployment machine)
      > carton install --deployment
      > carton exec starman -p 8080 myapp.psgi

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

DESCRIPTION
    carton is a command line tool to track the Perl module dependencies for
    your Perl application.

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

      > carton check
      > 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 the standard
    "Makefile.PL" or "Build.PL".

      # Makefile.PL
      use inc::Module::Install;
      name 'MyAwesomeApp';
      requires 'Plack', 0.9980;
      requires 'Starman', 0.2000;
      WriteAll;

    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.

      > git commit -m "Added Plack and Starman" Makefile.PL carton.lock

    You can aternatively install modules adhoc from the command line,
    without managing the build file at all.

      > carton install Devel::NYTProf
      > carton install AnyEvent::Redis

    carton will install these modules into "local" directory in the same
    way, and also can track and analyze the dependencies.

  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.

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

Something went wrong with that request. Please try again.