Skip to content
This repository has been archived by the owner on Jan 15, 2022. It is now read-only.

Commit

Permalink
fix: include package data
Browse files Browse the repository at this point in the history
  • Loading branch information
moabu committed May 6, 2021
1 parent 54838db commit 72affc9
Show file tree
Hide file tree
Showing 3 changed files with 44 additions and 2 deletions.
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,4 @@ uninstall:
pip3 uninstall jans-cli -y

zipapp:
shiv --compressed -o jans-cli.pyz -p '/usr/bin/env python3' -e cli.config-cli . --no-cache
shiv --compressed -o jans-cli.pyz -p '/usr/bin/env python3' -e cli:config-cli . --no-cache
43 changes: 42 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,48 @@ Table of Contents

# _Installation_

**jans-cli** is automatically installed if you choose `jans-config-api` during installation

## Build `jans-cli.pyz` manually

## Prerequisites

1. Python 3.6+.
1. Python `pip3` package.

### Standard Python package

1. Create virtual environment and activate:

```sh
python3 -m venv .venv
source .venv/bin/activate
```

1. Install the package:

```
make install
```

This command will install executable called `jans-cli` available in virtual environment `PATH`.

### Python zipapp

1. Install [shiv](https://shiv.readthedocs.io/) using `pip3`:

```sh
pip3 install shiv
```

1. Install the package:

```sh
make zipapp
```

This command will generate executable called `jans-cli.pyz` under the same directory.

**jans-cli** is automatically installed if you choose `jans-config-api` during VM installation
of the [Janssen Server](https://github.com/JanssenProject/home).

![](docs/img/jans-config-api.png)
Expand Down
1 change: 1 addition & 0 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ def find_version(*file_paths):
description="",
long_description=__doc__,
packages=find_packages(),
package_data={'': ['*.yaml']},
zip_safe=False,
install_requires=[
"ruamel.yaml>=0.16.5"
Expand Down

0 comments on commit 72affc9

Please sign in to comment.