Skip to content

Commit

Permalink
cleanup
Browse files Browse the repository at this point in the history
  • Loading branch information
fekad committed Jan 22, 2025
1 parent 49b3d89 commit 1655cca
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 52 deletions.
41 changes: 0 additions & 41 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,48 +2,7 @@

Schema and app for AI Toolkit notebooks.

----

This `nomad`_ plugin was generated with `Cookiecutter`_ along with `@nomad`_'s `cookiecutter-nomad-plugin`_ template.


### Install

You should create a virtual environment. You will need the `nomad-lab` package (and `pytest`).
We recommend using Python 3.9.

```sh
python3 -m venv .pyenv
source .pyenv/bin/activate
pip install --upgrade pip
pip install -e '.[dev]' --index-url https://gitlab.mpcdf.mpg.de/api/v4/projects/2187/packages/pypi/simple
```

**Note!**
Until we have an official pypi NOMAD release with the plugins functionality. Make
sure to include NOMAD's internal package registry (e.g. via `--index-url`).

### Testing

You can run automated tests with `pytest`:

```sh
pytest -svx tests
```

### Run linting

```sh
ruff check .
```

### Run auto-formatting

This is entirely optional. To add this as a check in github actions pipeline, uncomment the `ruff-formatting` step in `./github/workflows/actions.yaml`.

```sh
ruff format .
```

### Developing a NOMAD plugin

Expand Down
2 changes: 1 addition & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ site_name: nomad-aitoolkit
site_description: Schema and app for AI Toolkit notebooks.
site_author: Adam Fekete

repo_url: https://github.com/fekad/nomad-aitoolkit
repo_url: https://github.com/FAIRmat-NFDI/nomad-aitoolkit

nav:
- Home: index.md
Expand Down
26 changes: 16 additions & 10 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ classifiers = [
]
name = "nomad-aitoolkit"
description = "Schema and app for AI Toolkit notebooks."
version = "0.1.1"
dynamic = ["version"]
readme = "README.rst"
requires-python = ">=3.9"
authors = [
Expand All @@ -34,6 +34,21 @@ Repository = "https://github.com/FAIRmat-NFDI/nomad-aitoolkit"
dev = ["ruff", "pytest", "structlog"]
docs = ["mkdocs", "mkdocs-material==8.1.1", "pymdown-extensions", "mkdocs-click"]

[project.entry-points.'nomad.plugin']
aitookitschema = "nomad_aitoolkit:aitoolkit"
aitookitapp = "nomad_aitoolkit.apps:aitoolkit"

[tool.setuptools]
package-dir = { "" = "src" }

[tool.setuptools.packages.find]
where = ["src"]

[tool.setuptools_scm]

[tool.uv]
cache-keys = [{ file = "pyproject.toml" }, { git = true }]

[tool.ruff]
# Exclude a variety of commonly ignored directories.
exclude = [
Expand Down Expand Up @@ -102,13 +117,4 @@ skip-magic-trailing-comma = false
# Like Black, automatically detect the appropriate line ending.
line-ending = "auto"

[tool.setuptools]
package-dir = { "" = "src" }

[tool.setuptools.packages.find]
where = ["src"]

[project.entry-points.'nomad.plugin']
aitookitschema = "nomad_aitoolkit:aitoolkit"
aitookitapp = "nomad_aitoolkit.apps:aitoolkit"

0 comments on commit 1655cca

Please sign in to comment.