Merge pull request #144 from mechmotum/initial-release

Initial release

.github/release-drafter.yml

@@ -0,0 +1,32 @@
+name-template: 'v$RESOLVED_VERSION'
+tag-template: 'v$RESOLVED_VERSION'
+categories:
+  - title: '🚀 Features'
+    labels:
+      - 'enhancement'
+  - title: '🐛 Bug Fixes'
+    labels:
+      - 'bug'
+  - title: '🧰 Maintenance'
+    label: 'chore'
+  - title: '💥 Breaking Changes'
+    label: 'breaking'
+change-template: '- $TITLE @$AUTHOR (#$NUMBER)'
+change-title-escapes: '\<*_&' # You can add # and @ to disable mentions, and add ` to disable code blocks.
+exclude-labels:
+  - 'CI'
+version-resolver:
+  major:
+    labels:
+      - 'major'
+  minor:
+    labels:
+      - 'minor'
+  patch:
+    labels:
+      - 'patch'
+  default: patch
+template: |
+  ## Changes
+
+  $CHANGES

.github/workflows/release-drafter.yml

@@ -0,0 +1,24 @@
+name: Release Drafter
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    types: [opened, reopened, synchronize]
+  pull_request_target:
+    types: [opened, reopened, synchronize]
+
+permissions:
+  contents: read
+
+jobs:
+  update_release_draft:
+    permissions:
+      contents: write
+      pull-requests: write
+    runs-on: ubuntu-latest
+    steps:
+      - uses: release-drafter/release-drafter@v6
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/release.yml

@@ -0,0 +1,18 @@
+name: Release
+on:
+  release:
+    types: [published]
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v4
+    - name: Install poetry
+      run: pipx install poetry==1.8.3
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: 3.12
+    - run: poetry build
+    - run: poetry publish --username=__token__ --password=${{ secrets.PYPI_TOKEN }}

.github/workflows/test-pypi.yml

@@ -0,0 +1,27 @@
+name: TestPyPI
+on:
+  push:
+    branches:
+      - main
+jobs:
+  test_pypi:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v4
+    - name: Install poetry
+      run: pipx install poetry==1.8.3
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: 3.12
+    - run: >-
+        poetry version patch &&
+        version=$(poetry version | awk '{print $2}') &&
+        poetry version $version.dev.$(date +%s)
+    - run: poetry build
+    - uses: pypa/gh-action-pypi-publish@v1.10.3
+      with:
+        user: __token__
+        password: ${{ secrets.TEST_PYPI_TOKEN }}
+        repository-url: https://test.pypi.org/legacy/

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "symbrim"
-version = "0.0.1"
+version = "0.1.0"
 description = "A Modular and Extensible Open-Source Framework for Symbolic Creating Bicycle-Rider Models"
 authors = ["tjstienstra <T.J.Stienstra@tudelft.nl>"]
 license = "CC0-1.0"
@@ -12,7 +12,8 @@ python = "^3.9"
 typing-extensions = "^4.12.2"
 sympy = "^1.13"
 symmeplot = {version = "^0.2.0", optional = true}
-bicycleparameters = {git = "https://github.com/moorepants/BicycleParameters.git", optional = true}
+bicycleparameters = {version = "^1.2.0", optional = true}
+importlib-metadata = {version = "^8.5.0", python = "<3.8"}
 
 [tool.poetry.group.lint.dependencies]
 ruff = "^0.6.9"

src/symbrim/__init__.py

@@ -3,6 +3,7 @@
 A Modular and Extensible Open-Source Framework for Creating Symbolic Bicycle-Rider
 Models.
 """
+
 __all__ = [
     "WhippleBicycle", "StationaryBicycle",
 
@@ -85,3 +86,13 @@
     TwoPinStickLeftLeg,
     TwoPinStickRightLeg,
 )
+
+try:
+    from importlib.metadata import PackageNotFoundError, version
+except ImportError:  # pragma: no cover
+    from importlib_metadata import PackageNotFoundError, version
+
+try:
+    __version__ = version(__name__)
+except PackageNotFoundError:  # pragma: no cover
+    __version__ = "unknown"