Skip to content

Commit

Permalink
27 update readme (#28)
Browse files Browse the repository at this point in the history
* Updated README.md With Installation Instructions

* Updated README.md With Status Shields

* Updated pyproject.toml With License Classifier
  • Loading branch information
hampusnasstrom authored Sep 21, 2023
1 parent 1130dd0 commit 324c9b7
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 3 deletions.
9 changes: 7 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,15 @@
![](https://github.com/FAIRmat-NFDI/pynxtools/actions/workflows/publish.yml/badge.svg)
![](https://img.shields.io/pypi/pyversions/metainfoyaml2py)
![](https://img.shields.io/pypi/l/metainfoyaml2py)
![](https://img.shields.io/pypi/v/metainfoyaml2py)

# metainfo-yaml2py
A program for converting NOMAD metainfo YAML schemas into Python class definitions.

## Installation
`metainfo-yaml2py` is not yet on PyPI but you can install the latest version using:
`metainfo-yaml2py` can be installed from PyPI using pip:
```sh
pip install git+https://github.com/hampusnasstrom/metainfo-yaml2py.git
pip install metainfoyaml2py
```
You can then run the program with:

Expand Down
3 changes: 2 additions & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ dynamic = ["version"]
description = "A program for converting NOMAD metainfo YAML schemas into Python class definitions"
readme = "README.md"
requires-python = ">=3.9"
license = {file = "LICENSE"}
license = { text = "Apache-2.0" }
keywords = ["nomad"]
authors = [
{name = "Hampus Näsström", email = "[email protected]"},
Expand All @@ -23,6 +23,7 @@ classifiers = [
"Programming Language :: Python :: 3",
"Programming Language :: Python :: 3 :: Only",
"Programming Language :: Python :: 3.9",
"License :: OSI Approved :: Apache Software License",
]

dependencies = [
Expand Down

0 comments on commit 324c9b7

Please sign in to comment.