Skip to main content

README

DISCLAIMER: This is extremely alpha/beta/not-production code at this point. I take no responsiblity for the use of this software to manage OpenSRS accounts.

This package provides a set of pyCLI applications for interfacing with an OpenSRS reseller account.

Installation

Install from pypi:

$ pip install opensrscli

Development

Install virtualenv and distribute if they aren’t already present:

$ pip install distribute virtualenv

Clone the project and initialize a development environment:

$ git clone git://github.com/shawnsi/opensrs-cli.git && cd opensrs-cli
$ virtualenv .
$ source /bin/activate

You can use distribute to install dependencies and setup entry points:

$ python setup.py develop

Configuration

Basic Auth

You must create a yaml file to provide OpenSRS authentication info at a minimum. This should match the user and private key information you setup in the OpenSRS reseller dashboard for API access.

Auth template:

username:
private_key:

Now provide the prefs.yaml file to opensrs commands with the -p or –preferences parameter. If no preferences file is specified opensrs-cli will look in $HOME/.opensrs/prefs.

Contact Sets

In order to perform and domain registration or transfers contact sets will need to be defined. Add them to prefs.yaml using the following template. A default contact can be provided and fields can be overriden for admin, owner, billing, or tech contacts.

Contact set template:

contact_set:
  default:
    first_name:
    last_name:
    org_name:
    address1:
    city:
    state:
    postal_code:
    country:
    phone:
    email:
  billing:
    last_name:
    email:
  tech:
    last_name:
    email:

Usage

This package installs scripts prefixed with opensrs.

Currently provided:

  • opensrs-balance

    Returns account balance

  • opensrs-check-transfer

    Returns transfer status of one or more domains

  • opensrs-transfer

    Transfers one or more domains according to contact sets described above

  • opensrs-get-nameservers

    Get the nameservers attached to one or more domains

  • opensrs-set-nameservers

    Sets default nameservers from user preferences file on one or more domains

  • opensrs-lock

    Lock one or more domains

  • opensrs-unlock

    Unlock one or more domains

Metadata

Release files for opensrscli 0.1.9

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for opensrscli 0.1.9
File Size Uploaded
opensrscli-0.1.9.tar.gz 4.7 kB Details

Release files / opensrscli-0.1.9.tar.gz

Download URL opensrscli-0.1.9.tar.gz
Size 4.7 kB
Tags Source
SHA-256 checksum
How to use checksums
5de5c76e8114440d97f7f8f748292a4de922e7d4ddaf978f955d620b950cba74
BLAKE2b-256 checksum
How to use checksums
5421ecd03a8f34605ca99d382d3469f1246e05e0b5471bffb4256b6284bbdf6f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release history Release notifications | RSS feed

This release

0.1.9 This release

1 release file

0.1.8

1 release file

0.1.7

1 release file

0.1.6

1 release file

0.1.5

1 release file

0.1.4

1 release file

0.1.3

1 release file

0.1.2

1 release file

0.1.0

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page