From 034cbcbada738a730e6208212554387e032527d6 Mon Sep 17 00:00:00 2001 From: Kartik Singhal Date: Thu, 28 Sep 2023 13:19:57 -0500 Subject: [PATCH] Update metadata with license, more Makefile, remove sphinx dep --- Makefile | 14 +++++++++++++- README.md | 2 ++ pyproject.toml | 14 ++++++++++++-- requirements.txt | 4 +--- 4 files changed, 28 insertions(+), 6 deletions(-) diff --git a/Makefile b/Makefile index 98b123e..a65bf3e 100644 --- a/Makefile +++ b/Makefile @@ -1,7 +1,19 @@ -.PHONY: tests, lint +.PHONY: tests lint clean build install dev tests: pytest -s -x -vv tests/test*.py lint: pre-commit run --all-files + +clean: + rm -rf *.egg-info dist build + +build: clean + python -m build --sdist -n + +install: + pip install . + +dev: + pip install -e . diff --git a/README.md b/README.md index e328426..d69f6e9 100644 --- a/README.md +++ b/README.md @@ -21,6 +21,8 @@ Then install the project using: pip install -e . ``` +See `Makefile` for other useful commands. + ## Testing Just issue `pytest` from the root directory. diff --git a/pyproject.toml b/pyproject.toml index c60e2c1..e8f598d 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -2,12 +2,23 @@ requires = ["setuptools", "wheel"] build-backend = "setuptools.build_meta" +# https://packaging.python.org/en/latest/specifications/declaring-project-metadata/ [project] name = "pytket-phir" version = "0.0.1" description = "A python library" +readme = "README.md" requires-python = ">=3.10" -authors = [{name = "Author", email = "author@quantinuum.com" }] +license = {file = "LICENSE"} +authors = [{name = "Quantinuum"}] + +dependencies = [] + +[project.optional-dependencies] +tests = ["pytest", "pytket"] + +[project.urls] +Repository = "https://github.com/CQCL/pytket-phir.git" [tool.setuptools.packages.find] where = ["."] @@ -16,4 +27,3 @@ where = ["."] pythonpath = [ "." ] -filterwarnings = ["ignore:::lark.s*"] diff --git a/requirements.txt b/requirements.txt index c602e38..718e1be 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,10 +1,8 @@ black==23.9.1 build==1.0.3 -lark-parser==0.12.0 mypy==1.5.1 pre-commit==3.4.0 pytest==7.4.2 ruff==0.0.291 -sphinx==7.2.6 -wheel==0.41.2 pytket==1.20.1 +wheel==0.41.2