Skip to content

Commit

Permalink
Update documentation for PyPI deployment
Browse files Browse the repository at this point in the history
Signed-off-by: Alex Nelson <[email protected]>
  • Loading branch information
ajnelson-nist committed May 11, 2022
1 parent e466223 commit 2fc740d
Show file tree
Hide file tree
Showing 3 changed files with 25 additions and 5 deletions.
22 changes: 19 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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
Expand Down
5 changes: 5 additions & 0 deletions README_PyPI.md
Original file line number Diff line number Diff line change
@@ -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).
3 changes: 1 addition & 2 deletions setup.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,7 @@ version = attr: case_utils.__version__
author = Alex Nelson
author_email = [email protected]
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 =
Expand Down

0 comments on commit 2fc740d

Please sign in to comment.