archiveis - GitLite

KO | EN

gitlite — search

#react #typescript #golang #android #rust #deep-learning #linux #nodejs #java #windows #cli #kubernetes #vue #openai

archiveis

(★ 218)

A simple Python wrapper for the archive.is capturing service

File Explorer

Download Latest Version (.zip)

- - continuous-deployment.yml
- __init__.py
- api.py
.coveragerc
.gitignore
.pre-commit-config.yaml
LICENSE
Pipfile
Pipfile.lock
README.md
setup.cfg
setup.py
test.py

# Installation Guide

1. Get the code

git clone https://github.com/palewire/archiveis

Downloads the entire project code from GitHub to your computer.

cd archiveis

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended

Prerequisites

Python 3 Python is required to use pip.

pip install --editable .

Installs the package published on PyPI directly — no need to clone the source.

✅ After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Python

Easy

Prerequisites

Git Needed to download the project code from GitHub.
Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.

pip install --editable .

Installs the package published on PyPI directly — no need to clone the source.

✅ If it runs without errors and prints output in the terminal, it worked.

Pulled directly from this repo's README.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# archiveis

A simple Python wrapper for the [archive.is](http://archive.is/) capturing service.

![Tests](https://github.com/pastpages/archiveis/workflows/Tests/badge.svg)

### Installation

```bash
pipenv install archiveis
```

### Python Usage

Import it.

```python
import archiveis
```

Capture a URL.

```python
archive_url = archiveis.capture("http://www.example.com/")
```

If a URL has been recently cached, archive.is may return the URL to that page rather
than conduct a new capture.

### Command-line usage

The Python library is also installed as a command-line interface. You can run it from your terminal like so:

```bash
archiveis http://www.example.com/
```

The command has the same options as the Python API, which you can learn about from its help output.

```bash
$ archiveis --help
Usage: archiveis [OPTIONS] URL

Archives the provided URL using the archive.is capturing service.

Options:
  -ua, --user-agent TEXT  User-Agent header for the web request
  --help                  Show this message and exit.
```

### Contributing

Install dependencies for development.

```bash
pipenv install --dev
```

Run tests.

```bash
make test
```

Ship new version to PyPI

```bash
make ship
```

### Developing the CLI

The command-line interface is implemented using Click and setuptools. To install it locally for development inside your virtual environment, run the following installation command, as [prescribed by the Click documentation](https://click.palletsprojects.com/en/7.x/setuptools/#setuptools-integration).

```bash
pip install --editable .
```