Skip to content

Commit

Permalink
Make installation its own section in readme/docs
Browse files Browse the repository at this point in the history
  • Loading branch information
andrewtavis committed Nov 28, 2024
1 parent 937b5dd commit 7e43b8d
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 8 deletions.
20 changes: 17 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand All @@ -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.

<a id="installation"></a>

# 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 .
```

<a id="cli-usage"></a>

# CLI Usage [``](#contents)
Expand All @@ -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]
```

Expand Down
18 changes: 13 additions & 5 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@
Installation
============

Scribe-Data can be installed via `pip <https://pypi.org/project/scribe-data/>`_:
Scribe-Data is available for installation via `pip <https://pypi.org/project/scribe-data/>`_:

.. code-block:: shell
Expand All @@ -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
========
Expand Down

0 comments on commit 7e43b8d

Please sign in to comment.