diff --git a/LICENSE.md b/LICENSE similarity index 100% rename from LICENSE.md rename to LICENSE diff --git a/Makefile b/Makefile new file mode 100644 index 0000000000000000000000000000000000000000..b8bc521c7f9046dbcbea56c08a26903ba924acab --- /dev/null +++ b/Makefile @@ -0,0 +1,48 @@ +# ** header v3.0 +# This file is a part of the CaosDB Project. +# +# Copyright (C) 2020 IndiScale GmbH <info@indiscale.com> +# Copyright (C) 2020 Daniel Hornung <d.hornung@indiscale.com> +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero General Public License as +# published by the Free Software Foundation, either version 3 of the +# License, or (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see <https://www.gnu.org/licenses/>. +# +# ** end header + +# This Makefile is a wrapper for several other scripts. + +.PHONY: help + +help: + @echo 'Type `make doc` for documentation, or `make install` for (local) installation.' + +doc: + $(MAKE) -C src/doc html + +install: + @echo "Not implemented yet, use pip for installation." + +check: style lint +.PHONY: check + +style: + pycodestyle --count src unittests +.PHONY: style + +lint: + pylint --unsafe-load-any-extension=y -d all -e E,F src/linkahead_python_package_template +.PHONY: lint + +unittest: + tox -r +.PHONY: unittest diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000000000000000000000000000000000000..e7131890614639c105f2fc14dcd2d9ef2e41c973 --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,38 @@ +[build-system] +requires = ["setuptools >= 61.0"] +build-backend = "setuptools.build_meta" + +[project] +name = "linkahead_python_package_template" +description = "Enter a **short** description of your project here." +version = "0.0.1" +readme = "README.md" +license = {file = "LICENSE"} +authors = [ + {name = "Your Name", email="your@email.com"}, + {name = "Your Friend", email= "friend@email.com"} +] +maintainers = [ + {name = "Your Name", email="your@email.com"} +] +keywords = ["Data management", "Research data management"] +classifiers = [ + "Programming Language :: Python :: 3", + "License :: OSI Approved :: GNU Affero General Public License v3 or later (AGPLv3+)", + "Operating System :: OS Independent", +] +requires-python = ">= 3.8" +dependencies = [ + "linkahead" +] + +[project.urls] +Homepage = "https://getlinkahead.com" +Documentation = "https://docs.indiscale.com" +Repository = "https://gitlab.indiscale.com/caosdb/src/linkahead-python-package-template" +Issues = "https://gitlab.indiscale.com/caosdb/src/linkahead-python-package-template/-/issues" +Changelog = "https://gitlab.indiscale.com/caosdb/src/linkahead-python-package-template/-/blob/main/CHANGELOG.md?ref_type=heads" + +[tool.setuptools.packages.find] +where = "src" +