Skip to main content

Autoseeder CLI tool

Project description

Autoseeder

The autoseeder-cli tools allow you to interact easily with the Autoseeder API to submit new URLs and check the status of existing URLs.

Installation

pip install autoseeder-cli

Usage

Please Note: Only Python 3.6+ are officially supported by autoseeder-cli. Python 2.7 has reached EOL and will not be supported.

For each of these tools, before use you should configure the following as environment variables:

AUTOSEEDER_BASE_URL  The URL that the Autoseeder service resides at [e.g.: https://your.instance.hostname/autoseeder/]
AUTOSEEDER_TOKEN     Token to authenticate with - recommended method

Linux/MacOS bash shell:

export AUTOSEEDER_BASE_URL=https://your.instance.hostname/autoseeder/
export AUTOSEEDER_TOKEN='35999b9065…'

Windows Powershell:

$env:AUTOSEEDER_BASE_URL = "https://your.instance.hostname/autoseeder/"
$env:AUTOSEEDER_TOKEN = "35999b9065…"

Windows Command Prompt:

set AUTOSEEDER_BASE_URL=https://your.instance.hostname/autoseeder/
set AUTOSEEDER_TOKEN=35999b9065…

Commands available:

autoseeder-cli get_token

Required Environment Variables

  • AUTOSEEDER_USER
  • AUTOSEEDER_PASS
  • AUTOSEEDER_BASE_URL

via CLI

Log in to autoseeder and obtain an API token. Note that if you’ve been supplied with a token string to use already, you do not need to do this.

Linux/MacOS command line:

AUTOSEEDER_USER=josephpilgrim
AUTOSEEDER_PASS=onthetrail
AUTOSEEDER_BASE_URL=https://oregon.usa/autoseeder/

export AUTOSEEDER_TOKEN=$(autoseeder-cli get_token)

via Python lib

import os
import autoseeder_cli

username = os.environ.get('AUTOSEEDER_USER')
password = os.environ.get('AUTOSEEDER_PASS')
base_url = os.environ.get('AUTOSEEDER_BASE_URL')

api = autoseeder_cli.AutoseederTokenGetter(user=username, password=password, base_url=base_url)
print('API token: {}'.format(api.get_token()))

autoseeder-cli submit

Required Environment Variables

  • AUTOSEEDER_TOKEN
  • AUTOSEEDER_BASE_URL

via CLI

autoseeder-cli submit <url> [--seed-region=<seed-region>]

Submit a single URL to Autoseeder for seeding. You can optionally select a geographic region to limit seeding activity to.

Arguments: * <url> required * –seed-region=<R1,R2,R3> one or more ISO-3166 two-character country identifier, separated by commas.

Command line:

autoseeder-cli submit https://exampledata.net/ --seed-region=AU,NZ

via Python lib

import os
import autoseeder_cli

token = os.environ.get('AUTOSEEDER_TOKEN')
base_url = os.environ.get('AUTOSEEDER_BASE_URL')

submitter = autoseeder_cli.AutoseederSubmitter(token=token, base_url=base_url)
response = submitter.submit_url('http://example.com', seed_region='AU')
uuid = response.get('uuid')

print('URL trackable via {}'.format(uuid))

autoseeder-cli list

autoseeder-cli list [--limit=<limit>] [--desc]

Required Environment Variables

  • AUTOSEEDER_TOKEN
  • AUTOSEEDER_BASE_URL

via CLI

Presents a report of URLs you’ve submitted and their status.

You may find it helpful to filter and format the output with the jq tool.

Linux/MacOS command line:

# show last 100
autoseeder-cli list --limit 100

# filter down with jq
autoseeder-cli list --limit 100 | \
    jq '.[] | \
        select(.statistics != null) | \
       [ .statistics[].canoncical_url, .statistics[].status ]'

Windows command line:

REM show last 100
autoseeder-cli list --limit 100

REM filter down with jq
autoseeder-cli list --limit 100 | jq ".[]| select(.statistics != null)| [.statistics[].canonical_url, .statistics[].status]"

via Python lib

import os
import autoseeder_cli

token = os.environ.get('AUTOSEEDER_TOKEN')
base_url = os.environ.get('AUTOSEEDER_BASE_URL')

lister = autoseeder_cli.AutoseederLister(token=token, base_url=base_url)
urls = lister.get_url_list()

for url in urls:
    print(url['url'])

autoseeder-cli find_urls

Required Environment Variables

  • AUTOSEEDER_TOKEN
  • AUTOSEEDER_BASE_URL

via CLI

Finds URLs matching a search term, and provides their Universally Unique Identifiers (UUIDs) for further actions (e.g. view).

Command line:

autoseeder-cli find_urls 'example.com'

via Python lib

import os
import autoseeder_cli

token = os.environ.get('AUTOSEEDER_TOKEN')
base_url = os.environ.get('AUTOSEEDER_BASE_URL')

searcher = autoseeder_cli.AutoseederSearcher(token=token, base_url=base_url)
uuids = searcher.find_urls('example.com')

for uuid in uuids:
    print(uuid)

autoseeder-cli view

Required Environment Variables

  • AUTOSEEDER_TOKEN
  • AUTOSEEDER_BASE_URL

via CLI

Presents a report of a single URL via its associated Universally unique identifier (UUID) or specific URL.

Command line:

# view by URL UUID
autoseeder-cli view 2118f16a-3270-4e63-88dc-24b6097739ab  # UUID is sample only
# partial URL string which must match only one registered URL
autoseeder-cli view example.com/myurl

via Python lib

import autoseeder_cli

# 2118f16a-3270-4e63-88dc-24b6097739ab is a SAMPLE ONLY, would map to a seeded URL you previously submitted
viewer = autoseeder_cli.AutoseederURLView(token=token, base_url=myinstance_url)
url_data = viewer.view('2118f16a-3270-4e63-88dc-24b6097739ab')

for url in url_data:
    print(url['url'])

autoseeder-cli get_csv

autoseeder-cli get_csv <output_file>

Required Environment Variables

  • AUTOSEEDER_TOKEN
  • AUTOSEEDER_BASE_URL

via CLI

Presents a report of URLs you’ve submitted and their status in a CSV representation.

Command line:

autoseeder-cli get_csv autoseeder_latest.csv

autoseeder-cli save_screenshot

Required Environment Variables

  • AUTOSEEDER_TOKEN
  • AUTOSEEDER_BASE_URL

via CLI

You probably don’t want to use this - it retrieves a single image (png format), referenced by the screenshot unique identifier.

Command line:

autoseeder-cli save_screenshot 2118f16a-3270-4e63-88dc-24b6097739ab ./example.org/indexpage.png

autoseeder-cli save_screenshots

Required Environment Variables

  • AUTOSEEDER_TOKEN
  • AUTOSEEDER_BASE_URL

via CLI

Retrieves a one or more screenshots, referenced by the unique identifier for a URL.

All images will be saved into the specified output path. If the specified path does not already exist a directory will be created.

Command line:

autoseeder-cli save_screenshots 2118f16a-3270-4e63-88dc-24b6097739ab ./example.org/summary_screenshots

autoseeder-cli save_screenshots_all

Warning: Images may contain sensitive information.

Required Environment Variables

  • AUTOSEEDER_TOKEN
  • AUTOSEEDER_BASE_URL

Warning: Images may contain sensitive information.

via CLI

Warning: Images may contain sensitive information.

Retrieves a one or more screenshots, referenced by the unique identifier for a URL.

All images will be saved into the specified output path. If the specified path does not already exist a directory will be created.

Warning: Images may contain sensitive information.

Command line:

autoseeder-cli save_screenshots_all 2118f16a-3270-4e63-88dc-24b6097739ab ./example.org/detailed_screenshots

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for autoseeder-cli, version 2.7.0
Filename, size File type Python version Upload date Hashes
Filename, size autoseeder_cli-2.7.0-py3-none-any.whl (10.6 kB) File type Wheel Python version py3 Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page