Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
change README format to reStructuredText, fix links
- Loading branch information
1 parent
a3d4aef
commit aa2e664
Showing
9 changed files
with
80 additions
and
47 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -5,3 +5,4 @@ dist/ | |
build/ | ||
.idea | ||
*.egg-info | ||
check_weaviate_client_python_version.sh |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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>`_. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,3 @@ | ||
weaviate-client>=2.1.0 | ||
click==7.1.2 | ||
twine |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 |