namecheap-python 1.0.0__py3-none-any.whl → 1.0.1__py3-none-any.whl

namecheap_cli/__main__.py

@@ -24,7 +24,24 @@ from .completion import get_completion_script
 console = Console()
 
 # Configuration
-CONFIG_DIR = Path.home() / ".namecheap"
+def get_config_dir() -> Path:
+    """Get config directory, using XDG on Unix-like systems."""
+    import sys
+    import os
+    
+    if sys.platform == "win32":
+        # Windows: use platformdirs for proper Windows paths
+        from platformdirs import user_config_dir
+        return Path(user_config_dir("namecheap"))
+    else:
+        # Linux/macOS: use XDG
+        xdg_config = os.environ.get("XDG_CONFIG_HOME")
+        if xdg_config:
+            return Path(xdg_config) / "namecheap"
+        else:
+            return Path.home() / ".config" / "namecheap"
+
+CONFIG_DIR = get_config_dir()
 CONFIG_FILE = CONFIG_DIR / "config.yaml"
 
 
@@ -54,9 +71,23 @@ class Config:
         if self.client:
             return self.client
 
+        # Check if config file exists
+        if not CONFIG_FILE.exists():
+            console.print("[red]❌ Configuration not found![/red]")
+            console.print(f"\nPlease run [bold cyan]namecheap-cli config init[/bold cyan] to set up your configuration.")
+            console.print(f"\nThis will create a config file at: [dim]{CONFIG_FILE}[/dim]")
+            sys.exit(1)
+
         config = self.load_config()
         profile_config = config.get("profiles", {}).get(self.profile, {})
 
+        # Check if profile exists
+        if not profile_config:
+            console.print(f"[red]❌ Profile '{self.profile}' not found in configuration![/red]")
+            console.print(f"\nAvailable profiles: {', '.join(config.get('profiles', {}).keys()) or 'none'}")
+            console.print(f"\nRun [bold cyan]namecheap-cli config init[/bold cyan] to create a new profile.")
+            sys.exit(1)
+
         # Override sandbox if specified
         if self.sandbox is not None:
             profile_config["sandbox"] = self.sandbox
@@ -65,7 +96,14 @@ class Config:
             self.client = Namecheap(**profile_config)
             return self.client
         except Exception as e:
-            console.print(f"[red]❌ Error initializing client: {e}[/red]")
+            # Check for common configuration errors
+            error_msg = str(e)
+            if "Parameter APIUser is missing" in error_msg or "Parameter APIKey is missing" in error_msg:
+                console.print("[red]❌ Invalid or incomplete configuration![/red]")
+                console.print(f"\nYour configuration appears to be missing required fields.")
+                console.print(f"Please run [bold cyan]namecheap-cli config init[/bold cyan] to reconfigure.")
+            else:
+                console.print(f"[red]❌ Error initializing client: {e}[/red]")
             sys.exit(1)
 
 
@@ -213,9 +251,8 @@ def domain_list(config: Config, status: str | None, sort: str, expiring_in: int
 @domain_group.command("check")
 @click.argument("domains", nargs=-1, required=False)
 @click.option("--file", "-f", type=click.File("r"), help="File with domains to check")
-@click.option("--pricing", "-p", is_flag=True, help="Include pricing information")
 @pass_config
-def domain_check(config: Config, domains: tuple[str, ...], file, pricing: bool) -> None:
+def domain_check(config: Config, domains: tuple[str, ...], file) -> None:
     """Check domain availability."""
     nc = config.init_client()
 
@@ -235,39 +272,30 @@ def domain_check(config: Config, domains: tuple[str, ...], file, pricing: bool)
             transient=True,
         ) as progress:
             progress.add_task(f"Checking {len(domain_list)} domains...", total=None)
-            results = nc.domains.check(*domain_list, include_pricing=pricing)
+            results = nc.domains.check(*domain_list, include_pricing=True)
 
         # Output
         if config.output_format == "table":
             table = Table(title="Domain Availability")
             table.add_column("Domain", style="cyan")
             table.add_column("Available", style="green")
-            if pricing:
-                table.add_column("Price", style="yellow")
-                table.add_column("Total", style="yellow")
+            table.add_column("Price (USD/year)", style="yellow")
 
             for result in results:
                 available_text = "✅ Available" if result.available else "❌ Taken"
                 available_style = "green" if result.available else "red"
 
+                if result.available and result.price:
+                    price_text = f"${result.price:.2f}"
+                else:
+                    price_text = "-"
+
                 row = [
                     result.domain,
                     f"[{available_style}]{available_text}[/{available_style}]",
+                    price_text
                 ]
 
