https://github.com/terminusdb/terminusdb-client-python
TerminusDB Python Client
https://github.com/terminusdb/terminusdb-client-python
api-client hacktoberfest python query query-language terminusdb
Last synced: about 2 months ago
JSON representation
TerminusDB Python Client
- Host: GitHub
- URL: https://github.com/terminusdb/terminusdb-client-python
- Owner: terminusdb
- License: apache-2.0
- Created: 2019-09-13T16:23:46.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2024-06-10T10:37:33.000Z (12 months ago)
- Last Synced: 2025-03-30T01:08:38.134Z (about 2 months ago)
- Topics: api-client, hacktoberfest, python, query, query-language, terminusdb
- Language: Python
- Homepage: https://terminusdb.com/
- Size: 8.99 MB
- Stars: 75
- Watchers: 5
- Forks: 58
- Open Issues: 31
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
[][terminusdb-client-python-docs]
[terminusdb-client-python-docs]: https://terminusdb.com/docs/python
---
[](https://discord.gg/yTJKAma)
[](https://www.reddit.com/r/TerminusDB/)
[](https://twitter.com/TerminusDB)
[](https://pypi.python.org/pypi/terminusdb-client/)
[](https://pypi.python.org/pypi/terminusdb-client/)
[](https://github.com/terminusdb/terminusdb-client-python/actions)
[](https://terminusdb.com/docs/python)
[](https://codecov.io/gh/terminusdb/terminusdb-client-python)
[](https://github.com/terminusdb/terminusdb-client-python/blob/main/LICENSE)
> Python client for TerminusDB and TerminusCMS.
[**TerminusDB**][terminusdb] is an [open-source][terminusdb-repo] graph database
and document store. It allows you to link JSON documents in a powerful knowledge
graph all through a simple document API.
[terminusdb]: https://terminusdb.com/
[terminusdb-docs]: https://terminusdb.com/docs/
[terminusdb-repo]: https://github.com/terminusdb/terminusdb
[**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].
[dashboard]: https://dashboard.terminusdb.com/
## Requirements
- [TerminusDB v10.0](https://github.com/terminusdb/terminusdb-server)
- [Python >=3.7](https://www.python.org/downloads)
## Release Notes and Previous Versions
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.
## Installation
- TerminusDB Client can be downloaded from PyPI using pip:
`python -m pip install terminusdb-client`
This only includes the core Python Client (Client) and WOQLQuery.
If you want to use woqlDataframe or the import and export CSV function in the Scaffolding CLI tool:
`python -m pip install terminusdb-client[dataframe]`
*if you are installing from `zsh` you have to quote the argument like this:*
`python -m pip install 'terminusdb-client[dataframe]'`
- Install from source:
`python -m pip install git+https://github.com/terminusdb/terminusdb-client-python.git`
## Demo
## Usage
### Python client
#### Connect to a server
Connect to local host
```Python
from terminusdb_client import Client
client = Client("http://127.0.0.1:6363/")
client.connect()
```
Connect to TerminusCMS
*check the documentation for TerminusCMS about how to add the [API token](https://terminusdb.com/docs/how-to-connect-terminuscms) to the environment variable*
```Python
from terminusdb_client import Client
team="MyTeam"
client = Client(f"https://dashboard.terminusdb.com/{team}/")
client.connect(team="MyTeam", use_token=True)
```
#### Create a database
```Python
client.create_database("MyDatabase")
```
#### Create a schema
```Python
from terminusdb_client.schema import Schema, DocumentTemplate, RandomKey
my_schema = Schema()
class Pet(DocumentTemplate):
_schema = my_schema
name: str
species: str
age: int
weight: float
my_schema.commit(client)
```
#### Create and insert documents
```Python
my_dog = Pet(name="Honda", species="Huskey", age=3, weight=21.1)
my_cat = Pet(name="Tiger", species="Bengal cat", age=5, weight=4.5)
client.insert_document([my_dog, my_cat])
```
#### Get back all documents
```Python
print(list(client.get_all_documents()))
```
```
[{'@id': 'Pet/b5edacf854e34fe79c228a91e2af45fb', '@type': 'Pet', 'age': 5, 'name': 'Tiger', 'species': 'Bengal cat', 'weight': 4.5}, {'@id': 'Pet/cdbe3f6d49394b38b952ae315309256d', '@type': 'Pet', 'age': 3, 'name': 'Honda', 'species': 'Huskey', 'weight': 21.1}]
```
#### Get a specific document
```Python
print(list(client.query_document({"@type":"Pet", "age":5})))
```
```
[{'@id': 'Pet/145eb73966d14a1394f7cd5576d7d0b8', '@type': 'Pet', 'age': 5, 'name': 'Tiger', 'species': 'Bengal cat', 'weight': 4.5}]
```
#### Delete a database
```Python
client.delete_database("MyDatabase")
```
### Scaffolding CLI tool
Start a project in the directory
```bash
$ tdbpy startproject
Please enter a project name (this will also be the database name): mydb
Please enter an endpoint location (press enter to use localhost default) [http://127.0.0.1:6363/]:
config.json and schema.py created, please customize them to start your project.
```
Import a CSV named `grades.csv`
``` bash
$ tdbpy importcsv grades.csv --na=error
0it [00:00, ?it/s]
Schema object Grades created with grades.csv inserted into database.
schema.py is updated with mydb schema.
1it [00:00, 1.00it/s]
Records in grades.csv inserted as type Grades into database with Lexical ids.
```
Get documents with query
```bash
$ tdbpy alldocs --type Grades -q grade="B-"
[{'@id': 'Grades/Android_Electric_087-65-4321_42.0_23.0_36.0_45.0_47.0_B-', '@type': 'Grades', 'final': 47.0, 'first_name': 'Electric', 'grade': 'B-', 'last_name': 'Android', 'ssn': '087-65-4321', 'test1': 42.0, 'test2': 23.0, 'test3': 36.0, 'test4': 45.0}, {'@id': 'Grades/Elephant_Ima_456-71-9012_45.0_1.0_78.0_88.0_77.0_B-', '@type': 'Grades', 'final': 77.0, 'first_name': 'Ima', 'grade': 'B-', 'last_name': 'Elephant', 'ssn': '456-71-9012', 'test1': 45.0, 'test2': 1.0, 'test3': 78.0, 'test4': 88.0}, {'@id': 'Grades/Franklin_Benny_234-56-2890_50.0_1.0_90.0_80.0_90.0_B-', '@type': 'Grades', 'final': 90.0, 'first_name': 'Benny', 'grade': 'B-', 'last_name': 'Franklin', 'ssn': '234-56-2890', 'test1': 50.0, 'test2': 1.0, 'test3': 90.0, 'test4': 80.0}]
```
Delete the database
```bash
$ tdbpy deletedb
Do you want to delete 'mydb'? WARNING: This operation is non-reversible. [y/N]: y
mydb deleted.
```
### Please check the [full Documentation](https://terminusdb.com/docs/python) for more information.
## Guides & Tutorials
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).
## Testing
1. Clone this repository
`git clone https://github.com/terminusdb/terminusdb-client-python.git`
2. Install all development dependencies using poetry
```sh
$ make init
```
3. (a) To run test files only
```sh
$ poetry run pytest terminusdb_client/tests
```
3. (b) To run full test
```sh
$ poetry run tox -e test
```
Or you can run tests in [poetry shell](https://python-poetry.org/docs/basic-usage/#activating-the-virtual-environment) then no need to use `poetry run`
## Documentation
Visit our [TerminusDB Documentation][terminusdb-docs] for the full explanation of using TerminusDB.
Documentation specifically on the latest version of the Python Client can be found [here][terminusdb-client-python-docs].
### Generating Documentation Locally using Sphinx
1. Clone this repository
`git clone https://github.com/terminusdb/terminusdb-client-python.git`
2. Install all development dependencies
```sh
$ make init
```
3. Change the directory to docs
```sh
$ cd docs/
```
4. Build with Sphinx
```sh
$ make html
```
The output files are under `docs/build/html`, open `index.html` in your browser to inspect.
## Report Issues
If you encounter any issues, please [report them](https://github.com/terminusdb/terminusdb-client-python/issues) with your os and environment setup, the version that you are using and a simple reproducible case.
If you have other questions, you can ask in our community [community Subreddit](https://www.reddit.com/r/TerminusDB/) or [Discord server](https://discord.gg/Gvdqw97).
## Community
Come visit us on our [discord server](https://discord.gg/yTJKAma)
or our [community Subreddit](https://www.reddit.com/r/TerminusDB/). We are also on [Twitter](https://twitter.com/TerminusDB)
## Contribute
It will be nice, if you open an issue first so that we can know what is going on, then, fork this repo and push in your ideas. Do not forget to add some test(s) of what value you adding.
Please check [CONTRIBUTING.md](CONTRIBUTING.md) for more information.
## Licence
Apache License (Version 2.0)
Copyright (c) 2019