Skip to content

Commit 5d0e7e3

Browse files
authored
Update README.md (terminusdb#403)
Fixed documentation links
1 parent 2e968a6 commit 5d0e7e3

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

README.md

+13-13
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[![TerminusDB Python Client](https://assets.terminusdb.com/readmes/terminusdb-client-python/header.gif)][terminusdb-client-python-docs]
22

3-
[terminusdb-client-python-docs]: https://terminusdb.com/docs/guides/reference-guides/python-client-reference
3+
[terminusdb-client-python-docs]: https://terminusdb.com/docs/python
44

55
---
66

@@ -12,7 +12,7 @@
1212
[![downloads](https://img.shields.io/pypi/dm/terminusdb-client.svg?logo=pypi)](https://pypi.python.org/pypi/terminusdb-client/)
1313

1414
[![build status](https://img.shields.io/github/workflow/status/terminusdb/terminusdb-client-python/Python%20package?logo=github)](https://github.com/terminusdb/terminusdb-client-python/actions)
15-
[![documentation](https://img.shields.io/github/deployments/terminusdb/terminusdb-client-python/github-pages?label=documentation&logo=github)](https://terminusdb.com/docs/guides/reference-guides/python-client-reference)
15+
[![documentation](https://img.shields.io/github/deployments/terminusdb/terminusdb-client-python/github-pages?label=documentation&logo=github)](https://terminusdb.com/docs/python)
1616
[![code coverage](https://codecov.io/gh/terminusdb/terminusdb-client-python/branch/main/graph/badge.svg?token=BclAUaOPnQ)](https://codecov.io/gh/terminusdb/terminusdb-client-python)
1717
[![license](https://img.shields.io/github/license/terminusdb/terminusdb-client-python?color=pink&logo=apache)](https://github.com/terminusdb/terminusdb-client-python/blob/main/LICENSE)
1818

@@ -26,7 +26,7 @@ graph all through a simple document API.
2626
[terminusdb-docs]: https://terminusdb.com/docs/
2727
[terminusdb-repo]: https://github.com/terminusdb/terminusdb
2828

29-
[**TerminusCMS**](https://terminusdb.com/terminuscms/) is a hosted headless content management system. It is built upon TerminusDB and is a developer focused data management platform for complex data and content infrastructure. [Sign up and clone a demo project to see how it works][dashboard].
29+
[**TerminusCMS**](https://terminusdb.com/terminuscms/) is a hosted headless content management system. It is built upon TerminusDB and is a developer-focused data management platform for complex data and content infrastructure. [Sign up and clone a demo project to see how it works][dashboard].
3030

3131
[dashboard]: https://dashboard.terminusdb.com/
3232

@@ -40,16 +40,16 @@ graph all through a simple document API.
4040
TerminusDB Client v10.0 works with TerminusDB v10.0 and TerminusCMS. Please check the [Release Notes](RELEASE_NOTES.md) to find out what has changed.
4141

4242
## Installation
43-
- TerminusDB Client can be downloaded form PyPI using pip:
43+
- TerminusDB Client can be downloaded from PyPI using pip:
4444
`python -m pip install terminusdb-client`
4545

4646
This only includes the core Python Client (Client) and WOQLQuery.
4747

48-
If you want to use woqlDataframe or the import and export csv function in Scaffolding CLI tool:
48+
If you want to use woqlDataframe or the import and export CSV function in the Scaffolding CLI tool:
4949

5050
`python -m pip install terminusdb-client[dataframe]`
5151

52-
*if you are installing form `zsh` you have to quote the argument like this:*
52+
*if you are installing from `zsh` you have to quote the argument like this:*
5353

5454
`python -m pip install 'terminusdb-client[dataframe]'`
5555

@@ -78,7 +78,7 @@ client.connect()
7878

7979
Connect to TerminusCMS
8080

81-
*check documentation for TerminusCMS about how to add the [API token](https://terminusdb.com/docs/terminuscms/get-api-key) to the environment variable*
81+
*check the documentation for TerminusCMS about how to add the [API token](https://terminusdb.com/docs/how-to-connect-terminuscms) to the environment variable*
8282

8383

8484
```Python
@@ -112,7 +112,7 @@ class Pet(DocumentTemplate):
112112
my_schema.commit(client)
113113
```
114114

115-
#### Create and insert doucments
115+
#### Create and insert documents
116116

117117
```Python
118118
my_dog = Pet(name="Honda", species="Huskey", age=3, weight=21.1)
@@ -155,7 +155,7 @@ Start a project in the directory
155155
```bash
156156
$ tdbpy startproject
157157
Please enter a project name (this will also be the database name): mydb
158-
Please enter a endpoint location (press enter to use localhost default) [http://127.0.0.1:6363/]:
158+
Please enter an endpoint location (press enter to use localhost default) [http://127.0.0.1:6363/]:
159159
config.json and schema.py created, please customize them to start your project.
160160
```
161161

@@ -181,15 +181,15 @@ Delete the database
181181

182182
```bash
183183
$ tdbpy deletedb
184-
Do you want to delete 'mydb'? WARNING: This opertation is non-reversible. [y/N]: y
184+
Do you want to delete 'mydb'? WARNING: This operation is non-reversible. [y/N]: y
185185
mydb deleted.
186186
```
187187

188188
### Please check the [full Documentation](https://terminusdb.com/docs/guides/reference-guides/python-client-reference) for more information.
189189

190190
## Guides & Tutorials
191191

192-
Visit our documentation for a range of short how to guides, [how-to use the Python Client](https://terminusdb.com/docs/guides/how-to-guides/use-the-python-client) and [how to use the collaboration features with the Python Client](https://terminusdb.com/docs/guides/how-to-guides/use-collaboration-features/with-the-python-client). Alternatively, undertake the [Getting Started with the Python Client Tutorial Series.](https://github.com/terminusdb/terminusdb-tutorials/blob/main/getting_started/python-client/README.md).
192+
Visit our documentation for a range of short how-to guides, [how-to use the Python Client](https://terminusdb.com/docs/use-the-python-client) and [how to use the collaboration features with the Python Client](https://terminusdb.com/docs/collaboration-with-python-client). Alternatively, undertake the [Getting Started with the Python Client Tutorial Series.](https://github.com/terminusdb/terminusdb-tutorials/blob/main/getting_started/python-client/README.md).
193193

194194
## Testing
195195

@@ -229,7 +229,7 @@ Documentation specifically on the latest version of the Python Client can be fou
229229
$ make init
230230
```
231231

232-
3. Change directory to docs
232+
3. Change the directory to docs
233233
```sh
234234
$ cd docs/
235235
```
@@ -250,7 +250,7 @@ If you have other questions, you can ask in our community [community Subreddit](
250250
## Community
251251

252252
Come visit us on our [discord server](https://discord.gg/yTJKAma)
253-
or our [community Subreddit](https://www.reddit.com/r/TerminusDB/). We are also on [twitter](https://twitter.com/TerminusDB)
253+
or our [community Subreddit](https://www.reddit.com/r/TerminusDB/). We are also on [Twitter](https://twitter.com/TerminusDB)
254254
<img align="right" src="https://assets.terminusdb.com/images/TerminusDB%20color%20mascot.png" width="256px"/>
255255

256256
## Contribute

0 commit comments

Comments
 (0)