Skip to content

Commit c54b0a0

Browse files
authored
doc: Add link to wiki, logo & CI badge, and rename OpenHexa to OpenHEXA (#12)
1 parent 5f785be commit c54b0a0

File tree

2 files changed

+35
-16
lines changed

2 files changed

+35
-16
lines changed

README.md

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,25 @@
1-
# OpenHexa Toolbox
1+
<div align="center">
2+
<img alt="OpenHEXA Logo" src="https://raw.githubusercontent.com/BLSQ/openhexa-app/main/hexa/static/img/logo/logo_with_text_grey.svg" height="80">
3+
</div>
4+
<p align="center">
5+
<em>Open-source Data integration platform</em>
6+
</p>
7+
<p align="center">
8+
<a href="https://github.com/BLSQ/openhexa-app/actions/workflows/test.yml">
9+
<img alt="Test Suite" src="https://github.com/BLSQ/openhexa-toolbox/actions/workflows/ci.yml/badge.svg">
10+
</a>
11+
</p>
212

3-
An utility library to acquire and process data from various data sources.
13+
OpenHEXA Toolbox
14+
================
15+
16+
OpenHEXA is an open-source data integration platform developed by [Bluesquare](https://bluesquarehub.com).
17+
18+
The Toolbox is an utility library to acquire and process data from various data sources. It is installed by default
19+
on OpenHEXA, and can be used both in notebooks and in data pipelines.
20+
21+
See the [Using the OpenHEXA Toolbox](https://github.com/BLSQ/openhexa/wiki/Using-the-OpenHEXA-Toolbox) section of the
22+
wiki for usage instructions.
423

524
## Installation
625

docs/dhis2.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
/vscode-markdown-toc-config -->
55
<!-- /vscode-markdown-toc -->
66

7-
# OpenHexa Toolbox DHIS2
7+
# OpenHEXA Toolbox DHIS2
88

99
An utility library to acquire and process data from a DHIS2 instance.
1010

@@ -35,38 +35,38 @@ pip install openhexa.toolbox
3535

3636
Credentials are required to initialize a connection to a DHIS2 instance, and must be provided through a `Connection` object.
3737

38-
In an OpenHexa workspace (e.g. in an OpenHexa pipeline or in an OpenHexa notebook), a `Connection` object can be created using the OpenHexa SDK by providing the identifier of the workspace connection.
38+
In an OpenHEXA workspace (e.g. in an OpenHEXA pipeline or in an OpenHEXA notebook), a `Connection` object can be created using the OpenHEXA SDK by providing the identifier of the workspace connection.
3939

40-
![OpenHexa workspace connection](images/connection_id.png)
40+
![OpenHEXA workspace connection](images/connection_id.png)
4141

4242
``` python
4343
>>> from openhexa.sdk import workspace
4444
>>> from openhexa.toolbox.dhis2 import DHIS2
4545

46-
>>> # initialize a new connection in an OpenHexa workspace
46+
>>> # initialize a new connection in an OpenHEXA workspace
4747
>>> con = workspace.dhis2_connection("DHIS2_PLAY")
4848
>>> dhis = DHIS2(con)
4949
```
5050

51-
Outside an OpenHexa workspace, a connection can be manually created using the SDK by providing the instance URL, an username and a password.
51+
Outside an OpenHEXA workspace, a connection can be manually created using the SDK by providing the instance URL, an username and a password.
5252

5353

5454
``` python
5555
>>> from openhexa.sdk.workspaces.connections import DHIS2Connection
5656
>>> from openhexa.toolbox.dhis2 import DHIS2
5757

58-
>>> # initialize a new connection outside an OpenHexa workspace
58+
>>> # initialize a new connection outside an OpenHEXA workspace
5959
>>> con = DHIS2Connection(url="https://play.dhis2.org/40.0.1", username="admin", password="district")
6060
>>> dhis = DHIS2(con)
6161
```
6262

63-
If needed, the OpenHexa SDK dependency can be bypassed by providing a `namedtuple` instead of a `Connection` object.
63+
If needed, the OpenHEXA SDK dependency can be bypassed by providing a `namedtuple` instead of a `Connection` object.
6464

6565
``` python
6666
>>> from collections import namedtuple
6767
>>> from openhexa.toolbox.dhis2 import DHIS2
6868

69-
>>> # initialize a new connection outside an OpenHexa workspace
69+
>>> # initialize a new connection outside an OpenHEXA workspace
7070
>>> Connection = namedtuple("Connection", ["url", "username", "password"])
7171
>>> con = Connection(url="https://play.dhis2.org/40.0.1", username="admin", password="district")
7272
>>> dhis = DHIS2(con)
@@ -80,7 +80,7 @@ Caching can be activated by providing a cache directory when initializing a new
8080
>>> from openhexa.sdk import workspace
8181
>>> from openhexa.toolbox.dhis2 import DHIS2
8282

83-
>>> # initialize a new connection in an OpenHexa workspace
83+
>>> # initialize a new connection in an OpenHEXA workspace
8484
>>> con = workspace.dhis2_connection("DHIS2_PLAY")
8585
>>> dhis = DHIS2(con, cache_dir=".cache")
8686
```
@@ -96,7 +96,7 @@ Instance metadata can be accessed through a set of methods under the `DHIS2.meta
9696
>>> from openhexa.sdk import workspace
9797
>>> from openhexa.toolbox.dhis2 import DHIS2
9898

99-
>>> # initialize a new connection in an OpenHexa workspace
99+
>>> # initialize a new connection in an OpenHEXA workspace
100100
>>> con = workspace.dhis2_connection("DHIS2_PLAY")
101101
>>> dhis = DHIS2(con, cache_dir=".cache")
102102

@@ -203,7 +203,7 @@ Data values are returned in a JSON-like list of dictionaries that can be convert
203203
>>> from openhexa.sdk import workspace
204204
>>> from openhexa.toolbox.dhis2 import DHIS2
205205

206-
>>> # initialize a new connection in an OpenHexa workspace
206+
>>> # initialize a new connection in an OpenHEXA workspace
207207
>>> con = workspace.dhis2_connection("DHIS2_PLAY")
208208
>>> dhis = DHIS2(con, cache_dir=".cache")
209209

@@ -303,7 +303,7 @@ Data values are returned in a JSON-like list of dictionaries that can be convert
303303
>>> from openhexa.sdk import workspace
304304
>>> from openhexa.toolbox.dhis2 import DHIS2
305305

306-
>>> # initialize a new connection in an OpenHexa workspace
306+
>>> # initialize a new connection in an OpenHEXA workspace
307307
>>> con = workspace.dhis2_connection("DHIS2_PLAY")
308308
>>> dhis = DHIS2(con, cache_dir=".cache")
309309

@@ -349,7 +349,7 @@ Helper methods to add name columns in addition to identifiers are available unde
349349
>>> from openhexa.sdk import workspace
350350
>>> from openhexa.toolbox.dhis2 import DHIS2
351351

352-
>>> # initialize a new connection in an OpenHexa workspace
352+
>>> # initialize a new connection in an OpenHEXA workspace
353353
>>> con = workspace.dhis2_connection("DHIS2_PLAY")
354354
>>> dhis = DHIS2(con, cache_dir=".cache")
355355

@@ -392,7 +392,7 @@ An helper method to add the full org. unit pyramid to a dataframe is available u
392392
>>> from openhexa.sdk import workspace
393393
>>> from openhexa.toolbox.dhis2 import DHIS2
394394

395-
>>> # initialize a new connection in an OpenHexa workspace
395+
>>> # initialize a new connection in an OpenHEXA workspace
396396
>>> con = workspace.dhis2_connection("DHIS2_PLAY")
397397
>>> dhis = DHIS2(con, cache_dir=".cache")
398398

0 commit comments

Comments
 (0)