-                if pricing and result.available:
-                    if result.price:
-                        price_text = f"${result.price:.2f}"
-                        total_text = (
-                            f"${result.total_price:.2f}" if result.total_price else price_text
-                        )
-                    else:
-                        price_text = "N/A"
-                        total_text = "N/A"
-                    row.extend([price_text, total_text])
-                elif pricing:
-                    row.extend(["-", "-"])
-
                 table.add_row(*row)
 
             console.print(table)
@@ -293,16 +321,11 @@ def domain_check(config: Config, domains: tuple[str, ...], file, pricing: bool)
                     "domain": result.domain,
                     "available": result.available,
                 }
-                if pricing and result.available and result.price:
+                if result.available and result.price:
                     item["price"] = float(result.price)
-                    item["total_price"] = (
-                        float(result.total_price) if result.total_price else float(result.price)
-                    )
                 data.append(item)
 
-            headers = ["domain", "available"]
-            if pricing:
-                headers.extend(["price", "total_price"])
+            headers = ["domain", "available", "price"]
             output_formatter(data, config.output_format, headers)
 
     except NamecheapError as e:
@@ -747,6 +770,12 @@ def config_init() -> None:
         return
 
     console.print("\n[bold cyan]Namecheap CLI Configuration Wizard[/bold cyan]\n")
+    
+    console.print("[dim]To get your API key:[/dim]")
+    console.print("1. Go to [link=https://ap.www.namecheap.com/settings/tools/apiaccess/]https://ap.www.namecheap.com/settings/tools/apiaccess/[/link]")
+    console.print("2. Enable API access")
+    console.print("3. Whitelist your IP address")
+    console.print("4. Generate your API key\n")
 
     # Get configuration values
     api_key = Prompt.ask("API Key", password=True)

