Skip to content

Commit

Permalink
Add phir CLI to README, add MANIFEST.in
Browse files Browse the repository at this point in the history
  • Loading branch information
qartik committed Oct 16, 2023
1 parent 1d22532 commit 790b5c4
Show file tree
Hide file tree
Showing 4 changed files with 35 additions and 1 deletion.
1 change: 0 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# autogenerated by sphinx-napoleon
docs/source/modules.rst
docs/source/phir.rst

### Add custom ignores above this line ###
Expand Down
11 changes: 11 additions & 0 deletions MANIFEST.in
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
include *.json
include *.md
include *.txt
include Makefile
recursive-include docs *.rst
recursive-include docs Makefile
recursive-include tests *.json

exclude .pre-commit-config.yaml
exclude mypy.ini
exclude ruff.toml
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,23 @@ pip install -e .

See `Makefile` for other useful commands.

## phir CLI

```sh
❯ phir -h
usage: phir [-h] [-s] [-v] [jsonfile]

Validates and pretty prints valid PHIR

positional arguments:
jsonfile json file to validate against PHIR spec

options:
-h, --help show this help message and exit
-s, --schema dump JSON schema of the PHIR model and exit
-v, --version show program's version number and exit
```
## Testing
Just issue `pytest` from the root directory.
7 changes: 7 additions & 0 deletions docs/source/modules.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
phir
====

.. toctree::
:maxdepth: 4

phir

0 comments on commit 790b5c4

Please sign in to comment.