{
"info": {
"author": "Alex Sanchez",
"author_email": "alex@s1ck.org",
"bugtrack_url": null,
"classifiers": [
"Development Status :: 3 - Alpha",
"Environment :: Web Environment",
"Intended Audience :: Developers",
"License :: OSI Approved :: MIT License",
"Programming Language :: Python :: 3.5"
],
"description": "============\nnamecheapapi\n============\nPython Namecheap API wrapper for simple domain name registration and management.\n\nNOTE: you will need API key from Namecheap to use this module (see below).\n\nOverview\n--------\n\nThis is work in progress. Official API docs: https://www.namecheap.com/support/api\n\nFor now I'm trying not to use anything outside the standard library.\nMost methods are more or less well-documented, so don't be shy to use help(). Type hints (PEP 484) are available for every method.\nMethod names are NOT in 100% match with those from Namecheap, but they are more pythonic and/or hopefully make more sense.\n\nFeatures\n--------\n* domain registration/renewal\n* domain availability check\n* DNS updates\n* WHOIS information updates\n* get your domain's information\n* get a list of your Namecheap domains\n* set/remove registrar lock\n\n... and more.\n\n\nNamecheap API\n-------------\n\nNamecheap offers two API endpoints: sandbox (for development & testing) and production (for real world).\nYou can sign up for a free sandbox account at https://www.sandbox.namecheap.com/ and activate API access at\nhttps://ap.www.sandbox.namecheap.com/Profile/Tools/ApiAccess\n\nMake sure to add your public IP address in Whitelisted IPs section.\n\nKeep in mind that sandbox domains are not 'real', i.e. they exist only\nin Namecheap sandbox (not on the actual Web). With that you may be able\nto see google.com as available for registration. At the same time, you\nwill need to make sure to register your 'virtual' domains if you want to\ntest domain-specific options, such as renewal, DNS updates, etc.\n\n\nInstallation\n------------\n::\n\n $ pip install namecheapapi\n\nExample usage\n-------------\n.. code-block:: python\n\n # Initialize API\n >>> from namecheapapi import DomainAPI\n >>> api = DomainAPI(\n ... api_user='api_user',\n ... api_key='api_key,\n ... username='username', # usually the same as api_user\n ... client_ip='your IP address',\n ... sandbox=True, # recommended for testing\n ... coupon='coupon' # optional\n ...)\n >>>\n\n # Check availability of google.com\n >>> api.check('google.com')\n {'google.com': False}\n\n # Check multiple domains at once\n >>> api.check(['asdfghjhgfdsa.com', 'google.com'])\n {'google.com': False, 'asdfghjhgfdsa.com': True}\n\n # Register a domain\n >>> address = {\n ... 'FirstName': 'Peter',\n ... 'LastName': 'Griffin',\n ... 'Address1': '31 Spooner St.',\n ... 'City': 'Quahog',\n ... 'StateProvince': 'RI',\n ... 'PostalCode': '00093',\n ... 'Country': 'US',\n ... 'Phone': '+1.123456789',\n ... 'EmailAddress': 'peter@griffin.tv'\n ...}\n >>> api.register('asdfghjhgfdsa.com', address=address)\n {'NonRealTimeDomain': False, 'TransactionID': 1216215, 'WhoisGuardEnabled': False, 'Domain': 'asdfghjhgfdsa.com', 'OrderID': 823656, 'Success': True, 'ChargedAmount': 10.87, 'ID': 117154}\n\n # Custom query (a raw XML response is returned)\n >>> q = api.raw_query(command='namecheap.domains.transfer.getList', query={})\n >>> print(q)\n \n \n \n \n namecheap.domains.transfer.getlist\n \n \n \n 0\n 1\n 20\n \n \n PHX01SBAPI01\n --4:00\n 0.01\n \n\n\nImplemented methods\n-------------------\n* domains.register (namecheap.domains.create)\n* domains.check (namecheap.domains.check)\n* domains.get_info (namecheap.domains.getInfo)\n* domains.get_list (namecheap.domains.getList)\n* domains.get_tld_list (namecheap.domains.getTldList)\n* domains.renew (namecheap.domains.renew)\n* domains.reactivate (namecheap.domains.reactivate)\n* domains.get_lock (namecheap.domains.getRegistrarLock)\n* domains.set_lock (namecheap.domains.setRegistrarLock)\n* domains.get_nameservers (namecheap.domains.dns.getList)\n* domains.set_nameservers (namecheap.domains.dns.setCustom, namecheap.domains.dns.setDefault)\n* domains.get_contacts (namecheap.domains.getContacts)\n* domains.set_contacts (namecheap.domains.setContacts)\n\nNext up\n-------\n* domains.create_nameserver (namecheap.domains.ns.create)\n* domains.delete_nameserver (namecheap.domains.ns.delete)\n* domains.update_nameserver (namecheap.domains.ns.update)\n* domains.get_nameserver_info (namecheap.domains.ns.getInfo)\n* domains.get_host_records (namecheap.domains.dns.getHosts)\n* domains.set_host_records (namecheap.domains.dns.setHosts)\n\nTesting\n-------\n(does have one dependency)\n\n1. Install nosetests (``pip install nose``)\n2. Create ``config.py`` in ``namecheapapi/tests/`` directory, fill it in:\n\n* ``API_KEY`` = 'string' -- API key that you got from Namecheap\n* ``API_USER`` = 'string' -- your Namecheap username\n* ``USERNAME`` = 'string' -- in most cases it would be your Namecheap username\n* ``CLIENT_IP`` = 'string' -- your public IP address (MUST be whitelisted in your Namecheap account)\n* ``SANDBOX`` = True (recommended!)\n* ``COUPON`` = 'string' -- coupon code if you have any, '' otherwise\n* ``DOMAIN`` = 'string' -- a domain name you ALREADY HAVE in your Namecheap account\n\n3. Run ``nosetests /path/to/namecheapapi/dir``\n\nChangelog\n---------\n\n0.2.1\n~~~~~\n\n* minor bugfixes\n\n0.2\n~~~\n\n* documentation update\n* domains.get_contacts/set_contacts methods added\n\n0.1.1\n~~~~~\n\n* First published working version.\n\nAuthor\n______\n\n`Alex Sanchez `_.\n",
"description_content_type": null,
"docs_url": null,
"download_url": "UNKNOWN",
"downloads": {
"last_day": -1,
"last_month": -1,
"last_week": -1
},
"home_page": "https://github.com/yonjuuni/namecheapapi",
"keywords": "namecheap,domain,dns",
"license": "MIT",
"maintainer": null,
"maintainer_email": null,
"name": "namecheapapi",
"package_url": "https://pypi.org/project/namecheapapi/",
"platform": "any",
"project_url": "https://pypi.org/project/namecheapapi/",
"project_urls": {
"Download": "UNKNOWN",
"Homepage": "https://github.com/yonjuuni/namecheapapi"
},
"release_url": "https://pypi.org/project/namecheapapi/0.2.1/",
"requires_dist": null,
"requires_python": null,
"summary": "Python Namecheap API wrapper",
"version": "0.2.1"
},
"last_serial": 2450940,
"releases": {
"0.1": [
{
"comment_text": "",
"digests": {
"md5": "81df954124e3ccae7e9f88a68e9b5226",
"sha256": "3faf980dd92e9739cc130a7e4e10cc32ac6391d6d12ea32a2e4bbf213e2e9df5"
},
"downloads": -1,
"filename": "namecheapapi-0.1.tar.gz",
"has_sig": false,
"md5_digest": "81df954124e3ccae7e9f88a68e9b5226",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 9811,
"upload_time": "2016-08-10T18:14:06",
"url": "https://files.pythonhosted.org/packages/12/5e/f88a8d75a2f5c0d1b33a16b326a1e9f119160c843764979204670ba27b84/namecheapapi-0.1.tar.gz"
}
],
"0.1.1": [
{
"comment_text": "",
"digests": {
"md5": "34f8e848c1e402d9407107c31bf17c61",
"sha256": "62344eedbba6e42a20c87757e36d0964726f051b2be764e53a8ce4cd568a8ddb"
},
"downloads": -1,
"filename": "namecheapapi-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "34f8e848c1e402d9407107c31bf17c61",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 9271,
"upload_time": "2016-08-10T18:30:31",
"url": "https://files.pythonhosted.org/packages/48/b2/9020f6876dbbd23b2bcac5fb30ab78f85845ac130ca599c6fc9b6f97f508/namecheapapi-0.1.1.tar.gz"
}
],
"0.1.2": [
{
"comment_text": "",
"digests": {
"md5": "78f6f49e738551fdf15b9c120d080be3",
"sha256": "ce2216d2d934bea8d47a558663c82fe27fc632be9247dd43827578ab1d895861"
},
"downloads": -1,
"filename": "namecheapapi-0.1.2.tar.gz",
"has_sig": false,
"md5_digest": "78f6f49e738551fdf15b9c120d080be3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 9309,
"upload_time": "2016-08-10T21:40:20",
"url": "https://files.pythonhosted.org/packages/7f/30/7a0784c8a1cd3e8f7c8cbeaf3cb44c385858d0f2b3630663cb393a48efd9/namecheapapi-0.1.2.tar.gz"
}
],
"0.2": [
{
"comment_text": "",
"digests": {
"md5": "c682974a25ad48eba04acd4a8275dddb",
"sha256": "5ef0ffbc8051693e029797882a0b30802dab5b680ee1b608600bbe6a2982814b"
},
"downloads": -1,
"filename": "namecheapapi-0.2.tar.gz",
"has_sig": false,
"md5_digest": "c682974a25ad48eba04acd4a8275dddb",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 10320,
"upload_time": "2016-08-11T16:31:28",
"url": "https://files.pythonhosted.org/packages/ba/53/3fa142619ff7c5cc14db68aa72eaadf23c563a6a899891f8c1b5fd988d3c/namecheapapi-0.2.tar.gz"
}
],
"0.2.1": [
{
"comment_text": "",
"digests": {
"md5": "4ab8e33fec4d6d4bba746adb2546b791",
"sha256": "127eebbc0dea87e9d317cf2fa62a4beba0be64c067ae08e3607284f5ae156482"
},
"downloads": -1,
"filename": "namecheapapi-0.2.1.tar.gz",
"has_sig": false,
"md5_digest": "4ab8e33fec4d6d4bba746adb2546b791",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 10714,
"upload_time": "2016-11-09T13:22:15",
"url": "https://files.pythonhosted.org/packages/b0/92/4d57578cf5747e42ce2a66da56746a9aa5dd1c2f7a48314418ee840a7b59/namecheapapi-0.2.1.tar.gz"
}
]
},
"urls": [
{
"comment_text": "",
"digests": {
"md5": "4ab8e33fec4d6d4bba746adb2546b791",
"sha256": "127eebbc0dea87e9d317cf2fa62a4beba0be64c067ae08e3607284f5ae156482"
},
"downloads": -1,
"filename": "namecheapapi-0.2.1.tar.gz",
"has_sig": false,
"md5_digest": "4ab8e33fec4d6d4bba746adb2546b791",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 10714,
"upload_time": "2016-11-09T13:22:15",
"url": "https://files.pythonhosted.org/packages/b0/92/4d57578cf5747e42ce2a66da56746a9aa5dd1c2f7a48314418ee840a7b59/namecheapapi-0.2.1.tar.gz"
}
]
}