diff --git a/README.md b/README.md index bd7ae01e..136b57da 100644 --- a/README.md +++ b/README.md @@ -29,6 +29,7 @@ Check out Scribe's [architecture diagrams](https://github.com/scribe-org/Organiz # **Contents** - [Process](#process) +- [Installation](#installation) - [CLI Usage](#cli-usage) - [Contributing](#contributing) - [Environment Setup](#environment-setup) @@ -43,6 +44,21 @@ The CLI commands defined within [scribe_data/cli](https://github.com/scribe-org/ The main data update process in triggers [language based SPARQL queries](https://github.com/scribe-org/Scribe-Data/tree/main/src/scribe_data/wikidata/language_data_extraction) to query language data from [Wikidata](https://www.wikidata.org/) using [SPARQLWrapper](https://github.com/RDFLib/sparqlwrapper) as a URI. The autosuggestion process derives popular words from [Wikipedia](https://www.wikipedia.org/) as well as those words that normally follow them for an effective baseline feature until natural language processing methods are employed. Functions to generate autosuggestions are ran in [gen_autosuggestions.ipynb](https://github.com/scribe-org/Scribe-Data/blob/main/src/scribe_data/wikipedia/gen_autosuggestions.ipynb). Emojis are further sourced from [Unicode CLDR](https://github.com/unicode-org/cldr), with this process being ran via the `scribe-data get -lang LANGUAGE -dt emoji-keywords` command. + + +# Installation [`⇧`](#contents) + +Scribe-Data is available for installation via [pip](https://pypi.org/project/scribe-data/): + +```bash +pip install scribe-data + +# For a development build: +git clone https://github.com/scribe-org/Scribe-Data.git # or ideally your fork +cd Scribe-Data +pip install -e . +``` + # CLI Usage [`⇧`](#contents) @@ -51,11 +67,9 @@ Scribe-Data provides a command-line interface (CLI) for efficient interaction wi ### Basic Usage -To utilize the Scribe-Data CLI, you can execute the following command in your terminal: +To utilize the Scribe-Data CLI, you can execute variations of the following command in your terminal: ```bash -pip install scribe-data - scribe-data [command] [options] ``` diff --git a/docs/source/index.rst b/docs/source/index.rst index 55811179..8378799c 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -40,7 +40,7 @@ Installation ============ -Scribe-Data can be installed via `pip `_: +Scribe-Data is available for installation via `pip `_: .. code-block:: shell @@ -52,13 +52,21 @@ The latest development version can further be installed the `source code on GitH git clone https://github.com/scribe-org/Scribe-Data.git cd Scribe-Data - python setup.py install + pip install -e . -Then execute the following import statement to use Scribe-Data: +To utilize the Scribe-Data CLI, you can execute variations of the following command in your terminal: -.. code-block:: python +.. code-block:: shell + + scribe-data [command] [options] + +Available Commands +================== - import scribe_data +- ``list`` (``l``): Enumerate available languages, data types and their combinations. +- ``get`` (``g``): Retrieve data from Wikidata for specified languages and data types. +- ``total`` (``t``): Display the total available data for given languages and data types. +- ``convert`` (``c``): Transform data returned by Scribe-Data into different file formats. Contents ========