scons-tool-archives

SCons tool to create archives.

Installation

There are few ways to install this tool for your project.

From pypi

This method may be preferable if you build your project under a virtualenv. To add archives tool from pypi, type (within your wirtualenv):

pip install scons-tool-loader scons-tool-archives

or, if your project uses pipenv:

pipenv install --dev scons-tool-loader scons-tool-archives

Alternatively, you may add this to your Pipfile

[dev-packages]
scons-tool-loader = "*"
scons-tool-archives = "*"

The tool will be installed as a namespaced package sconstool.archives in project's virtual environment. You may further use scons-tool-loader to load the tool.

As a git submodule

1. Create new git repository:

   mkdir /tmp/prj && cd /tmp/prj
   touch README.rst
   git init

2. Add the scons-tool-archives as a submodule:

   git submodule add git://github.com/ptomulik/scons-tool-archives.git site_scons/site_tools/archives

3. For python 2.x create __init__.py in site_tools directory:

   touch site_scons/site_tools/__init__.py

   this will allow to directly import site_tools.archives (this may be required by other tools).

Usage example

A simple SConstruct which creates tar archive named foo.tar containning two files: foo.c and foo.h.

# TODO: uncomment following lines if the tool is installed via pip/pipenv
# import sconstool.loader
# sconstool.loader.extend_toolpath(transparent=True)
env = Environment(tools=['archives'])
env.TarFile('foo.tar', ['foo.c', 'foo.h'])

Details

Module description

The scons-tool-archives tool provides builders to create archives, such as tar or zip files. Currently two builders are implemented

• TarFile - uses Python tarfile library to create tar archives,
• ZipFile - uses Python zipfile library to create zip archives.

Construction variables

There are several construction variables used by the builders. Variables with names starting with TARFILE are used by the TarFile builder, variables starting with ZIPFILE are used by the ZipFile builder.

Variable	Default
TARFILESUFFIX	.tar
TARFILETRANSFORM
TARFILEMAPPINGS
TARFILEMODE
TARFILEBUFSIZE
TARFILECOMPRESSLEVEL
TARFILEFORMAT
TARFILEDEREFERENCE
TARFILEDEBUG
TARFILEENCODING
TARFILEERRORS
ZIPFILESUFFIX	.zip
ZIPFILETRANSFORM
ZIPFILEMAPPINGS
ZIPFILEMODE
ZIPFILECOMPRESSION
ZIPFILEALLOW64
ZIPFILECOMPRESSLEVEL

LICENSE

Copyright (c) 2018-2020 by Paweł Tomulik <ptomulik@meil.pw.edu.pl>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE