Skip to content

Commit

Permalink
Update README.md (#21)
Browse files Browse the repository at this point in the history
Updated the README of the standard plugin content to include pip install instructions
  • Loading branch information
hampusnasstrom authored Aug 4, 2023
1 parent adee248 commit 1fdf42c
Showing 1 changed file with 5 additions and 25 deletions.
30 changes: 5 additions & 25 deletions src/metainfoyaml2py/resources/standard_plugin_content/README.md
Original file line number Diff line number Diff line change
@@ -1,31 +1,17 @@
# NOMAD's schema example plugin
# NOMAD's metinfo-yaml2py plugin

## Getting started

### Fork the project
### Install your python plugin package

Go to the github project page https://github.com/nomad-coe/nomad-schema-plugin-example, hit
fork (and leave a star, thanks!). Maybe you want to rename the project while forking!

### Clone your fork

Follow the github instructions. The URL and directory depends on your user name or organization and the
project name you choose. But, it should look somewhat like this:

```
git clone [email protected]:markus1978/my-nomad-schema.git
cd my-nomad-schema
```

### Install the dependencies

You should create a virtual environment. You will need the `nomad-lab` package (and `pytest`).
You should create a virtual environment.
You need at least Python 3.9.
From the top directory of your plugin you can install it en editable mode with:

```sh
python3 -m venv .pyenv
source .pyenv/bin/activate
pip install -r requirements.txt --index-url https://gitlab.mpcdf.mpg.de/api/v4/projects/2187/packages/pypi/simple
pip install -e . --index-url https://gitlab.mpcdf.mpg.de/api/v4/projects/2187/packages/pypi/simple
```

**Note!**
Expand All @@ -35,12 +21,6 @@ in `requirements.txt`.

### Run the tests

Make sure the current directory is in your path:

```sh
export PYTHONPATH=.
```

You can run automated tests with `pytest`:

```sh
Expand Down

0 comments on commit 1fdf42c

Please sign in to comment.