This repository has been archived by the owner on Feb 5, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 3
/
README.txt
114 lines (73 loc) · 2.28 KB
/
README.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
BotOVH is a tiny bot I wrote for my personnal needs.
Is your domain name already taken? Tell BotOVH to grab it for you when it becomes available for registration.
------------
Requirements
------------
- OVH Account
- OVH API application
- Python 3.6+
------------
Installation
------------
1. Install BotOVH using pip
``pip install botovh``
BotOVH automatically installs the following dependencies:
- docopt
- python-ovh
2. Create an OVH API application
To interact with the OVH APIs, BotOVH needs to identify itself using an application_key and an application_secret. To get them, you need to register an OVH API application.
Once created, you will obtain an application key and an application secret.
3. Configure BotOVH
Create an ``botovh.conf`` configuration file at :
- Windows : ``C:\Users\<YOUR_WINDOWS_USERNAME>\.botovh\botovh.conf``
- Linux / Mac : ``/etc/botovh.conf``
Here is how the configuration file looks like :
OVH API
-------
```ini
[OVH]
ENDPOINT=ovh-eu
APPLICATION_KEY=<YOUR_APPLICATION_KEY>
APPLICATION_SECRET=<YOUR_APPLICATION_SECRET>
; Use 'botovh --key' to request your OVH consumer key.
CONSUMER_KEY=<YOUR__CONSUMER_KEY>
```
Email notification
------------------
```ini
[SMTP]
; Send email notification.
HOST=<SMTP_SERVER_ADDRESS>
PORT=465
USER=<YOUR_SMTP_USER>
PASSWORD=<YOUR_SMTP_PASSWORD>
SEND_FROM=<SEND_EMAIL_FROM>
SEND_TO=<SEND_EMAIL_TO>
```
-----
Usage
-----
Request a new OVH consumer key:
``$ botovh -k``
``$ botovh --key``
Basic usage:
``$ botovh example.com fakedomain.org``
Specify a file containing the domain names you want to check:
``$ botovh -f /path/to/file.txt``
``$ botovh --file /path/to/file.txt``
Specify your preferred payment method:
Payment methods: bankAccount, creditCard, fidelityAccount, ovhAccount or paypal.
``$ botovh -p paypal``
``$ botovh --payment creditCard``
Disable console logging using the ``--quiet`` argument:
``$ botovh example.com fakedomain.org --quiet``
Disable email notification using the ``--noemail`` argument:
``$ botovh example.com fakedomain.org --noemail``
---------------
Automate BotOVH
---------------
You can automate BotOVH to run daily using cron jobs or task scheduler depending on your system.
-------
License
-------
This code is released under a free software license and you are welcome to fork it.