Skip to content

Commit e898c81

Browse files
author
Alvaro Navarro
committed
Update README.rst
- Fix broken links - Update link to SDK reference documentation - Fix typos
1 parent 4a71087 commit e898c81

File tree

1 file changed

+19
-46
lines changed

1 file changed

+19
-46
lines changed

README.rst

Lines changed: 19 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,9 @@ Amadeus Python SDK
77
Amadeus provides a set of APIs for the travel industry. Flights, Hotels,
88
Locations and more.
99

10-
For more details see the `Python
11-
documentation <https://developers.amadeus.com/docs/python>`__ on
12-
`Amadeus.com <https://developers.amadeus.com>`__ and the `class
13-
reference <https://amadeus4dev.github.io/amadeus-python>`__ here on
14-
GitHub.
10+
For more details see the `Amadeus for Developers Portal
11+
<https://developers.amadeus.com>`__ and the `class reference
12+
<https://amadeus4dev.github.io/amadeus-python>`__ here on GitHub.
1513

1614
Installation
1715
------------
@@ -23,16 +21,12 @@ directly with pip.
2321
2422
pip install amadeus==1.0.0b7
2523
26-
**Next**: `Get Started with the Python
27-
SDK. <https://developers.amadeus.com/docs/python/get_started/initialize>`__
28-
2924
Getting Started
3025
---------------
3126

32-
To make your first API call you will need to `register for an
33-
Amadeus Developer Account <https://developers.amadeus.com/register>`__
34-
and `set up your first
35-
application <https://dashboard.developers.amadeus.com/applications>`__.
27+
To make your first API call you will need to `register for an Amadeus Developer
28+
Account <https://developers.amadeus.com/create-account>`__ and set up your first
29+
application.
3630

3731
.. code:: py
3832
@@ -50,9 +44,6 @@ application <https://dashboard.developers.amadeus.com/applications>`__.
5044
except ResponseError as error:
5145
print(error)
5246
53-
**Next**: `Learn more about checkin
54-
links <https://developers.amadeus.com/docs/python/get_started/checkin_links>`__
55-
with our Python SDK.
5647
5748
Initialization
5849
--------------
@@ -72,9 +63,8 @@ environment variables ``AMADEUS_CLIENT_ID`` and
7263
7364
amadeus = Client()
7465
75-
Your credentials can be found on the `Amadeus
76-
dashboard <https://dashboard.developers.amadeus.com/client_ids>`__. `Sign
77-
up <https://developers.amadeus.com/register>`__ for an account today.
66+
Your credentials can be found on the `Amadeus dashboard
67+
<https://developers.amadeus.com>`__. Sign up for an account today.
7868

7969
By default the environment for the SDK is the ``test`` environment. To
8070
switch to a production (paid-for) environment please switch the hostname
@@ -84,36 +74,19 @@ as follows:
8474
8575
amadeus = Client(hostname='production')
8676
87-
**Next**: `Learn more about our initializing the Python
88-
SDK <https://developers.amadeus.com/docs/python/get_started_initialize>`__
89-
in our documentation.
90-
9177
Documentation
9278
-------------
9379

94-
Amadeus has a large set of APIs, and our documentation is here to get
95-
you started today.
96-
97-
- `Get
98-
Started <https://developers.amadeus.com/docs/python/get_started>`__
99-
documentation
100-
101-
- `Initialize the
102-
SDK <https://developers.amadeus.com/docs/python/get_started/initialize>`__
103-
- `Find an
104-
Airport <https://developers.amadeus.com/docs/python/get_started/find_an_airport>`__
105-
- `Book a
106-
Flight <https://developers.amadeus.com/docs/python/get_started/book_a_flight>`__
107-
- `Get Flight
108-
Inspiration <https://developers.amadeus.com/docs/python/get_started/get_flight_inspiration>`__
109-
110-
Alternatively, head over to our
111-
`Reference <https://developers.amadeus.com/docs/python/reference>`__
112-
documentation for in-depth information about every SDK method, it’s
113-
arguments and return types.
80+
Amadeus has a large set of APIs, and our documentation is here to get you
81+
started today. Head over to our `Reference
82+
<https://amadeus4dev.github.io/amadeus-python/>`__
83+
documentation for in-depth information about every SDK method, it’s arguments
84+
and return types.
11485

115-
Additionally, this SDK has extensive documentation of itself available
116-
on `GitHub <https://amadeus4dev.github.io/amadeus-python/>`__.
86+
- `Initialize the SDK <https://amadeus4dev.github.io/amadeus-python/#/client>`__
87+
- `Find an Airport <https://amadeus4dev.github.io/amadeus-python/#referencedata-locations>`__
88+
- `Find a Flight <https://amadeus4dev.github.io/amadeus-python/#shopping-flights>`__
89+
- `Get Flight Inspiration <https://amadeus4dev.github.io/amadeus-python/#shopping-flights>`__
11790

11891
Making API calls
11992
----------------
@@ -231,9 +204,9 @@ Help
231204
----
232205

233206
Our `developer support
234-
team <https://developers.amadeus.com/developers>`__ is here to help you.
207+
team <https://developers.amadeus.com/support>`__ is here to help you.
235208
You can find us on `Twitter <#>`__, `StackOverflow <#>`__, and
236-
`email <#>`__.
209+
`email <mailto:[email protected]>`__.
237210

238211
.. |Module Version| image:: https://badge.fury.io/py/amadeus.svg?v=1
239212
:target: https://pypi.org/project/amadeus/

0 commit comments

Comments
 (0)