Skip to content

Commit

Permalink
Getting ready for first deployment.
Browse files Browse the repository at this point in the history
  • Loading branch information
DuncDennis committed Mar 12, 2023
1 parent ac37f5f commit 48b56df
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 2 deletions.
3 changes: 3 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
15 changes: 13 additions & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -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 = "[email protected]" }
]
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",
Expand Down Expand Up @@ -60,5 +71,5 @@ src = ["src", "tests"]
convention = "google"

[build-system]
requires = ["setuptools"]
requires = ["setuptools>=61.0"]
build-backend = "setuptools.build_meta"

0 comments on commit 48b56df

Please sign in to comment.