Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

WIP reworking pyproject.toml so that pytest unit tests can be run #1

Open
wants to merge 1 commit into
base: poetry_install_build
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions Pipfile
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ python-dateutil = ">=2.8"
pyvis = ">=0.1.9"
rdflib = ">=6.1"
requests = ">=2.27"
scikit-learn = "==1.1.2"
scikit-learn = "==1.1.3"
scipy = ">=1.8.0"
statsmodels = ">=0.13"
tqdm = ">=4.63"
Expand Down Expand Up @@ -55,12 +55,12 @@ pylint = ">=2.12"
pymdown-extensions = ">=9.2"
pytest = ">=7.1"
responses = ">=0.19"
scikit-learn = ">=1.0"
scikit-learn = ">=1.1"
selenium = ">=4.1"
twine = ">=3.8"
types-python-dateutil = ">=2.8"
types-requests = ">=2.27"
xmltodict = ">=0.12"

[requires]
python_version = "3.10"
python_version = "3.7"
40 changes: 23 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,7 @@
![GitHub commit activity](https://img.shields.io/github/commit-activity/w/DerwenAI/kglab?style=plastic)
[![Checked with mypy](http://www.mypy-lang.org/static/mypy_badge.svg)](http://mypy-lang.org/)
[![security: bandit](https://img.shields.io/badge/security-bandit-yellow.svg)](https://github.com/PyCQA/bandit)
[![Language grade: Python](https://img.shields.io/lgtm/grade/python/g/DerwenAI/kglab.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/DerwenAI/kglab/context:python)
![CI](https://github.com/DerwenAI/kglab/workflows/CI/badge.svg)
[![Docker Pulls](https://img.shields.io/docker/pulls/derwenai/kglab.svg?maxAge=604800)](https://hub.docker.com/r/derwenai/kglab/)
![downloads](https://img.shields.io/pypi/dm/kglab)
![sponsor](https://img.shields.io/github/sponsors/ceteri)

Expand Down Expand Up @@ -38,53 +36,59 @@ Morph-KGC, pythonPSL, and many more.
See the ["Getting Started"](https://derwen.ai/docs/kgl/start/)
section of the online documentation.

## Useing kglab as a package for your project

### We recommend installing from [PyPi](https://pypi.python.org/pypi/kglab):
### Using `kglab` as a library for your Python project

We recommend installing from [PyPi](https://pypi.python.org/pypi/kglab) or [conda](https://anaconda.org/anaconda/conda):

#### `pip`

#### pip
```bash
python3 -m pip install kglab
```

#### pipenv
```bash
pipenv install kglab
```
#### `pipenv`

#### poetry
```bash
potery add kglab
pipenv install kglab
```

#### conda
#### `conda`
```bash
conda env create -n kglab
conda activate kglab
pip install kglab
```

### Or, install from source:

If you work directly from this Git repo, be sure to install the
dependencies:

#### pip

```bash
python3 -m pip install -U pip wheel
python3 -m pip install -r requirements.txt
```

#### pipenv

```bash
pipenv install --dev
# NEED TO HAVE a Pipfile
```

Alternatively, to install dependencies using `conda`:

```bash
conda env create -f environment.yml --force
conda activate kglab
```

### Sample Code

Then to run some simple uses of this library:

```python
import kglab

Expand Down Expand Up @@ -129,12 +133,14 @@ Also, container images for each release are available on DockerHub:
<https://hub.docker.com/repository/docker/derwenai/kglab>

To build a container image and run it for the tutorials:

```bash
docker build --pull --rm -f "docker/Dockerfile" -t kglab:latest .
docker run -p 8888:8888 -it kglab
```

To build and run a container image for testing:

```bash
docker build --pull --rm -f "docker/testsuite.Dockerfile" -t kglabtest:latest .
docker run --rm -it kglabtest
Expand Down Expand Up @@ -193,7 +199,7 @@ Source code for **kglab** plus its logo, documentation, and examples
have an [MIT license](https://spdx.org/licenses/MIT.html) which is
succinct and simplifies use in commercial applications.

All materials herein are Copyright &copy; 2020-2022 Derwen, Inc.
All materials herein are Copyright &copy; 2020-2023 Derwen, Inc.
</details>


Expand Down Expand Up @@ -234,15 +240,15 @@ and to our contributors:
[@louisguitton](https://github.com/louisguitton),
[@tomaarsen](https://github.com/tomaarsen),
[@Mec-iS](https://github.com/Mec-iS),
[@cutterkom](https://github.com/cutterkom),
[@RishiKumarRay](https://github.com/RishiKumarRay),
[@jake-aft](https://github.com/jake-aft),
[@Tpt](https://github.com/Tpt),
[@ArenasGuerreroJulian](https://github.com/ArenasGuerreroJulian),
[@fils](https://github.com/fils),
[@cutterkom](https://github.com/cutterkom),
[@RishiKumarRay](https://github.com/RishiKumarRay),
[@gauravjaglan](https://github.com/gauravjaglan),
[@pebbie](https://github.com/pebbie),
[@CatChenal](https://github.com/CatChenal),
[@jake-aft](https://github.com/jake-aft),
[@dmoore247](https://github.com/dmoore247),
plus general support from [Derwen, Inc.](https://derwen.ai/);
the [Knowledge Graph Conference](https://www.knowledgegraph.tech/)
Expand Down
5 changes: 5 additions & 0 deletions for_poetry/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
#### `poetry`

```bash
poetry add kglab
```
148 changes: 148 additions & 0 deletions for_poetry/pyproject.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,148 @@


[tool.poetry]
name = "kglab"
version = "0.6.7"
description = "a simple abstraction layer in Python for building knowledge graphs"
license = "MIT"
authors = ["Paco Nathan"]
maintainers = ["kglab contributors"]
repository = "https://github.com/DerwenAI/kglab"
homepage = "https//derwen.ai/docs/kgl/"
readme = "README.md"
documentation = "https://derwen.ai/docs/kgl/"
keywords = [
"controlled vocabulary",
"cugraph",
"deep learning",
"embedding",
"gpu",
"graph algorithms",
"igraph",
"inference",
"interactive visualization",
"json-ld",
"knowledge graph",
"managing namespaces",
"morph-kgc",
"n3",
"networkx",
"owl",
"pandas",
"parquet",
"probabilistic soft logic",
"psl",
"pyvis",
"rapids",
"rdf",
"rml",
"roam research",
"serialization",
"shacl",
"skos",
"sparql",
"statistical relational learning",
"topology",
"turtle",
"validation"
]
classifiers = [
"Programming Language :: Python",
"Programming Language :: Python :: 3 :: Only",
"Programming Language :: Python :: 3.7",
"Programming Language :: Python :: 3.8",
"Programming Language :: Python :: 3.9",
"Programming Language :: Python :: 3.10",
"Operating System :: OS Independent",
"License :: OSI Approved :: MIT License",
"Development Status :: 5 - Production/Stable",
"Intended Audience :: Developers",
"Intended Audience :: Education",
"Intended Audience :: Information Technology",
"Intended Audience :: Science/Research",
"Topic :: Scientific/Engineering :: Artificial Intelligence",
"Topic :: Scientific/Engineering :: Human Machine Interfaces",
"Topic :: Scientific/Engineering :: Information Analysis",
"Topic :: Software Development :: Libraries :: Python Modules",
"Topic :: Text Processing :: Indexing"
]


[tool.poetry.dependencies]
python = "^3.10"
aiohttp = "^3.8.1"
chocolate = "^0.0.2"
csvwlib = "^0.3.2"
cryptography = "^38.0.1"
decorator = "^5.1.1"
fsspec = {extras = ["gs", "s3"], version = "^2022.8.2"}
gcsfs = "^2022.8.2"
icecream = "^2.1.3"
morph-kgc = "^2.2.0"
networkx = "^2.8.6"
numpy = "^1.23.3"
owlrl = "^6.0.2"
oxrdflib = "^0.3.2"
pandas = "^1.4.4"
pslpython = "^2.3.0"
pyarrow = "^9.0.0"
pynvml = "^11.4.1"
pyshacl = "^0.20.0"
python-dateutil = "^2.8.2"
pyvis = "^0.2.1"
rdflib = "^6.2.0"
requests = "^2.28.1"
tqdm = "^4.64.1"
urlpath = "^1.2.0"
bandit = "^1.7.4"
codespell = "^2.2.1"
coverage = "^6.4.4"
Flask = "^2.2.2"
grayskull = "^1.8.3"
mistune = "^2.0.4"
mkdocs-git-revision-date-plugin = "^0.3.2"
mkdocs-material = "^8.5.1"
pipdeptree = "^2.3.1"
Pygments = "^2.13.0"
pymdown-extensions = "^9.5"
responses = "^0.21.0"
selenium = "^4.4.3"
twine = "^4.0.1"
types-python-dateutil = "^2.8.19"
types-requests = "^2.28.10"
wheel = "^0.37.1"
xmltodict = "^0.13.0"


[tool.poetry.group.dev.dependencies]
pytest = "^7.1.3"
pre-commit = "^2.20.0"
mypy = "^0.971"
black = "^22.8.0"
flake8 = "^5.0.4"
mypy = "^0.971"
pylint = "^2.15.2"
flake8-pylint = "^0.1.3"
bandit = "^1.7.4"
flake8-bandit = "^4.1.1"
mkdocs-git-revision-date-plugin = "^0.3.2"
mkdocs-material = "^8.5.1"


[tool.poetry.group.tut.dependencies]
cairocffi = "^1.3"
gensim = "^3.8"
igraph = "^0.9"
jupyterlab = "^3.1.4"
leidenalg = "^0.8"
matplotlib = "^3.3.4"
pylev = "^1.3"

tool.poetry.scripts = [
"Makefile = Makefile:main",
]


[build-system]
requires = ["poetry-core"]
build-backend = "poetry.core.masonry.api"
Loading