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

Use pipx to run workspace generation command in README #26

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Use pipx to run workspace generation command in README #26

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4f6c374
Update README with pipx instructions
pkalita-lbl May 25, 2022
6f28186
Add instructions about installing Poetry back in
pkalita-lbl May 27, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 10 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,20 +4,21 @@ _A template for LinkML projects_

NOTE: You don't need to directly use this repository directly!

Instead:
## Prerequisites

* [install poetry](https://python-poetry.org/docs/)
* [install linkml](https://linkml.io/linkml/intro/install.html)
* run `linkml-ws new`
This repository is designed to be used via the `linkml-ws` script in the
[`linkml` package](https://github.com/linkml/linkml). We encourage running
that script via `pipx`. If you haven't already, follow
[these instructions](https://pypa.github.io/pipx/#install-pipx) to install `pipx`.

## Example:
The project that `linkml-ws` generates uses [Poetry](https://python-poetry.org/)
for dependency management. So be sure to have that
[installed](https://python-poetry.org/docs/#installation), too.

## Example

```
mkdir ~/my-projects
cd ~/my-projects
pip install linkml
linkml-ws new my-project-name
pipx run --spec linkml linkml-ws new my-project-name
cd my-project-name
# edit src/linkml/my-project-name
make setup
Expand Down