diff --git a/.github/workflows/publish_pypi_package.yaml b/.github/workflows/publish_pypi_package.yaml new file mode 100644 index 00000000..b54c2f5c --- /dev/null +++ b/.github/workflows/publish_pypi_package.yaml @@ -0,0 +1,28 @@ +name: Publish Python package to PyPi + +on: push + +jobs: + build-and-publish: + name: Build and publish Python Package to PyPi + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - name: Set up Python 3.11 + uses: actions/setup-python@v4 + with: + python-version: 3.11 + - name: Install build + run: | + python -m pip install build --user + - name: Build a binary wheel and a source tarball + run: | + python -m build --sdist --wheel --outdir dist/ . + - name: Publish package + if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags') + uses: pypa/gh-action-pypi-publish@release/v1 + with: + user: __token__ + password: ${{ secrets.PYPI_API_TOKEN }} + verbose: true + print-hash: true diff --git a/README.md b/README.md index 390a242e..99b01d5f 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # rom-tools-and-workflows The ROM tools and workflows Python library comprises a set of algorithms for constructing and exploiting ROMs that rely on *abstract base classes* that encapsulate all the information needed to run a given algorithm. The philosophy is that, for any given application, the user simply needs to "fill out" a class that meets the required API of the abstract base class. Once this class is complete, the user gains access to all of our existing algorithms. -## Documentation +## Documentation https://pressio.github.io/rom-tools-and-workflows/romtools.html diff --git a/pyproject.toml b/pyproject.toml index bac764bd..e1106b4a 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -5,13 +5,14 @@ build-backend = "setuptools.build_meta" [project] name = "romtools" dynamic = ["version"] +readme = "README.md" requires-python = ">=3.8" dependencies = [ - 'docutils', - 'importlib-metadata', + 'docutils', + 'importlib-metadata', 'numpy', - 'scipy', - 'matplotlib', + 'scipy', + 'matplotlib', 'pdoc', 'pytest==7.4.4', # released Dec 31st, 2023 'pytest-mpi>=0.6', # released Jan 8th, 2022 diff --git a/version.txt b/version.txt index 6e8bf73a..50c9820b 100644 --- a/version.txt +++ b/version.txt @@ -1 +1 @@ -0.1.0 +0.1.0rc1