Skip to content

Commit

Permalink
docs: add package version and add build badge on README
Browse files Browse the repository at this point in the history
  • Loading branch information
carlos-adir committed Feb 14, 2025
1 parent 60df407 commit d5fcb62
Show file tree
Hide file tree
Showing 3 changed files with 46 additions and 2 deletions.
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
[![Build Status][build-img]][build-url]

# Hyper-elastic materials

### Introduction
Expand Down Expand Up @@ -54,3 +56,8 @@ pytest

There are some examples in the folder `examples` explaining how to run


<!-- Badges: -->

[build-img]: https://github.com/compmec/hyper/actions/workflows/build.yaml/badge.svg
[build-url]: https://github.com/compmec/hyper/actions/workflows/build.yaml
36 changes: 34 additions & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,3 +1,35 @@
[tool.poetry]
name = "hyper"
version = "0.1.0"
description = "Hyperelastic mechanics"
authors = ["Carlos Adir <carlos.adir.leite@gmail.com>"]
readme = "README.md"
packages = [{ include = "hyper", from = "src" }]

[tool.poetry.dependencies]
numpy = "^1.0.0"
matplotlib = "^3.4.0"
python = "^3.7"

[tool.poetry.dev-dependencies]
pytest = "^5.2"
black = "^23.0.0"
isort = "^5.12.0"
flake8 = "^5.0.0"
pylint = "^3.0.0"
pre-commit = "^3.0.0"
mypy = "^1.0.0"

[tool.poetry.group.dev.dependencies]
pre-commit = "^3.3.3"
scriv = {extras = ["toml"], version = "^1.3.1"}

[build-system]
requires = ["setuptools>=42.0"]
build-backend = "setuptools.build_meta"
requires = ["poetry-core"]
build-backend = "poetry.core.masonry.api"

[tool.scriv]
version = "literal: src/hyper/__init__.py: __version__"

[tool.black]
line-length = 79
5 changes: 5 additions & 0 deletions src/hyper/__init__.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
import sys

sys.path.append("./src")

__version__ = "0.1.0"

if __name__ == "__main__":
pass

0 comments on commit d5fcb62

Please sign in to comment.