{namecheap_python-1.0.0.dist-info → namecheap_python-1.0.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: namecheap-python
-Version: 1.0.0
+Version: 1.0.1
 Summary: A friendly Python SDK for Namecheap API
 Project-URL: Homepage, https://github.com/adriangalilea/namecheap-python
 Project-URL: Repository, https://github.com/adriangalilea/namecheap-python
@@ -26,11 +26,13 @@ Requires-Dist: tldextract>=5.0.0
 Requires-Dist: xmltodict>=0.13.0
 Provides-Extra: all
 Requires-Dist: click>=8.1.0; extra == 'all'
+Requires-Dist: platformdirs>=4.0.0; extra == 'all'
 Requires-Dist: pyyaml>=6.0.0; extra == 'all'
 Requires-Dist: rich>=13.0.0; extra == 'all'
 Requires-Dist: textual>=0.47.0; extra == 'all'
 Provides-Extra: cli
 Requires-Dist: click>=8.1.0; extra == 'cli'
+Requires-Dist: platformdirs>=4.0.0; extra == 'cli'
 Requires-Dist: pyyaml>=6.0.0; extra == 'cli'
 Requires-Dist: rich>=13.0.0; extra == 'cli'
 Provides-Extra: dev
@@ -60,26 +62,17 @@ A modern, friendly Python SDK for the Namecheap API with comprehensive CLI and T
 - **Comprehensive logging** with beautiful colored output
 - **Sandbox support** for safe testing
 
-## 📦 Installation
-
-```bash
-# Core SDK only
-pip install namecheap-python
+## 🎯 Quick Start
 
-# With CLI tool
-pip install namecheap-python[cli]
+**Requires Python 3.12 or higher**
 
-# With TUI tool  
-pip install namecheap-python[tui]
+### `namecheap-python`: Core Python SDK Library
 
-# Everything
-pip install namecheap-python[all]
+```bash
+# Add as a dependency to your project
+uv add namecheap-python
 ```
 
-## 🎯 Quick Start
-
-### SDK Usage
-
 ```python
 from namecheap import Namecheap
 
@@ -107,18 +100,22 @@ nc.dns.set("example.com",
 )
 ```
 
-### CLI Usage
+### `namecheap-cli`: CLI tool
 
-```bash
-# Configure CLI
-uv run namecheap-cli config init
+It was meant as a proof of concept to showcase `namecheap-python`, but it is a tool that I use
 
+```bash
 # List domains with beautiful table output
-uv run namecheap-cli domain list
-```
 
-Output:
-```
+# Run it without install with:
+uvx --from 'namecheap-python[cli]' namecheap-cli domain list
+
+# Or install it permanently with:
+uv tool install --python 3.12 'namecheap-python[cli]'
+
+# Then run
+namecheap-cli domain list
+
                     Domains (4 total)
 ┏━━━━━━━━━━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━━━┓
 ┃ Domain            ┃ Status ┃ Expires    ┃ Auto-Renew ┃ Locked ┃
@@ -130,22 +127,42 @@ Output:
 └───────────────────┴────────┴────────────┴────────────┴────────┘
 ```
 
+Configure it before first use:
+
+```bash
+# Interactive setup
+namecheap-cli config init
+
+# Creates config file at:
+# - Linux/macOS: $XDG_CONFIG_HOME/namecheap/config.yaml (or ~/.config/namecheap/config.yaml)
+# - Windows: %APPDATA%\namecheap\config.yaml
+```
+Check domain availability and pricing:
+
 ```bash
 # Check domain availability
-uv run namecheap-cli domain check myawesome.com coolstartup.io
+❯ namecheap-cli domain check myawesome.com coolstartup.io
+                Domain Availability
+┏━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━┓
+┃ Domain         ┃ Available    ┃ Price (USD/year) ┃
+┡━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━┩
+│ myawesome.com  │ ❌ Taken     │ -                │
+│ coolstartup.io │ ✅ Available │ $34.98           │
+└────────────────┴──────────────┴──────────────────┘
+
+💡 Suggestions for taken domains:
+  • myawesome.com → myawesome.net, myawesome.io, getmyawesome.com
+```
+
+Manage DNS records:
 
-# Manage DNS records
-uv run namecheap-cli dns list example.com
-uv run namecheap-cli dns add example.com A www 192.0.2.1
-uv run namecheap-cli dns export example.com --format yaml
+In this example I'll set up GitHub Pages for my domain `tdo.garden`
 
-# Setup GitHub Pages (example: tdo.garden)
+```bash
 # First, check current DNS records (before setup)
-uv run namecheap-cli dns list tdo.garden
-```
+namecheap-cli dns list tdo.garden
 
-Initial state (Namecheap default parking page):
-```
+# Initial state (Namecheap default parking page):
                          DNS Records for tdo.garden (2 total)
 ┏━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━━┓
 ┃ Type     ┃ Name                 ┃ Value                      ┃ TTL      ┃ Priority ┃
@@ -153,40 +170,34 @@ Initial state (Namecheap default parking page):
 │ CNAME    │ www                  │ parkingpage.namecheap.com. │ 1800     │ 10       │
 │ URL      │ @                    │ http://www.tdo.garden/     │ 1800     │ 10       │
 └──────────┴──────────────────────┴────────────────────────────┴──────────┴──────────┘
-```
 
-```bash
 # Add GitHub Pages A records for apex domain
-❯ uv run namecheap-cli dns add tdo.garden A @ 185.199.108.153
-      Built namecheap-python @ file:///Users/adrian/Developer/namecheap-python
-Uninstalled 1 package in 0.77ms
-Installed 1 package in 1ms
+❯ namecheap-cli dns add tdo.garden A @ 185.199.108.153
 Adding A record to tdo.garden...
 ✅ Added A record successfully!
 
-❯ uv run namecheap-cli dns add tdo.garden A @ 185.199.109.153
+❯ namecheap-cli dns add tdo.garden A @ 185.199.109.153
 Adding A record to tdo.garden...
 ✅ Added A record successfully!
 
-❯ uv run namecheap-cli dns add tdo.garden A @ 185.199.110.153
+❯ namecheap-cli dns add tdo.garden A @ 185.199.110.153
 Adding A record to tdo.garden...
 ✅ Added A record successfully!
 
-❯ uv run namecheap-cli dns add tdo.garden A @ 185.199.111.153
+❯ namecheap-cli dns add tdo.garden A @ 185.199.111.153
 Adding A record to tdo.garden...
 ✅ Added A record successfully!
 
 # Add CNAME for www subdomain
-❯ uv run namecheap-cli dns add tdo.garden CNAME www adriangalilea.github.io
+❯ namecheap-cli dns add tdo.garden CNAME www adriangalilea.github.io
 Adding CNAME record to tdo.garden...
 ✅ Added CNAME record successfully!
 
 # Verify the setup
-❯ uv run namecheap-cli dns list tdo.garden
-```
+❯ namecheap-cli dns list tdo.garden
 
-Final state (with GitHub Pages + old records still present):
-```
+# Final state with GitHub Pages + old records still present that you may want to remove:
+```bash
                          DNS Records for tdo.garden (7 total)
 ┏━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━━┓
 ┃ Type     ┃ Name                 ┃ Value                      ┃ TTL      ┃ Priority ┃
@@ -201,18 +212,27 @@ Final state (with GitHub Pages + old records still present):
 └──────────┴──────────────────────┴────────────────────────────┴──────────┴──────────┘
 ```
 
-Note: You may want to remove the old parking page records after confirming GitHub Pages works.
-```
 
-### TUI Usage
+You can also export DNS records:
+
+```bash
+namecheap-cli dns export example.com --format yaml
+```
+### `namecheap-dns-tui`: TUI for DNS management
 
 ```bash
 # Launch interactive DNS manager
-uv run namecheap-dns-tui
+namecheap-dns-tui
 ```
 
 ![DNS Manager TUI](src/namecheap_dns_tui/assets/screenshot2.png)
 
+## Install both the CLI and TUI
+
+```bash
+uv tool install --python 3.12 'namecheap-python[all]'
+```
+
 ## 📖 Documentation
 
 - **[Examples Overview](examples/README.md)** - Quick examples for all tools
@@ -251,15 +271,6 @@ nc = Namecheap(
 )
 ```
 
-### CLI Configuration
-
-```bash
-# Interactive setup
-uv run namecheap-cli config init
-
-# Creates ~/.namecheap/config.yaml with profiles
-```
-
 ## 🔧 Advanced SDK Usage
 
 ### DNS Builder Pattern
@@ -376,4 +387,4 @@ MIT License - see [LICENSE](LICENSE) file for details.
 
 ## 🤝 Contributing
 
-Contributions are welcome! Please feel free to submit a Pull Request. See the [Development Guide](docs/dev/README.md) for setup instructions and guidelines.
+Contributions are welcome! Please feel free to submit a Pull Request. See the [Development Guide](docs/dev/README.md) for setup instructions and guidelines.

{namecheap_python-1.0.0.dist-info → namecheap_python-1.0.1.dist-info}/RECORD

@@ -9,7 +9,7 @@ namecheap/_api/dns.py,sha256=Yvx91QIWrDx3ZxxmH_NLo_M9MP55aL71CJ6mXyJZUT0,10813
 namecheap/_api/domains.py,sha256=EUXV7R5wQyPHQHfDITe2IWRlPF7V-df-K0q2XnrvshI,16113
 namecheap_cli/README.md,sha256=liduIiGr8DHXGTht5swrYnvtAlcdCMQOnSdCD61g4Vw,7337
 namecheap_cli/__init__.py,sha256=nGRHc_CkO4xKhSQdAVG-koEffP8VS0TvbfbZkg7Jg4k,108
-namecheap_cli/__main__.py,sha256=OyE_oKtBXxWzxF-yGJQy9IbQL5FJ-5rP5ElrKS4Yu8E,28733
+namecheap_cli/__main__.py,sha256=l-9egf6_9Gitocq10f2agcyjubd-1KFC76K4kAFGiNQ,30154
 namecheap_cli/completion.py,sha256=JTEMnceQli7TombjZkHh-IcZKW4RFRI8Yk5VynxPsEA,2777
 namecheap_dns_tui/README.md,sha256=It16ZiZh0haEeaENfF5HX0Ec4dBawdTYiAi-TiG9wi0,1690
 namecheap_dns_tui/__init__.py,sha256=-yL_1Ha41FlQcmjG-raUrZP9CjTJD3d0w2BW2X-twJg,106
@@ -18,8 +18,8 @@ namecheap_dns_tui/assets/screenshot1.png,sha256=OXO2P80ll5WRzLYgaakcNnzos8svlJoX
 namecheap_dns_tui/assets/screenshot2.png,sha256=5VN_qDMNhWEyrOqKw7vxl1h-TgmZQ_V9aph3Xmf_AFg,279194
 namecheap_dns_tui/assets/screenshot3.png,sha256=h39wSKxx1JCkgeAB7Q3_JlBcAtX1vsRFKtWtOwbBVso,220625
 namecheap_dns_tui/assets/screenshot4.png,sha256=J4nCOW16z3vaRiPbcMiiIRgV7q3XFbi_1N1ivD1Pa4Y,238068
-namecheap_python-1.0.0.dist-info/METADATA,sha256=wq_qAcQp7Tv5YuqypDFVpomVr1djHhfCc_FRBXR3RpM,13101
-namecheap_python-1.0.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-namecheap_python-1.0.0.dist-info/entry_points.txt,sha256=AyhiXroLUpM0Vdo_-RvH0S8o4XDPsDlsEl_65vm6DEk,96
-namecheap_python-1.0.0.dist-info/licenses/LICENSE,sha256=pemTblFP6BBje3bBv_yL_sr2iAqB2H0-LdWMvVIR42o,1062
-namecheap_python-1.0.0.dist-info/RECORD,,
+namecheap_python-1.0.1.dist-info/METADATA,sha256=BUpPd6I_zUAB0oy3aJ9iwG0iI6T88dHxx2sY1W-BtJI,14130
+namecheap_python-1.0.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+namecheap_python-1.0.1.dist-info/entry_points.txt,sha256=AyhiXroLUpM0Vdo_-RvH0S8o4XDPsDlsEl_65vm6DEk,96
+namecheap_python-1.0.1.dist-info/licenses/LICENSE,sha256=pemTblFP6BBje3bBv_yL_sr2iAqB2H0-LdWMvVIR42o,1062
+namecheap_python-1.0.1.dist-info/RECORD,,