%global _empty_manifest_terminate_build 0
Name: python-terminusdb-client
Version: 10.2.2
Release: 1
Summary: Python client for Terminus DB
License: Apache Software License
URL: https://github.com/terminusdb/terminusdb-client-python
Source0: https://mirrors.nju.edu.cn/pypi/web/packages/6c/eb/b59cb709bbc57e743d47ebab0df18e0bcffc9a908c70e2b83f61bdf57c3c/terminusdb-client-10.2.2.tar.gz
BuildArch: noarch
Requires: python3-requests
Requires: python3-numpydoc
Requires: python3-click
Requires: python3-shed
Requires: python3-typeguard
Requires: python3-tqdm
Requires: python3-numpy
Requires: python3-pandas
%description
[](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.github.io/terminusdb-client-python/)
[](https://codecov.io/gh/terminusdb/terminusdb-client-python)
[](https://github.com/terminusdb/terminusdb-client-python/blob/main/LICENSE)
> Python client for TerminusDB and TerminusX.
[**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
**TerminusX** is TerminusDB as a service. SOC 2 certified hosting. Build your beta and get to market fast. Scale up and deploy your own instance. [Sign up now][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 TerminusX. Please check the [Release Notes](https://github.com/terminusdb/terminusdb-client-python/blob/master/RELEASE_NOTES.md) to find out what has changed.
## Installation
- TerminusDB Client can be downloaded form 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 Scaffolding CLI tool:
`python -m pip install terminusdb-client[dataframe]`
*if you are installing form `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 TerminusX
*check documentation for TerminusX about how to add the API token 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 doucments
```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 a 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 opertation is non-reversible. [y/N]: y
mydb deleted.
```
### Please check the [full Documentation](https://terminusdb.github.io/terminusdb-client-python/) for more information.
## Tutorials
There is a [list of examples](https://terminusdb.github.io/terminusdb-client-python/tutorials.html) that uses the Python client in our [tutorial repo](https://github.com/terminusdb/terminus-tutorials/). As a start, we would recommend having a look at [create TerminusDB graph with Python client using Jupyter notebook](https://github.com/terminusdb/terminusdb-tutorials/blob/master/bike-tutorial/python/Create%20TerminusDB%20Graph%20with%20Python%20Client.ipynb)
## 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 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](https://github.com/terminusdb/terminusdb-client-python/blob/master/CONTRIBUTING.md) for more information.
## Licence
Apache License (Version 2.0)
Copyright (c) 2019
%package -n python3-terminusdb-client
Summary: Python client for Terminus DB
Provides: python-terminusdb-client
BuildRequires: python3-devel
BuildRequires: python3-setuptools
BuildRequires: python3-pip
%description -n python3-terminusdb-client
[](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.github.io/terminusdb-client-python/)
[](https://codecov.io/gh/terminusdb/terminusdb-client-python)
[](https://github.com/terminusdb/terminusdb-client-python/blob/main/LICENSE)
> Python client for TerminusDB and TerminusX.
[**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
**TerminusX** is TerminusDB as a service. SOC 2 certified hosting. Build your beta and get to market fast. Scale up and deploy your own instance. [Sign up now][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 TerminusX. Please check the [Release Notes](https://github.com/terminusdb/terminusdb-client-python/blob/master/RELEASE_NOTES.md) to find out what has changed.
## Installation
- TerminusDB Client can be downloaded form 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 Scaffolding CLI tool:
`python -m pip install terminusdb-client[dataframe]`
*if you are installing form `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 TerminusX
*check documentation for TerminusX about how to add the API token 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 doucments
```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 a 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 opertation is non-reversible. [y/N]: y
mydb deleted.
```
### Please check the [full Documentation](https://terminusdb.github.io/terminusdb-client-python/) for more information.
## Tutorials
There is a [list of examples](https://terminusdb.github.io/terminusdb-client-python/tutorials.html) that uses the Python client in our [tutorial repo](https://github.com/terminusdb/terminus-tutorials/). As a start, we would recommend having a look at [create TerminusDB graph with Python client using Jupyter notebook](https://github.com/terminusdb/terminusdb-tutorials/blob/master/bike-tutorial/python/Create%20TerminusDB%20Graph%20with%20Python%20Client.ipynb)
## 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 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](https://github.com/terminusdb/terminusdb-client-python/blob/master/CONTRIBUTING.md) for more information.
## Licence
Apache License (Version 2.0)
Copyright (c) 2019
%package help
Summary: Development documents and examples for terminusdb-client
Provides: python3-terminusdb-client-doc
%description help
[](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.github.io/terminusdb-client-python/)
[](https://codecov.io/gh/terminusdb/terminusdb-client-python)
[](https://github.com/terminusdb/terminusdb-client-python/blob/main/LICENSE)
> Python client for TerminusDB and TerminusX.
[**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
**TerminusX** is TerminusDB as a service. SOC 2 certified hosting. Build your beta and get to market fast. Scale up and deploy your own instance. [Sign up now][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 TerminusX. Please check the [Release Notes](https://github.com/terminusdb/terminusdb-client-python/blob/master/RELEASE_NOTES.md) to find out what has changed.
## Installation
- TerminusDB Client can be downloaded form 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 Scaffolding CLI tool:
`python -m pip install terminusdb-client[dataframe]`
*if you are installing form `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 TerminusX
*check documentation for TerminusX about how to add the API token 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 doucments
```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 a 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 opertation is non-reversible. [y/N]: y
mydb deleted.
```
### Please check the [full Documentation](https://terminusdb.github.io/terminusdb-client-python/) for more information.
## Tutorials
There is a [list of examples](https://terminusdb.github.io/terminusdb-client-python/tutorials.html) that uses the Python client in our [tutorial repo](https://github.com/terminusdb/terminus-tutorials/). As a start, we would recommend having a look at [create TerminusDB graph with Python client using Jupyter notebook](https://github.com/terminusdb/terminusdb-tutorials/blob/master/bike-tutorial/python/Create%20TerminusDB%20Graph%20with%20Python%20Client.ipynb)
## 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 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](https://github.com/terminusdb/terminusdb-client-python/blob/master/CONTRIBUTING.md) for more information.
## Licence
Apache License (Version 2.0)
Copyright (c) 2019
%prep
%autosetup -n terminusdb-client-10.2.2
%build
%py3_build
%install
%py3_install
install -d -m755 %{buildroot}/%{_pkgdocdir}
if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi
if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi
if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi
if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi
pushd %{buildroot}
if [ -d usr/lib ]; then
find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/lib64 ]; then
find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/bin ]; then
find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/sbin ]; then
find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst
fi
touch doclist.lst
if [ -d usr/share/man ]; then
find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst
fi
popd
mv %{buildroot}/filelist.lst .
mv %{buildroot}/doclist.lst .
%files -n python3-terminusdb-client -f filelist.lst
%dir %{python3_sitelib}/*
%files help -f doclist.lst
%{_docdir}/*
%changelog
* Mon May 29 2023 Python_Bot - 10.2.2-1
- Package Spec generated