Merge pull request #5 from porkbundomains/mac-pip-install

Footnote for Mac OS users
This commit is contained in:
Ross 2021-09-13 16:29:48 -07:00 committed by GitHub
commit e653987444
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -7,9 +7,11 @@ Installation:
1. Install Python if it's not already installed. This client is Python 2-compatible so it should run out of the box on MacOS and many Linux distributions. If you're running Windows, you should download the most recent production Python version. 1. Install Python if it's not already installed. This client is Python 2-compatible so it should run out of the box on MacOS and many Linux distributions. If you're running Windows, you should download the most recent production Python version.
2. Download and uncompress porkbun-dynamic-dns-python to the folder of your choice 2. Download and uncompress porkbun-dynamic-dns-python to the folder of your choice
3. Install the *requests* library: 3. Install the *requests* library:
`pip install requests` `pip install requests`*
4. Rename config.json.example to config.json and paste in your generated API and Secret keys. Save the config file. If you haven't yet generated the keys, check out our [Getting Started Guide.](https://kb.porkbun.com/article/190-getting-started-with-the-porkbun-dns-api) 4. Rename config.json.example to config.json and paste in your generated API and Secret keys. Save the config file. If you haven't yet generated the keys, check out our [Getting Started Guide.](https://kb.porkbun.com/article/190-getting-started-with-the-porkbun-dns-api)
* If running the DDNS client on MacOS with the default Python 2.7, run `ensurepip --upgrade --user` first then run `pip install requests --user`
## Running the client ## Running the client
#### Root domain #### Root domain