Skip to content

Commit 0bb48f1

Browse files
Readme: use footnote links
1 parent d5872b1 commit 0bb48f1

File tree

1 file changed

+15
-7
lines changed

1 file changed

+15
-7
lines changed

README.md

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
[![Supported Python versions](https://img.shields.io/pypi/pyversions/deepl.svg)](https://pypi.org/project/deepl/)
55
[![License: MIT](https://img.shields.io/badge/license-MIT-blueviolet.svg)](https://github.com/DeepLcom/deepl-python/blob/main/LICENSE)
66

7-
The [DeepL API](https://www.deepl.com/docs-api?utm_source=github&utm_medium=github-python-readme) is a language
7+
The [DeepL API][api-docs] is a language
88
translation API that allows other computer programs to send texts and documents to DeepL's servers and receive
99
high-quality translations. This opens a whole universe of opportunities for developers: any translation product you can
1010
imagine can now be built on top of DeepL's best-in-class translation technology.
@@ -16,12 +16,12 @@ they’re added to the API.
1616

1717
## Getting an authentication key
1818

19-
To use the DeepL Python Library, you'll need an API authentication key. To get a key, [please create an account here](https://www.deepl.com/pro?utm_source=github&utm_medium=github-python-readme#developer). You can translate up to 500,000 characters/month for free.
19+
To use the DeepL Python Library, you'll need an API authentication key. To get a key, [please create an account here][create-account]. You can translate up to 500,000 characters/month for free.
2020

21-
After you have created an account, you can find your API authentication key on your [DeepL Pro Account](https://www.deepl.com/pro-account/?utm_source=github&utm_medium=github-python-readme).
21+
After you have created an account, you can find your API authentication key on your [DeepL Pro Account][pro-account].
2222

2323
## Installation
24-
The library can be installed from [PyPI](https://pypi.org/project/deepl/) using pip:
24+
The library can be installed from [PyPI][pypi-project] using pip:
2525
```shell
2626
pip install --upgrade deepl
2727
```
@@ -144,7 +144,7 @@ translator = deepl.Translator(..., proxy=proxy)
144144
```
145145

146146
The proxy argument is passed to the underlying `requests` session,
147-
[see the documentation here](https://docs.python-requests.org/en/latest/user/advanced/#proxies); a dictionary of schemes
147+
[see the documentation here][requests-proxy-docs]; a dictionary of schemes
148148
to proxy URLs is also accepted.
149149

150150
## Command Line Interface
@@ -177,7 +177,7 @@ Wrap text arguments in quotes to prevent the shell from splitting sentences into
177177
## Issues
178178

179179
If you experience problems using the library, or would like to request a new feature, please open an
180-
[issue](https://www.github.com/DeepLcom/deepl-python/issues).
180+
[issue][issues].
181181

182182
## Development
183183

@@ -191,8 +191,16 @@ Execute the tests using `pytest`. The tests communicate with the DeepL API using
191191
Be aware that the tests make DeepL API requests that contribute toward your API usage.
192192

193193
The test suite may instead be configured to communicate with the mock-server provided by
194-
[deepl-mock](https://www.github.com/DeepLcom/deepl-mock). Although most test cases work for either, some test cases work
194+
[deepl-mock][deepl-mock]. Although most test cases work for either, some test cases work
195195
only with the DeepL API or the mock-server and will be otherwise skipped. The test cases that require the mock-server
196196
trigger server errors and test the client error-handling. To execute the tests using deepl-mock, run it in another
197197
terminal while executing the tests. Execute the tests using `pytest` with the `DEEPL_MOCK_SERVER_PORT` and
198198
`DEEPL_SERVER_URL` environment variables defined referring to the mock-server.
199+
200+
[api-docs]: https://www.deepl.com/docs-api?utm_source=github&utm_medium=github-python-readme
201+
[create-account]: https://www.deepl.com/pro?utm_source=github&utm_medium=github-python-readme#developer
202+
[deepl-mock]: https://www.github.com/DeepLcom/deepl-mock
203+
[issues]: https://www.github.com/DeepLcom/deepl-python/issues
204+
[pypi-project]: https://pypi.org/project/deepl/
205+
[pro-account]: https://www.deepl.com/pro-account/?utm_source=github&utm_medium=github-python-readme
206+
[requests-proxy-docs]: https://docs.python-requests.org/en/latest/user/advanced/#proxies

0 commit comments

Comments
 (0)