From 2fc740d112d8e77c8b16e2039252495ca8ca5944 Mon Sep 17 00:00:00 2001 From: Alex Nelson Date: Wed, 11 May 2022 11:53:42 -0400 Subject: [PATCH] Update documentation for PyPI deployment Signed-off-by: Alex Nelson --- README.md | 22 +++++++++++++++++++--- README_PyPI.md | 5 +++++ setup.cfg | 3 +-- 3 files changed, 25 insertions(+), 5 deletions(-) create mode 100644 README_PyPI.md diff --git a/README.md b/README.md index 6d6d826..6271ecc 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # CASE Python Utilities -This project provides various specialized utilities for producing data in the [CASE](https://caseontology.org/) format. +This project provides various specialized utilities for producing and analyzing data in the [CASE](https://caseontology.org/) format. ## Disclaimer @@ -10,12 +10,28 @@ Participation by NIST in the creation of the documentation of mentioned software ## Installation +This repository can be installed from PyPI or from source. + + +### Installing from PyPI + +```bash +pip install case_utils +``` + +Users who wish to install from PyPI should be aware that while CASE's ontology is in its pre-1.0.0 release state, backwards-incompatible ontology changes may occur. This may manifest as [`case_validate`](#case_validate) reporting data review errors after installing an updated `case_utils` version. Users may wish to pin `case_utils` within any dependent code bases to be less than the next unreleased SEMVER-minor version. (E.g. if `case_utils` version `0.8.0` is currently available, a newly adopting project might wish to track `case_utils<0.9.0` among its dependencies.) + + +### Installing from source + +Users who wish to install pre-release versions and/or make improvements to the code base should install in this manner. + 1. Clone this repository. 2. (Optional) Create and activate a virtual environment. 3. (Optional) Upgrade `pip` with `pip install --upgrade pip`. (This can speed installation of some dependent packages.) -4. Run `pip install .`. +4. Run `pip install $x`, where `$x` is the path to the cloned repository. -Installation is demonstrated in the `.venv.done.log` target of the `tests/` directory's [`Makefile`](tests/Makefile). +Local installation is demonstrated in the `.venv.done.log` target of the `tests/` directory's [`Makefile`](tests/Makefile). ## Usage diff --git a/README_PyPI.md b/README_PyPI.md new file mode 100644 index 0000000..ad292dd --- /dev/null +++ b/README_PyPI.md @@ -0,0 +1,5 @@ +# CASE Python Utilities + +This project provides various specialized utilities for producing and analyzing data in the [CASE](https://caseontology.org/) format. + +Full documentation is available at the [project homepage](https://github.com/casework/CASE-Utilities-Python). diff --git a/setup.cfg b/setup.cfg index 160976a..d8a7051 100644 --- a/setup.cfg +++ b/setup.cfg @@ -4,8 +4,7 @@ version = attr: case_utils.__version__ author = Alex Nelson author_email = alexander.nelson@nist.gov description = Python utilities for working with the CASE ontology -# TODO - PyPI will need a differently-written README. -long_description = file: README.md +long_description = file: README_PyPI.md long_description_content_type = text/markdown url = https://github.com/casework/CASE-Utilities-Python classifiers =