Skip to content

Commit eb16abe

Browse files
SMoraisAnsysSMoraisAnsys
committed
Merge branch 'main' into release/0.1
2 parents 0d7a3ba + 7e50d7b commit eb16abe

27 files changed

+148
-111
lines changed

‎.github/workflows/ci_cd.yml

+20-22
Original file line numberDiff line numberDiff line change
@@ -181,15 +181,15 @@ jobs:
181181
uses: ansys/actions/doc-deploy-index@v6
182182
with:
183183
cname: ${{ env.DOCUMENTATION_CNAME }}/version/dev
184-
index-name: pyconceptev-core-vdev
184+
index-name: pyconceptev-vdev
185185
host-url: ${{ env.MEILISEARCH_HOST_URL }}
186186
api-key: ${{ env.MEILISEARCH_API_KEY }}
187187
python-version: ${{ env.MAIN_PYTHON_VERSION }}
188188

189189
doc-deploy-stable:
190190
name: Deploy stable documentation
191191
runs-on: ubuntu-latest
192-
needs: [doc-build, package]
192+
needs: [doc-build, package, release]
193193
if: github.event_name == 'push' && contains(github.ref, 'refs/tags')
194194
steps:
195195
- name: Deploy the stable documentation
@@ -222,31 +222,29 @@ jobs:
222222
uses: ansys/actions/doc-deploy-index@v6
223223
with:
224224
cname: ${{ env.DOCUMENTATION_CNAME }}/version/${{ env.VERSION }}
225-
index-name: pyconceptev-core-v${{ env.VERSION_MEILI }}
225+
index-name: pyconceptev-v${{ env.VERSION_MEILI }}
226226
host-url: ${{ env.MEILISEARCH_HOST_URL }}
227227
api-key: ${{ env.MEILISEARCH_API_KEY }}
228228
python-version: ${{ env.MAIN_PYTHON_VERSION }}
229229

230-
# release-pypi-public:
231-
# name: Release to the public PyPI repository
232-
# runs-on: ubuntu-latest
233-
# needs: [package, update-changelog]
234-
# steps:
235-
# - name: "Release to the public PyPI repository"
236-
# if: github.event_name == 'push' && contains(github.ref, 'refs/tags')
237-
# uses: ansys/actions/release-pypi-public@v6
238-
# with:
239-
# library-name: {{ ${{ env.PACKAGE_NAME }} }}
240-
# twine-username: "__token__"
241-
# twine-token: {{ ${{ secrets.PYPI_TOKEN }} }}
242-
243-
release-github:
244-
name: Release to GitHub
245-
runs-on: ubuntu-latest
230+
release:
231+
name: Release to the public PyPI repository
232+
if: github.event_name == 'push' && contains(github.ref, 'refs/tags')
246233
needs: [doc-build, package, update-changelog]
234+
runs-on: ubuntu-latest
235+
# Specifying a GitHub environment is optional, but strongly encouraged
236+
environment: release
237+
permissions:
238+
id-token: write
239+
contents: write
247240
steps:
248-
- name: "Release to GitHub"
249-
if: github.event_name == 'push' && contains(github.ref, 'refs/tags')
241+
- name: Release to the public PyPI repository
242+
uses: ansys/actions/release-pypi-public@v6
243+
with:
244+
library-name: ${{ env.PACKAGE_NAME }}
245+
use-trusted-publisher: true
246+
247+
- name: Release to GitHub
250248
uses: ansys/actions/release-github@v6
251249
with:
252-
library-name: ${{ env.PACKAGE_NAME }}
250+
library-name: ${{ env.PACKAGE_NAME }}

‎.github/workflows/label.yml

