From 8399f985432d0010f89bff548a95e1c361c0d63c Mon Sep 17 00:00:00 2001 From: "michele.maris" Date: Wed, 24 May 2023 19:58:48 +0200 Subject: [PATCH] u --- Makefile | 24 ++++++++++++++++++++++++ README_DEV.md | 26 ++++++++++++++++++++++++++ dev_tools/make_local_link.sh | 10 ++++++++++ issues | 0 pyproject.toml | 34 ++++++++++++++++++++++++++++++++++ tests/content | 1 + 6 files changed, 95 insertions(+) create mode 100644 Makefile create mode 100644 README_DEV.md create mode 100755 dev_tools/make_local_link.sh create mode 100644 issues create mode 100644 pyproject.toml create mode 100644 tests/content diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..fc252df --- /dev/null +++ b/Makefile @@ -0,0 +1,24 @@ +# +# make clean : to clean the dist and docs directories +# make pdocs : create the docs using pdoc +# make package : to create the package +# make testUpload : to create a test upload (*) +# +# beware: before to use this update the version number in pyproject.toml +# + +default: + @echo "type a command" + @grep '^[^#[:space:]].*:' Makefile + +clean: + cd dist ; pwd ; rm -vf * ; cd ../docs ; pwd ; rm -rfv * + +pdocs: + cd src ; pwd ; pdoc py_artecs/__init__.py -o ../Pdocs/ + +package: + python3 -m build + +testUpload : + python3 -m twine upload --repository testpypi dist/* diff --git a/README_DEV.md b/README_DEV.md new file mode 100644 index 0000000..fb7f683 --- /dev/null +++ b/README_DEV.md @@ -0,0 +1,26 @@ +# README_DEV.md +Contents for the development version of py_artecs + +## src +The original source files, those are the files which are installed using + +>>> pip3 install py_artecs + +## docs +pdocs documentation, this is the documentation at which the PyPI repository points to + +## dist +the latest distribution + +## tests +test files + +## Files: + + . README.md : the project description + . Makefile : the Makefile with commands to create docs e dist + . LICENCE : a licence file + . make_local_link.sh : creates a soft link of src/py_artecs inside ~/.local/lib/python3.X to allow to use the dev version of the library + . pyproject.toml : description for the package generator + . CONTRIBUTING.md : instructions for contributors + diff --git a/dev_tools/make_local_link.sh b/dev_tools/make_local_link.sh new file mode 100755 index 0000000..e450872 --- /dev/null +++ b/dev_tools/make_local_link.sh @@ -0,0 +1,10 @@ +#!/bin/bash +# +# creates link to .local/lib/pythonXX/site-packages +# +if [ "$#" -lt 1 ]; then + echo "$0 " + exit 0 +fi + +ln -v -s $PWD/src/py_artecs ~/.local/lib/python$1/site-packages/py_artecs diff --git a/issues b/issues new file mode 100644 index 0000000..e69de29 diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..c33054c --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,34 @@ + +[build-system] +requires = ["setuptools>=61.0"] +build-backend = "setuptools.build_meta" + +[project] +name = "py_artecs" +version = "0.0.0.0.0.3" +authors = [ + { name="Michele Maris", email="michele.maris@inaf.it"}, + { name="Marco Molinaro", email="marco.molinaro@inaf.it"}, +] +description = """Python3 library to handle contents of ARTECS: Archive of terrestrial-type climate simulations + + http://wwwuser.oats.inaf.it/exobio/climates/ + +through TAP and PYVO services. + +Needs: numpy, scipy, pandas, pyvo + +""" +readme = "README.md" +requires-python = ">=3.7" +classifiers = [ + "Programming Language :: Python :: 3", + "License :: OSI Approved :: MIT License", + "Operating System :: OS Independent", +] + +[project.urls] +#"Homepage" = "" +"Documentation" = "https://www.ict.inaf.it/gitlab/michele.maris/py_artecs/docs" +"repository" = "https://www.ict.inaf.it/gitlab/michele.maris/py_artecs" +"Bug Tracker" = "https://www.ict.inaf.it/gitlab/michele.maris/py_artecs/issues" diff --git a/tests/content b/tests/content new file mode 100644 index 0000000..ece5269 --- /dev/null +++ b/tests/content @@ -0,0 +1 @@ +this is for tests, if any -- GitLab