From 26fe87c966fd3312138e39af2a2af97bbbff9583 Mon Sep 17 00:00:00 2001 From: Daniel Asay Date: Fri, 3 Jan 2025 13:28:30 -0500 Subject: [PATCH] add boilerplate repo docs --- LICENSE | 26 ++++++++++++++++++++++++++ requirements.txt | 1 + scanbuddy/__init__.py | 10 ++++++++++ 3 files changed, 37 insertions(+) create mode 100644 LICENSE create mode 100644 requirements.txt diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..a8768f9 --- /dev/null +++ b/LICENSE @@ -0,0 +1,26 @@ +Copyright 2024 The President and Fellows of Harvard College. All rights reserved. + +Redistribution and use in source and binary forms, with or without modification, +are permitted provided that the following conditions are met: + +1. Redistributions of source code must retain the above copyright notice, this + list of conditions and the following disclaimer. + +2. Redistributions in binary form must reproduce the above copyright notice, + this list of conditions and the following disclaimer in the documentation + and/or other materials provided with the distribution. + +3. Neither the name of the copyright holder nor the names of its contributors + may be used to endorse or promote products derived from this software without + specific prior written permission. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND +ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED +WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE +DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR +ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES +(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; +LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON +ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS +SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..d6e1198 --- /dev/null +++ b/requirements.txt @@ -0,0 +1 @@ +-e . diff --git a/scanbuddy/__init__.py b/scanbuddy/__init__.py index e69de29..518171f 100644 --- a/scanbuddy/__init__.py +++ b/scanbuddy/__init__.py @@ -0,0 +1,10 @@ +import os +import tarfile +from . import __version__ + +def version(): + return __version__.__version__ + +def archive(indir, output): + with tarfile.open(output, 'w:gz') as tar: + tar.add(indir, os.path.basename(indir))