Metadata-Version: 2.1
Name: iagitup
Version: 1.6
Summary: Tool to archive a git repository form GitHub to the Internet Archive.
Home-page: https://github.com/gdamdam/iagitup
Author: Giovanni Damiola
Author-email: UNKNOWN
License: GNU General Public License v3.0
Keywords: github internetarchive
Platform: POSIX
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.7
Requires-Dist: appdirs
Requires-Dist: args
Requires-Dist: asn1crypto
Requires-Dist: cffi
Requires-Dist: clint
Requires-Dist: cryptography
Requires-Dist: docopt
Requires-Dist: enum34
Requires-Dist: gitdb2
Requires-Dist: GitPython
Requires-Dist: idna
Requires-Dist: internetarchive
Requires-Dist: ipaddress
Requires-Dist: jsonpatch
Requires-Dist: markdown2
Requires-Dist: ndg-httpsclient
Requires-Dist: packaging
Requires-Dist: pyasn1
Requires-Dist: pycparser
Requires-Dist: pyOpenSSL
Requires-Dist: pyparsing
Requires-Dist: requests
Requires-Dist: schema
Requires-Dist: six
Requires-Dist: smmap2
Requires-Dist: wheel

# iagitup - v1.6 - a python command line tool to archive a GitHub repository to the Internet Archive

The python script downloads the GitHub repository, creates a [git bundle](https://git-scm.com/docs/git-bundle) and uploads it on an Internet Archive item with metadata from the GitHub API and a description from the repository readme.


## Prerequisites
This script strongly recommends Linux or some sort of POSIX system (such as Mac OS X).

* **Internet Archive Account** - If you don't already have an account on archive.org, [register](https://archive.org/account/login.createaccount.php).
* **Python 2.7** - This script requires python 2.7.
* **libffi-dev and libssl-dev**
* **git**

## Install iagitup

Prerequisites (with Debian or Ubuntu):

    sudo apt update 
    sudo apt install python python-pip python-dev libffi-dev libssl-dev git

### with pip:

    pip install iagitup

### from source code:

Clone the repo and install the package...

    git clone https://github.com/gdamdam/iagitup.git
    cd iagitup
    pip install .

## Usage

To upload a repo:

    iagitup  <github_repo_url>

You can add also custom metadata:

    iagitup --metadata=<key:value,key2:val2> <github_repo_url>

To know the version:

    iagitup -v

Example:

    iagitup https://github.com/<GITHUBUSER>/<RESPOSITORY>

The script downloads the git repo from github, creates a git bundle and uploads it on the Internet Archive.

The repo will be archived in an item at url containing the repository name and the date of the last push, something like:

    https://archive.org/details/github.com-<GITHUBUSER>-<RESPOSITORY>_-_<DATE-LAST-PUSH>

The git repo bundle will be available at url:

    https://archive.org/download/github.com-<GITHUBUSER>-<RESPOSITORY>_-_<DATE-LAST-PUSH>/<BUNDLENAME>.bundle

## Restore an archived github repository

Download the bundle file, form the archived item:

    https://archive.org/download/.../<ARCHIVED_REPO>.bundle

Just download the _.bundle_ file and run:

    git clone file.bundle


## License (GPLv3)

Copyright (C) 2017-2018 Giovanni Damiola

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.


