Metadata-Version: 2.1
Name: archiveis
Version: 0.0.9
Summary: A simple Python wrapper for the archive.is capturing service
Home-page: https://www.github.com/pastpages/archiveis/
Author: Ben Welsh
Author-email: ben.welsh@gmail.com
License: MIT
Description: # archiveis
        
        A simple Python wrapper for the [archive.is](http://archive.is/) capturing service.
        
        [![PyPI version](https://badge.fury.io/py/archiveis.png)](http://badge.fury.io/py/archiveis)
        [![Build Status](https://travis-ci.org/pastpages/archiveis.svg?branch=master)](https://travis-ci.org/pastpages/archiveis)
        [![Coverage Status](https://coveralls.io/repos/github/pastpages/archiveis/badge.svg?branch=master)](https://coveralls.io/github/pastpages/archiveis?branch=master)
        
        ### Installation
        
        ```bash
        pipenv install archiveis
        ```
        
        ### Python Usage
        
        Import it.
        
        ```python
        >>> import archiveis
        ```
        
        Capture a URL.
        
        ```python
        >>> archive_url = archiveis.capture("http://www.example.com/")
        ```
        
        See where it's stored.
        
        ```python
        >>> print archive_url
        http://archive.md/WxlRK
        ```
        
        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 .
        ```
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: License :: OSI Approved :: MIT License
Description-Content-Type: text/markdown
