From 1655cca9d5e0463a8a13ddb4b27ec7e082921f3e Mon Sep 17 00:00:00 2001 From: Adam Fekete Date: Wed, 22 Jan 2025 19:44:04 +0100 Subject: [PATCH] cleanup --- README.md | 41 ----------------------------------------- mkdocs.yml | 2 +- pyproject.toml | 26 ++++++++++++++++---------- 3 files changed, 17 insertions(+), 52 deletions(-) diff --git a/README.md b/README.md index 03e61c9..122eba8 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/mkdocs.yml b/mkdocs.yml index 54efe81..aaf81e2 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -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 diff --git a/pyproject.toml b/pyproject.toml index b4d9874..6cb61a2 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -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 = [ @@ -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 = [ @@ -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"