Skip to content

Commit 2fc740d

Browse files
committed
Update documentation for PyPI deployment
Signed-off-by: Alex Nelson <[email protected]>
1 parent e466223 commit 2fc740d

File tree

3 files changed

+25
-5
lines changed

3 files changed

+25
-5
lines changed

README.md

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# CASE Python Utilities
22

3-
This project provides various specialized utilities for producing data in the [CASE](https://caseontology.org/) format.
3+
This project provides various specialized utilities for producing and analyzing data in the [CASE](https://caseontology.org/) format.
44

55

66
## Disclaimer
@@ -10,12 +10,28 @@ Participation by NIST in the creation of the documentation of mentioned software
1010

1111
## Installation
1212

13+
This repository can be installed from PyPI or from source.
14+
15+
16+
### Installing from PyPI
17+
18+
```bash
19+
pip install case_utils
20+
```
21+
22+
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.)
23+
24+
25+
### Installing from source
26+
27+
Users who wish to install pre-release versions and/or make improvements to the code base should install in this manner.
28+
1329
1. Clone this repository.
1430
2. (Optional) Create and activate a virtual environment.
1531
3. (Optional) Upgrade `pip` with `pip install --upgrade pip`. (This can speed installation of some dependent packages.)
16-
4. Run `pip install .`.
32+
4. Run `pip install $x`, where `$x` is the path to the cloned repository.
1733

18-
Installation is demonstrated in the `.venv.done.log` target of the `tests/` directory's [`Makefile`](tests/Makefile).
34+
Local installation is demonstrated in the `.venv.done.log` target of the `tests/` directory's [`Makefile`](tests/Makefile).
1935

2036

2137
## Usage

README_PyPI.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# CASE Python Utilities
2+
3+
This project provides various specialized utilities for producing and analyzing data in the [CASE](https://caseontology.org/) format.
4+
5+
Full documentation is available at the [project homepage](https://github.com/casework/CASE-Utilities-Python).

setup.cfg

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,7 @@ version = attr: case_utils.__version__
44
author = Alex Nelson
55
author_email = [email protected]
66
description = Python utilities for working with the CASE ontology
7-
# TODO - PyPI will need a differently-written README.
8-
long_description = file: README.md
7+
long_description = file: README_PyPI.md
98
long_description_content_type = text/markdown
109
url = https://github.com/casework/CASE-Utilities-Python
1110
classifiers =

0 commit comments

Comments
 (0)