+6-6
Original file line numberDiff line numberDiff line change
@@ -81,12 +81,12 @@ jobs:
8181
issue-number: ${{ github.event.pull_request.number }}
8282
body: |
8383
Please add one of the following labels to add this contribution to the Release Notes :point_down:
84-
- [bug](https://github.com/ansys-internal/pyconceptev-core/pulls?q=label%3Abug+)
85-
- [documentation](https://github.com/ansys-internal/pyconceptev-core/pulls?q=label%3Adocumentation+)
86-
- [enhancement](https://github.com/ansys-internal/pyconceptev-core/pulls?q=label%3Aenhancement+)
87-
- [good first issue](https://github.com/ansys-internal/pyconceptev-core/pulls?q=label%3Agood+first+issue)
88-
- [maintenance](https://github.com/ansys-internal/pyconceptev-core/pulls?q=label%3Amaintenance+)
89-
- [release](https://github.com/ansys-internal/pyconceptev-core/pulls?q=label%3Arelease+)
84+
- [bug](https://github.com/ansys/pyconceptev/pulls?q=label%3Abug+)
85+
- [documentation](https://github.com/ansys/pyconceptev/pulls?q=label%3Adocumentation+)
86+
- [enhancement](https://github.com/ansys/pyconceptev/pulls?q=label%3Aenhancement+)
87+
- [good first issue](https://github.com/ansys/pyconceptev/pulls?q=label%3Agood+first+issue)
88+
- [maintenance](https://github.com/ansys/pyconceptev/pulls?q=label%3Amaintenance+)
89+
- [release](https://github.com/ansys/pyconceptev/pulls?q=label%3Arelease+)
9090
9191
changelog-fragment:
9292
name: "Create changelog fragment"

‎README.rst

+14-12
Original file line numberDiff line numberDiff line change
@@ -18,12 +18,12 @@ PyConceptEV
1818
.. :target: https://pypi.org/project/ansys-conceptev-core/
1919
.. :alt: PyPI Downloads
2020
21-
.. .. |codecov| image:: https://codecov.io/gh/ansys/pyconceptev-core/graph/badge.svg?token=UZIC7XT5WE
22-
.. :target: https://codecov.io/gh/ansys/pyconceptev-core
21+
.. .. |codecov| image:: https://codecov.io/gh/ansys/pyconceptev/graph/badge.svg?token=UZIC7XT5WE
22+
.. :target: https://codecov.io/gh/ansys/pyconceptev
2323
.. :alt: Codecov
2424
25-
.. .. |GH-CI| image:: https://github.com/ansys/pyconceptev-core/actions/workflows/ci_cd.yml/badge.svg
26-
.. :target: https://github.com/ansys/pyconceptev-core/actions/workflows/ci_cd.yml
25+
.. .. |GH-CI| image:: https://github.com/ansys/pyconceptev/actions/workflows/ci_cd.yml/badge.svg
26+
.. :target: https://github.com/ansys/pyconceptev/actions/workflows/ci_cd.yml
2727
.. :alt: GH-CI
2828
2929
.. |MIT| image:: https://img.shields.io/badge/License-MIT-yellow.svg
@@ -34,8 +34,8 @@ PyConceptEV
3434
.. :target: https://github.com/psf/black
3535
.. :alt: Black
3636
37-
.. .. |pre-commit| image:: https://results.pre-commit.ci/badge/github/ansys/pyconceptev-core/main.svg
38-
.. :target: https://results.pre-commit.ci/latest/github/ansys/pyconceptev-core/main
37+
.. .. |pre-commit| image:: https://results.pre-commit.ci/badge/github/ansys/pyconceptev/main.svg
38+
.. :target: https://results.pre-commit.ci/latest/github/ansys/pyconceptev/main
3939
.. :alt: pre-commit.ci
4040
4141
@@ -50,7 +50,7 @@ Documentation and issues
5050
------------------------
5151

5252
Documentation for the latest stable release of PyConceptEV is hosted
53-
at `PyConceptEV documentation <https://pyconceptev-core.docs.pyansys.com/version/stable/index.html>`_.
53+
at `PyConceptEV documentation <https://conceptev.core.docs.pyansys.com/>`_.
5454

5555
The documentation has these sections:
5656

@@ -59,17 +59,19 @@ The documentation has these sections:
5959
- `User guide <https://conceptev.core.docs.pyansys.com/version/stable/user_guide/index.html>`_: Learn how to
6060
configure a PyConceptEV session, get a token, and create a client.
6161
- `API reference <conceptev.core.docs.pyansys.com/version/stable/api/index.html>`_: Understand how the
62-
`Ansys ConceptEV API documentation <https://conceptev.ansys.com/api/docs>`_: Provides for interacting
62+
`Ansys ConceptEV API documentation <https://conceptev.ansys.com/api/docs>`_ provides for interacting
6363
programmatically with PyConcept EV.
64+
- `Examples <https://conceptev.core.docs.pyansys.com/version/stable/examples/index.html>`_: Explore examples
65+
that show how to use PyConceptEV.
6466
- `Contribute <conceptev.core.docs.pyansys.com/version/stable/contributing.html>`_: Learn how to
65-
contribute to PyConceptEV codebase or documentation.
67+
contribute to the PyConceptEV codebase or documentation.
6668

6769
In the upper right corner of the documentation's title bar, there is an option
6870
for switching from viewing the documentation for the latest stable release
6971
to viewing the documentation for the development version or previously
7072
released versions.
7173

72-
On the `PyConceptEV Issues <https://github.com/ansys/pyconceptev-core/issues>`_
74+
On the `PyConceptEV Issues <https://github.com/ansys/pyconceptev/issues>`_
7375
page, you can create issues to report bugs and request new features. On the
7476
`Discussions <https://discuss.ansys.com/>`_ page on the Ansys Developer portal,
7577
you can post questions, share ideas, and get community feedback.
@@ -82,8 +84,8 @@ as described in the previous paragraph.
8284
License
8385
-------
8486

85-
PyConceptEV is licensed under the `MIT License <https://github.com/ansys/pyconceptev-core/blob/main/LICENSE>`_.
87+
PyConceptEV is licensed under the `MIT License <https://github.com/ansys/pyconceptev/blob/main/LICENSE>`_.
8688

8789
PyConceptEV makes no commercial claim over Ansys whatsoever. This library adds a
88-
Python interface for the `Ansys ConceptEV <https://www.ansys.com/products/electronics/ansys-concept-ev>`_
90+
Python interface for `Ansys ConceptEV <https://www.ansys.com/products/electronics/ansys-concept-ev>`_
8991
without changing the core behavior or license of the original Ansys software.

‎doc/changelog.d/38.dependencies.md

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
CHORE: Bump pytest-cov from 4.1.0 to 5.0.0

‎doc/changelog.d/44.changed.md

-1
This file was deleted.

‎doc/changelog.d/48.changed.md

-1
This file was deleted.

‎doc/changelog.d/49.changed.md

-1
This file was deleted.

‎doc/changelog.d/50.miscellaneous.md

-1
This file was deleted.

‎doc/changelog.d/53.changed.md

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
chore: update CHANGELOG for v0.1.2

‎doc/changelog.d/55.miscellaneous.md

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
DOCS: Minor doc edits based on doc rendering

‎doc/changelog.d/56.dependencies.md

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
CHORE: Bump sphinx-autodoc-typehints from 2.1.0 to 2.1.1

‎doc/changelog.d/57.dependencies.md

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
CHORE: Bump pytest from 7.4.4 to 8.2.2

‎doc/changelog.d/58.dependencies.md

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
CHORE: Bump tox from 4.15.0 to 4.15.1

‎doc/changelog.d/59.changed.md

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
CI: Use Trusted Publisher to release package

‎doc/changelog.d/60.dependencies.md

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
CHORE: Bump jupyterlab from 4.2.1 to 4.2.2

‎doc/changelog.d/61.changed.md

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
DOCS: Use ansys org instead of internal

‎doc/changelog.d/62.changed.md

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
DOC: Fix typo in pyproject.toml

‎doc/changelog.d/63.changed.md

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
CHORE: Use new repository name

‎doc/changelog.d/66.changed.md

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
CI: Refact release job

‎doc/source/changelog.rst

+26-10
Original file line numberDiff line numberDiff line change
@@ -9,31 +9,47 @@ This document contains the release notes for the project.
99
1010
.. towncrier release notes start
1111
12-
`0.1.1 <https://github.com/ansys/pyconceptev-core/releases/tag/v0.1.1>`_ - 2024-06-03
12+
`0.1.2 <https://github.com/ansys/pyconceptev/releases/tag/v0.1.2>`_ - 2024-06-04
1313
=====================================================================================
1414

1515
Changed
1616
^^^^^^^
1717

18-
- CHORE: update CHANGELOG for v0.1.0 `#46 <https://github.com/ansys/pyconceptev-core/pull/46>`_
19-
- CI: Fix release jobs `#47 <https://github.com/ansys/pyconceptev-core/pull/47>`_
18+
- CHORE: Bump development version to 0.2.dev0 `#44 <https://github.com/ansys/pyconceptev/pull/44>`_
19+
- chore: update CHANGELOG for v0.1.1 `#48 <https://github.com/ansys/pyconceptev/pull/48>`_
20+
- DOCS: Fix non clickable cards `#49 <https://github.com/ansys/pyconceptev/pull/49>`_
2021

21-
`0.1.0 <https://github.com/ansys/pyconceptev-core/releases/tag/v0.1.0>`_ - 2024-06-03
22+
23+
Miscellaneous
24+
^^^^^^^^^^^^^
25+
26+
- DOCS: Update URLs in README.rst `#50 <https://github.com/ansys/pyconceptev/pull/50>`_
27+
28+
`0.1.1 <https://github.com/ansys/pyconceptev/releases/tag/v0.1.1>`_ - 2024-06-03
29+
=====================================================================================
30+
31+
Changed
32+
^^^^^^^
33+
34+
- CHORE: update CHANGELOG for v0.1.0 `#46 <https://github.com/ansys/pyconceptev/pull/46>`_
35+
- CI: Fix release jobs `#47 <https://github.com/ansys/pyconceptev/pull/47>`_
36+
37+
`0.1.0 <https://github.com/ansys/pyconceptev/releases/tag/v0.1.0>`_ - 2024-06-03
2238
=====================================================================================
2339

2440
Changed
2541
^^^^^^^
2642

27-
- CHORE: Update following OSS review `#36 <https://github.com/ansys/pyconceptev-core/pull/36>`_
28-
- First-pass of overall doc review `#39 <https://github.com/ansys/pyconceptev-core/pull/39>`_
29-
- DOCS: Rework example documentation `#43 <https://github.com/ansys/pyconceptev-core/pull/43>`_
30-
- CHORE: Clean up ci_cd.yml and pyproject.toml `#45 <https://github.com/ansys/pyconceptev-core/pull/45>`_
43+
- CHORE: Update following OSS review `#36 <https://github.com/ansys/pyconceptev/pull/36>`_
44+
- First-pass of overall doc review `#39 <https://github.com/ansys/pyconceptev/pull/39>`_
45+
- DOCS: Rework example documentation `#43 <https://github.com/ansys/pyconceptev/pull/43>`_
46+
- CHORE: Clean up ci_cd.yml and pyproject.toml `#45 <https://github.com/ansys/pyconceptev/pull/45>`_
3147

3248

3349
Miscellaneous
3450
^^^^^^^^^^^^^
3551

36-
- CHORE: Second pass of oss code review `#37 <https://github.com/ansys/pyconceptev-core/pull/37>`_
37-
- Doc edits based on skimming rendered doc `#41 <https://github.com/ansys/pyconceptev-core/pull/41>`_
52+
- CHORE: Second pass of oss code review `#37 <https://github.com/ansys/pyconceptev/pull/37>`_
53+
- Doc edits based on skimming rendered doc `#41 <https://github.com/ansys/pyconceptev/pull/41>`_
3854

3955
.. vale on

‎doc/source/conf.py

+4-6
Original file line numberDiff line numberDiff line change
@@ -27,17 +27,17 @@
2727
# Select desired logo, theme, and declare the html title
2828
html_logo = logo
2929
html_theme = "ansys_sphinx_theme"
30-
html_short_title = html_title = "pyconceptev-core"
30+
html_short_title = html_title = "pyconceptev"
3131
html_context = {
3232
"github_user": "ansys",
33-
"github_repo": "pyconceptev-core",
33+
"github_repo": "pyconceptev",
3434
"github_version": "main",
3535
"doc_path": "doc/source",
3636
}
3737

3838
# specify the location of your github repo
3939
html_theme_options = {
40-
"github_url": "https://github.com/ansys/pyconceptev-core",
40+
"github_url": "https://github.com/ansys/pyconceptev",
4141
"use_edit_page_button": True,
4242
"show_prev_next": False,
4343
"show_breadcrumbs": True,
@@ -142,9 +142,7 @@
142142
# If we are on a release, we have to ignore the "release" URLs, since it is not
143143
# available until the release is published.
144144
if switcher_version != "dev":
145-
linkcheck_ignore.append(
146-
f"https://github.com/ansys/pyconceptev-core/releases/tag/v{__version__}"
147-
)
145+
linkcheck_ignore.append(f"https://github.com/ansys/pyconceptev/releases/tag/v{__version__}")
148146

149147
# Sphinx event hooks
150148

‎doc/source/contributing.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,8 @@ the source.
2020

2121
.. code:: bash
2222
23-
git clone https://github.com/ansys-internal/pyconceptev-core
24-
cd pyconceptev-core
23+
git clone https://github.com/ansys/pyconceptpyconceptev
24+
cd pyconceptev
2525
2626
#. Create a fresh-clean Python environment and activate it:
2727

‎doc/source/index.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ of EV powertrains.
3131
Understand how the `Ansys ConceptEV API documentation <https://conceptev.ansys.com/api/docs>`_
3232
provides for interacting programmatically with PyConcept EV.
3333

34-
.. grid-item-card:: Examples :fa:`scroll`
34+
.. grid-item-card:: Examples :material-regular:`play_arrow`
3535
:padding: 2 2 2 2
3636
:link: examples/index
3737
:link-type: doc

‎examples/index.rst

+5-6
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,15 @@
11
Examples
22
########
33

4-
These examples demonstrate usage of PyConcept EV.
4+
This section shows how to use PyConceptEV.
55

6-
PyConcept EV examples
7-
---------------------
8-
These examples demonstrate basic operations you can perform
9-
with PyConcept EV.
6+
Basic usage examples
7+
--------------------
8+
These examples show how to use PyConcentEV to perform basic operations.
109

1110
.. nbgallery::
1211

1312
simple_workflow.py
1413

1514
.. note::
16-
Examples require having access to https://prod.portal.onscale.com/api
15+
Examples require access to `Onscale <https://prod.portal.onscale.com/api>`_.

0 commit comments

Comments
 (0)