Skip to content

Commit

Permalink
Update metadata with license, more Makefile, remove sphinx dep
Browse files Browse the repository at this point in the history
  • Loading branch information
qartik committed Sep 28, 2023
1 parent a6958b8 commit 034cbcb
Show file tree
Hide file tree
Showing 4 changed files with 28 additions and 6 deletions.
14 changes: 13 additions & 1 deletion Makefile
Original file line number Diff line number Diff line change
@@ -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 .
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
14 changes: 12 additions & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -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 = "[email protected]" }]
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 = ["."]
Expand All @@ -16,4 +27,3 @@ where = ["."]
pythonpath = [
"."
]
filterwarnings = ["ignore:::lark.s*"]
4 changes: 1 addition & 3 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit 034cbcb

Please sign in to comment.