|
6 | 6 |  |
7 | 7 | [](http://mypy-lang.org/) |
8 | 8 | [](https://github.com/PyCQA/bandit) |
9 | | - |
| 9 | +[](https://hub.docker.com/r/derwenai/kglab/) |
10 | 10 |  |
11 | | - |
12 | 11 |
|
13 | 12 |
|
14 | 13 | Welcome to *Graph Data Science*: |
15 | 14 | <https://derwen.ai/docs/kgl/> |
16 | 15 |
|
17 | 16 | The **kglab** library provides a simple abstraction layer in Python 3.7+ |
18 | 17 | for building knowledge graphs, leveraging Pandas, NetworkX, RAPIDS, RDFLib, |
19 | | -Morph-KGC, pythonPSL, and many more. |
20 | | - |
21 | | -> **SPECIAL REQUEST:** |
22 | | -> Which features would you like in an open source Python library for building knowledge graphs? |
23 | | -> Please add your suggestions through this survey: |
24 | | -> https://forms.gle/FMHgtmxHYWocprMn6 |
25 | | -> This will help us prioritize the **kglab** roadmap. |
26 | | -
|
27 | | - |
28 | | -## Reviews |
29 | | - |
30 | | -[@kaaloo](https://github.com/kaaloo): |
31 | | -> "Feels like it's a Hugging Face for graphs! 🤯" |
| 18 | +Morph-KGC, and many more. |
32 | 19 |
|
33 | 20 |
|
34 | 21 | ## Getting Started |
35 | 22 |
|
36 | 23 | See the ["Getting Started"](https://derwen.ai/docs/kgl/start/) |
37 | 24 | section of the online documentation. |
38 | 25 |
|
| 26 | +## Useing kglab as a package for your project |
39 | 27 |
|
40 | | -### Using `kglab` as a library for your Python project |
41 | | - |
42 | | -We recommend installing from [PyPi](https://pypi.python.org/pypi/kglab) or [conda](https://anaconda.org/anaconda/conda): |
43 | | - |
44 | | -#### `pip` |
| 28 | +### We recommend installing from [PyPi](https://pypi.python.org/pypi/kglab): |
45 | 29 |
|
| 30 | +#### pip |
46 | 31 | ```bash |
47 | 32 | python3 -m pip install kglab |
48 | 33 | ``` |
49 | 34 |
|
50 | | -#### `pipenv` |
51 | | - |
| 35 | +#### poetry |
52 | 36 | ```bash |
53 | | -pipenv install kglab |
| 37 | +poetry add kglab |
54 | 38 | ``` |
55 | 39 |
|
56 | | -#### `conda` |
| 40 | +#### conda |
57 | 41 | ```bash |
58 | 42 | conda env create -n kglab |
59 | 43 | conda activate kglab |
60 | 44 | pip install kglab |
61 | 45 | ``` |
62 | 46 |
|
63 | 47 | ### Or, install from source: |
64 | | - |
65 | 48 | If you work directly from this Git repo, be sure to install the |
66 | 49 | dependencies: |
67 | 50 |
|
68 | 51 | #### pip |
69 | | - |
70 | 52 | ```bash |
71 | 53 | python3 -m pip install -U pip wheel |
72 | 54 | python3 -m pip install -r requirements.txt |
73 | 55 | ``` |
74 | 56 |
|
75 | | -#### pipenv |
76 | | - |
77 | | -```bash |
78 | | -pipenv install --dev |
79 | | -``` |
80 | | - |
81 | | -Alternatively, to install dependencies using `conda`: |
82 | | - |
| 57 | +#### conda |
83 | 58 | ```bash |
84 | 59 | conda env create -f environment.yml --force |
85 | 60 | conda activate kglab |
86 | 61 | ``` |
87 | 62 |
|
88 | | -### Sample Code |
89 | | - |
90 | 63 | Then to run some simple uses of this library: |
91 | | - |
92 | 64 | ```python |
93 | 65 | import kglab |
94 | 66 |
|
@@ -133,14 +105,12 @@ Also, container images for each release are available on DockerHub: |
133 | 105 | <https://hub.docker.com/repository/docker/derwenai/kglab> |
134 | 106 |
|
135 | 107 | To build a container image and run it for the tutorials: |
136 | | - |
137 | 108 | ```bash |
138 | 109 | docker build --pull --rm -f "docker/Dockerfile" -t kglab:latest . |
139 | 110 | docker run -p 8888:8888 -it kglab |
140 | 111 | ``` |
141 | 112 |
|
142 | 113 | To build and run a container image for testing: |
143 | | - |
144 | 114 | ```bash |
145 | 115 | docker build --pull --rm -f "docker/testsuite.Dockerfile" -t kglabtest:latest . |
146 | 116 | docker run --rm -it kglabtest |
@@ -199,7 +169,7 @@ Source code for **kglab** plus its logo, documentation, and examples |
199 | 169 | have an [MIT license](https://spdx.org/licenses/MIT.html) which is |
200 | 170 | succinct and simplifies use in commercial applications. |
201 | 171 |
|
202 | | -All materials herein are Copyright © 2020-2023 Derwen, Inc. |
| 172 | +All materials herein are Copyright © 2020-2022 Derwen, Inc. |
203 | 173 | </details> |
204 | 174 |
|
205 | 175 |
|
@@ -241,15 +211,14 @@ and to our contributors: |
241 | 211 | [@tomaarsen](https://github.com/tomaarsen), |
242 | 212 | [@Mec-iS](https://github.com/Mec-iS), |
243 | 213 | [@jake-aft](https://github.com/jake-aft), |
| 214 | +[@cutterkom](https://github.com/cutterkom), |
| 215 | +[@RishiKumarRay](https://github.com/RishiKumarRay), |
244 | 216 | [@Tpt](https://github.com/Tpt), |
245 | 217 | [@ArenasGuerreroJulian](https://github.com/ArenasGuerreroJulian), |
246 | 218 | [@fils](https://github.com/fils), |
247 | | -[@cutterkom](https://github.com/cutterkom), |
248 | | -[@RishiKumarRay](https://github.com/RishiKumarRay), |
249 | 219 | [@gauravjaglan](https://github.com/gauravjaglan), |
250 | 220 | [@pebbie](https://github.com/pebbie), |
251 | 221 | [@CatChenal](https://github.com/CatChenal), |
252 | | -[@jorisSchaller](https://github.com/jorisSchaller), |
253 | 222 | [@dmoore247](https://github.com/dmoore247), |
254 | 223 | plus general support from [Derwen, Inc.](https://derwen.ai/); |
255 | 224 | the [Knowledge Graph Conference](https://www.knowledgegraph.tech/) |
|
0 commit comments