Skip to content

Commit

Permalink
change README format to reStructuredText, fix links
Browse files Browse the repository at this point in the history
  • Loading branch information
StefanBogdan committed Apr 16, 2021
1 parent a3d4aef commit aa2e664
Show file tree
Hide file tree
Showing 9 changed files with 80 additions and 47 deletions.
1 change: 1 addition & 0 deletions .gitignore
Expand Up @@ -5,3 +5,4 @@ dist/
build/
.idea
*.egg-info
check_weaviate_client_python_version.sh
11 changes: 1 addition & 10 deletions .travis.yml
Expand Up @@ -4,9 +4,6 @@ notifications:
email:
on_success: change

env:
- DOCKER_COMPOSE_VERSION=1.27.4

jobs:
include:
- stage: "test"
Expand All @@ -15,10 +12,4 @@ jobs:
install:
- pip install -r requirements.txt
script:
- ./test/create_test_config.bash
- python -m unittest test/unit_test.py
- docker-compose -f test/docker-compose.yaml up -d
- sleep 5
- python -m unittest test/integration_test.py
- docker-compose -f test/docker-compose.yaml down
- python cli.py config view
- ./test/run_integration_test.sh
14 changes: 0 additions & 14 deletions README.md

This file was deleted.

49 changes: 49 additions & 0 deletions README.rst
@@ -0,0 +1,49 @@
Weaviate CLI
============
.. image:: https://raw.githubusercontent.com/semi-technologies/weaviate/19de0956c69b66c5552447e84d016f4fe29d12c9/docs/assets/weaviate-logo.png
:width: 180
:align: right
:alt: Weaviate logo

.. image:: https://travis-ci.com/semi-technologies/weaviate-cli.svg?branch=master
:target: https://travis-ci.com/semi-technologies/weaviate-cli
:alt: Build Status (Travis CI)

.. image:: https://badge.fury.io/py/weaviate-cli.svg
:target: https://badge.fury.io/py/weaviate-cli
:alt: PyPI version


**Command Line Interface (CLI) tool for interacting with a Weaviate instance directly from your Terminal**

Visit the official `SeMi Technology <https://www.semi.technology/>`_ website for more information about the Weaviate and how to use it in production.

Check out our `weaviate-client <https://pypi.org/project/weaviate-client/>`_ library for interacting with a Weaviate instance using python.

Installation
------------

| Install using: ``pip install weaviate-cli``
| Run using: ``weaviate --help``
Articles
--------

Here are some articles on weaviate:

- `Semantic Search Queries Return More Informed Results <https://hackernoon.com/semantic-search-queries-return-more-informed-results-nr5335nw>`_
- `Getting Started with Weaviate Python Library <https://towardsdatascience.com/getting-started-with-weaviate-python-client-e85d14f19e4f>`_
- `A sub-50ms neural search with DistilBERT and Weaviate <https://towardsdatascience.com/a-sub-50ms-neural-search-with-distilbert-and-weaviate-4857ae390154>`_
- `SeMI Technology Medium blogs <https://medium.com/semi-technologies>`_

Support
-------

- Use our `Slack Channel <https://join.slack.com/t/weaviate/shared_invite/zt-goaoifjr-o8FuVz9b1HLzhlUfyfddhw>`_ for support or any other question.
- Use the ``weaviate`` tag on `Stackoverflow <https://stackoverflow.com/questions/tagged/weaviate>`_ for questions.
- For bugs and/or problems with the package submit a Github `issue <https://github.com/semi-technologies/weaviate-python-client/issues>`_.

Contributing
------------

- Do you want to contribute to `Weaviate`, read `How to Contribute <https://github.com/semi-technologies/weaviate/blob/master/CONTRIBUTE.md>`_.
1 change: 1 addition & 0 deletions requirements.txt
@@ -1,2 +1,3 @@
weaviate-client>=2.1.0
click==7.1.2
twine
6 changes: 3 additions & 3 deletions setup.py
Expand Up @@ -4,14 +4,14 @@
# read the contents of your README file
from os import path
this_directory = path.abspath(path.dirname(__file__))
with open(path.join(this_directory, 'README.md'), encoding='utf-8') as f:
with open(path.join(this_directory, 'README.rst'), encoding='utf-8') as f:
long_description = f.read()

setup(name="weaviate-cli",
version="2.1.0", # 0.1.0rc0
version="2.1.1rc0", # 0.1.0rc0
description="Comand line interface to interact with weaviate",
long_description=long_description,
long_description_content_type='text/markdown',
long_description_content_type='text/x-rst',
author="SeMI Technologies",
author_email="hello@semi.technology",
packages=["semi", "semi.config", "semi.commands"],
Expand Down
7 changes: 0 additions & 7 deletions test/create_test_config.bash

This file was deleted.

20 changes: 7 additions & 13 deletions test/docker-compose.yaml
Expand Up @@ -9,25 +9,19 @@ services:
- '8080'
- --scheme
- http
image: semitechnologies/weaviate:1.0.0-rc2
image: semitechnologies/weaviate:1.2.0
ports:
- 8080:8080
restart: on-failure:0
environment:
CONTEXTIONARY_URL: contextionary:9999
TRANSFORMERS_INFERENCE_API: 'http://t2v-transformers:8080'
QUERY_DEFAULTS_LIMIT: 25
AUTHENTICATION_ANONYMOUS_ACCESS_ENABLED: 'true'
PERSISTENCE_DATA_PATH: '/var/lib/weaviate'
DEFAULT_VECTORIZER_MODULE: text2vec-contextionary

contextionary:
DEFAULT_VECTORIZER_MODULE: 'text2vec-transformers'
ENABLE_MODULES: 'text2vec-transformers'
t2v-transformers:
image: semitechnologies/transformers-inference:distilbert-base-uncased
environment:
OCCURRENCE_WEIGHT_LINEAR_FACTOR: 0.75
EXTENSIONS_STORAGE_MODE: weaviate
EXTENSIONS_STORAGE_ORIGIN: http://weaviate:8080
NEIGHBOR_OCCURRENCE_IGNORE_PERCENTILE: 5
ENABLE_COMPOUND_SPLITTING: 'false'
image: semitechnologies/contextionary:en0.16.0-v0.4.21
ports:
- 9999:9999
ENABLE_CUDA: '0'
...
18 changes: 18 additions & 0 deletions test/run_integration_test.sh
@@ -0,0 +1,18 @@
#!/bin/bash

set -e

mkdir -p "$HOME/.config/semi_technologies/"
echo '{"url": "http://localhost:8080", "auth": null}' > "$HOME/.config/semi_technologies/configs.json"

python -m unittest test/unit_test.py

docker-compose -f test/docker-compose.yaml up -d

sleep 5

python -m unittest test/integration_test.py

docker-compose -f test/docker-compose.yaml down

python cli.py config view

0 comments on commit aa2e664

Please sign in to comment.