Skip to content

Commit be13ba0

Browse files
committed
Merge branch 'main' into fix/unbound-headers-push-clonedb
2 parents 06fb0d1 + d6cd65a commit be13ba0

47 files changed

Lines changed: 12713 additions & 346 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.github/workflows/python.yml

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,3 @@ jobs:
7070
7171
- name: Deploy to pypi
7272
uses: pypa/gh-action-pypi-publish@release/v1
73-
with:
74-
user: __token__
75-
password: ${{ secrets.PYPI_API_TOKEN }}

README.md

Lines changed: 16 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@
88
[![Reddit](https://img.shields.io/reddit/subreddit-subscribers/TerminusDB?style=social)](https://www.reddit.com/r/TerminusDB/)
99
[![Twitter](https://img.shields.io/twitter/follow/terminusdb?color=skyblue&label=Follow%20on%20Twitter&logo=twitter&style=flat)](https://twitter.com/TerminusDB)
1010

11-
[![release version](https://img.shields.io/pypi/v/terminusdb-client.svg?logo=pypi)](https://pypi.python.org/pypi/terminusdb-client/)
12-
[![downloads](https://img.shields.io/pypi/dm/terminusdb-client.svg?logo=pypi)](https://pypi.python.org/pypi/terminusdb-client/)
11+
[![release version](https://img.shields.io/pypi/v/terminusdb.svg?logo=pypi)](https://pypi.python.org/pypi/terminusdb/)
12+
[![downloads](https://img.shields.io/pypi/dm/terminusdb.svg?logo=pypi)](https://pypi.python.org/pypi/terminusdb/)
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)
1515
[![documentation](https://img.shields.io/github/deployments/terminusdb/terminusdb-client-python/github-pages?label=documentation&logo=github)](https://terminusdb.org/docs/python)
@@ -18,6 +18,10 @@
1818

1919
> Python client for TerminusDB and TerminusCMS.
2020
21+
> **Migrating from `terminusdb-client`?** This package was formerly known as
22+
> `terminusdb-client`. Simply install `terminusdb` instead — both `import terminusdb`
23+
> and `import terminusdb_client` continue to work, so no code changes are required.
24+
2125
[**TerminusDB**][terminusdb] is an [open-source][terminusdb-repo] graph database
2226
and document store. It allows you to link JSON documents in a powerful knowledge
2327
graph all through a simple document API, with full git-for-data version control.
@@ -28,26 +32,26 @@ graph all through a simple document API, with full git-for-data version control.
2832

2933
## Requirements
3034

31-
- [TerminusDB v11.1](https://github.com/terminusdb/terminusdb-server)
35+
- [TerminusDB v12](https://github.com/terminusdb/terminusdb-server)
3236
- [Python >=3.9](https://www.python.org/downloads)
3337

3438
## Release Notes and Previous Versions
3539

36-
TerminusDB Client v11.1 works with TerminusDB v11.1 and the [DFRNT cloud service](https://dfrnt.com). Please check the [Release Notes](RELEASE_NOTES.md) to find out what has changed.
40+
TerminusDB Client v12 works with TerminusDB v12 onwards and the [DFRNT cloud service](https://dfrnt.com). Please check the [Release Notes](RELEASE_NOTES.md) to find out what has changed.
3741

3842
## Installation
3943
- TerminusDB Client can be downloaded from PyPI using pip:
40-
`python -m pip install terminusdb-client`
44+
`python -m pip install terminusdb`
4145

4246
This only includes the core Python Client (Client) and WOQLQuery.
4347

4448
If you want to use woqlDataframe or the import and export CSV function in the Scaffolding CLI tool:
4549

46-
`python -m pip install terminusdb-client[dataframe]`
50+
`python -m pip install terminusdb[dataframe]`
4751

4852
*if you are installing from `zsh` you have to quote the argument like this:*
4953

50-
`python -m pip install 'terminusdb-client[dataframe]'`
54+
`python -m pip install 'terminusdb[dataframe]'`
5155

5256
- Install from source:
5357

@@ -66,19 +70,21 @@ If you want to use woqlDataframe or the import and export CSV function in the Sc
6670
Connect to local host
6771

6872
```Python
69-
from terminusdb_client import Client
73+
from terminusdb import Client
7074

7175
client = Client("http://127.0.0.1:6363/")
7276
client.connect()
7377
```
7478

79+
The previous import path `from terminusdb_client import Client` also continues to work.
80+
7581
Connect to TerminusDB in the cloud
7682

7783
*check the documentation on the DFRNT support page about how to add your [API token](https://support.dfrnt.com/portal/en/kb/articles/api) to the environment variable*
7884

7985

8086
```Python
81-
from terminusdb_client import Client
87+
from terminusdb import Client
8288

8389
team="MyTeam"
8490
client = Client(f"https://studio.dfrnt.com/api/hosted/{team}/")
@@ -94,7 +100,7 @@ client.create_database("MyDatabase")
94100
#### Create a schema
95101

96102
```Python
97-
from terminusdb_client.schema import Schema, DocumentTemplate, RandomKey
103+
from terminusdb.schema import Schema, DocumentTemplate, RandomKey
98104

99105
my_schema = Schema()
100106

0 commit comments

Comments
 (0)