From 48b56df0725baed6fc4276d4a1303e933ac5cd6e Mon Sep 17 00:00:00 2001 From: DuncDennis <90915296+DuncDennis@users.noreply.github.com> Date: Sun, 12 Mar 2023 18:05:28 +0100 Subject: [PATCH] Getting ready for first deployment. --- CHANGELOG.md | 3 +++ README.md | 3 +++ pyproject.toml | 15 +++++++++++++-- 3 files changed, 19 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 4e14ab4..b838ac4 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -48,6 +48,9 @@ - Use the plugin [mkdocstrings](https://github.com/mkdocstrings/mkdocstrings) to automatically use the code-docstrings in the documentation. +**Deployment on PyPI**: +- Following the [PyPA tutorial](https://packaging.python.org/en/latest/guides/publishing-package-distribution-releases-using-github-actions-ci-cd-workflows/) + **Resources**: Taking inspiration from: https://github.com/dkmiller/modern-python-package, and diff --git a/README.md b/README.md index a4810cd..0365c2c 100644 --- a/README.md +++ b/README.md @@ -11,6 +11,9 @@ There is no release of the package yet and most of the functionalities are missi For now only the basic functionalities are implemented in order to build up the developing workflow. +## Documentation: +The documentation can be found here: https://duncdennis.github.io/lorenzpy/ + ## Installation: #### User installation: diff --git a/pyproject.toml b/pyproject.toml index 72d5cf1..c6ccdc8 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,15 +1,26 @@ [project] name = "lorenzpy" readme = "README.md" -version = "0.1.0" +version = "0.0.1" +description = "A Python package to simulate and measure chaotic dynamical systems." authors = [ { name = "Dennis Duncan", email = "DuncDennis@gmail.com" } ] +requires-python = ">=3.8" license = { file = "LICENSE.txt" } +classifiers = [ + "Programming Language :: Python :: 3", + "License :: OSI Approved :: MIT License", + "Operating System :: OS Independent", +] dependencies = [ "numpy==1.24.2", ] +[project.urls] +"Documentation" = "https://duncdennis.github.io/lorenzpy/" +"Homepage" = "https://github.com/DuncDennis/lorenzpy" + [project.optional-dependencies] dev = [ "pytest==7.2.0", @@ -60,5 +71,5 @@ src = ["src", "tests"] convention = "google" [build-system] -requires = ["setuptools"] +requires = ["setuptools>=61.0"] build-backend = "setuptools.build_meta"