flexfloat 0.3.0__tar.gz → 0.3.1__tar.gz

{flexfloat-0.3.0 → flexfloat-0.3.1}/.bumpversion.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 0.3.0
+current_version = 0.3.1
 commit = False
 tag = False
 allow_dirty = True

flexfloat-0.3.1/.github/workflows/docs.yml

@@ -0,0 +1,66 @@
+name: Build and Deploy Documentation
+
+on:
+  push:
+    branches: [main]
+  release:
+    types: [published]
+  workflow_dispatch: # Allow manual triggering
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  # Build job
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0 # Full history needed for versioning
+
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -e ".[docs]"
+
+      - name: Setup Pages
+        id: pages
+        uses: actions/configure-pages@v4
+
+      - name: Build documentation
+        run: |
+          cd docs
+          make html
+        env:
+          # Set environment variable to ensure clean build
+          SPHINXBUILD: sphinx-build
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: ./docs/build/html
+
+  # Deployment job
+  deploy:
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

{flexfloat-0.3.0 → flexfloat-0.3.1}/.github/workflows/pr-labeler.yml

@@ -96,7 +96,7 @@ jobs:
             **🚀 Release Status**: This PR is labeled with the recommended version bump type. To trigger a release:
             1. **Add the \`release\` label** to this PR when ready
             2. The version will be automatically bumped when the \`release\` label is added
-            3. When merged, it will create a Git tag, GitHub release, and publish to PyPI
+            3. When merged, it will automatically create a Git tag, GitHub release, and publish to PyPI
 
             **To prevent release**: Simply don\'t add the \`release\` label.
 

flexfloat-0.3.1/.github/workflows/release.yml

@@ -0,0 +1,143 @@
+name: Release
+
+on:
+  pull_request:
+    types: [closed]
+
+jobs:
+  release:
+    # Only run if the PR was merged and had the 'release' label
+    if: |
+      github.event.pull_request.merged == true && 
+      contains(github.event.pull_request.labels.*.name, 'release')
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      id-token: write # For trusted publishing to PyPI
+
+    steps:
+      - name: Checkout main branch
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          token: ${{ secrets.GITHUB_TOKEN }}
+          ref: main
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install build twine
+
+      - name: Configure Git
+        run: |
+          git config --local user.email "action@github.com"
+          git config --local user.name "GitHub Action"
+
+      - name: Get version from pyproject.toml
+        id: get_version
+        run: |
+          VERSION=$(grep -E '^version = ' pyproject.toml | cut -d'"' -f2)
+          echo "version=$VERSION" >> $GITHUB_OUTPUT
+          echo "Release version: $VERSION"
+
+      - name: Run tests
+        run: |
+          pip install -e ".[dev]"
+          pytest tests/
+
+      - name: Build package
+        run: |
+          python -m build
+
+      - name: Create Git tag
+        run: |
+          git tag -a "v${{ steps.get_version.outputs.version }}" -m "Release v${{ steps.get_version.outputs.version }}"
+          git push origin "v${{ steps.get_version.outputs.version }}"
+
+      - name: Generate release notes
+        id: release_notes
+        run: |
+          # Get the merge commit message
+          MERGE_COMMIT_MSG="${{ github.event.pull_request.title }}"
+          PR_BODY="${{ github.event.pull_request.body }}"
+          PR_NUMBER="${{ github.event.pull_request.number }}"
+          PR_AUTHOR="${{ github.event.pull_request.user.login }}"
+
+          # Determine version bump type from labels
+          BUMP_TYPE="patch"
+          LABELS="${{ join(github.event.pull_request.labels.*.name, ' ') }}"
+          if echo "$LABELS" | grep -q "major"; then
+            BUMP_TYPE="major"
+          elif echo "$LABELS" | grep -q "minor"; then
+            BUMP_TYPE="minor"
+          elif echo "$LABELS" | grep -q "patch"; then
+            BUMP_TYPE="patch"
+          fi
+
+          # Create release notes
+          cat << EOF > release_notes.md
+          ## Changes in v${{ steps.get_version.outputs.version }}
+
+          This release was automatically created from PR #${PR_NUMBER} by @${PR_AUTHOR}.
+
+          **Version bump type**: ${BUMP_TYPE}
+
+          ### Pull Request Details
+          **${MERGE_COMMIT_MSG}**
+
+          ${PR_BODY}
+
+          ### Artifacts
+          - **Python Wheel**: \`flexfloat-${{ steps.get_version.outputs.version }}-py3-none-any.whl\`
+          - **Source Distribution**: \`flexfloat-${{ steps.get_version.outputs.version }}.tar.gz\`
+
+          The package has been automatically published to [PyPI](https://pypi.org/project/flexfloat/${{ steps.get_version.outputs.version }}/).
+          EOF
+
+          echo "Release notes generated"
+
+      - name: Create GitHub Release
+        id: create_release
+        uses: softprops/action-gh-release@v2
+        with:
+          tag_name: "v${{ steps.get_version.outputs.version }}"
+          name: "Release v${{ steps.get_version.outputs.version }}"
+          body_path: release_notes.md
+          draft: false
+          prerelease: false
+          files: |
+            ./dist/flexfloat-${{ steps.get_version.outputs.version }}-py3-none-any.whl
+            ./dist/flexfloat-${{ steps.get_version.outputs.version }}.tar.gz
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@v1.12.4
+        with:
+          verbose: true
+
+      - name: Comment on PR
+        uses: actions/github-script@v7
+        with:
+          script: |
+            await github.rest.issues.createComment({
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              issue_number: context.issue.number,
+              body: `🚀 **Release Published Successfully!**
+              
+              **Version**: v${{ steps.get_version.outputs.version }}
+              
+              **Release**: [View on GitHub](https://github.com/${context.repo.owner}/${context.repo.repo}/releases/tag/v${{ steps.get_version.outputs.version }})
+              
+              **PyPI**: [View on PyPI](https://pypi.org/project/flexfloat/${{ steps.get_version.outputs.version }}/)
+              
+              The package is now available for installation:
+              \`\`\`bash
+              pip install flexfloat==${{ steps.get_version.outputs.version }}
+              \`\`\`
+              `
+            });

{flexfloat-0.3.0 → flexfloat-0.3.1}/.github/workflows/version-bump.yml

@@ -67,6 +67,29 @@ jobs:
           git commit -m "Bump version to ${{ steps.bump_version.outputs.new_version }} [skip ci]"
           git push origin ${{ github.event.pull_request.head.ref }}
 
+      - name: Comment on PR about release process
+        uses: actions/github-script@v7
+        with:
+          script: |
+            await github.rest.issues.createComment({
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              issue_number: context.issue.number,
+              body: `🏷️ **Release Label Added - Version Bump Complete**
+              
+              ✅ **Version bumped to**: v${{ steps.bump_version.outputs.new_version }} (${{ steps.bump_type.outputs.bump_type }} release)
+              
+              📦 **What happens when this PR is merged:**
+              1. A Git tag \`v${{ steps.bump_version.outputs.new_version }}\` will be created
+              2. A GitHub release will be published
+              3. The package will be automatically published to PyPI
+              4. Release notes will be generated from this PR's title and description
+              
+              🚀 **Ready for release!** This PR is now configured for automatic release when merged to main.
+              
+              To cancel the release, simply remove the \`release\` label.`
+            });
+
   revert-version-bump:
     if: |
       github.event.action == 'unlabeled' && 

{flexfloat-0.3.0 → flexfloat-0.3.1}/MANIFEST.in

@@ -10,6 +10,14 @@ recursive-include flexfloat *.typed
 recursive-include tests *.py
 recursive-include scripts *.py
 
+recursive-include docs *.bat
+recursive-include docs *.css
+recursive-include docs *.html
+recursive-include docs *.md
+recursive-include docs *.py
+recursive-include docs *.rst
+recursive-include docs Makefile
+
 global-exclude *.pyc
 global-exclude __pycache__
 global-exclude .pytest_cache

{flexfloat-0.3.0 → flexfloat-0.3.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: flexfloat
-Version: 0.3.0
+Version: 0.3.1
 Summary: A library for arbitrary precision floating point arithmetic
 Author: Ferran Sanchez Llado
 License: MIT
@@ -30,6 +30,13 @@ Requires-Dist: build>=0.10; extra == "dev"
 Requires-Dist: twine>=4.0; extra == "dev"
 Requires-Dist: check-manifest>=0.49; extra == "dev"
 Requires-Dist: PyYAML>=6.0; extra == "dev"
+Provides-Extra: docs
+Requires-Dist: sphinx>=7.0; extra == "docs"
+Requires-Dist: sphinx-rtd-theme>=2.0; extra == "docs"
+Requires-Dist: sphinx-copybutton>=0.5; extra == "docs"
+Requires-Dist: myst-parser>=2.0; extra == "docs"
+Requires-Dist: sphinx-autobuild>=2021.3.14; extra == "docs"
+Requires-Dist: requests>=2.25.0; extra == "docs"
 Dynamic: license-file
 
 # FlexFloat

flexfloat-0.3.1/docs/Makefile

@@ -0,0 +1,56 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD  ?= sphinx-build
+SOURCEDIR    = source
+BUILDDIR     = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Clean build directory
+clean:
+	rm -rf $(BUILDDIR)/*
+
+# Build HTML documentation
+html:
+	@$(SPHINXBUILD) -b html "$(SOURCEDIR)" "$(BUILDDIR)/html" $(SPHINXOPTS) $(O)
+
+# Build HTML documentation with live reload (requires sphinx-autobuild)
+livehtml:
+	sphinx-autobuild "$(SOURCEDIR)" "$(BUILDDIR)/html" $(SPHINXOPTS) $(O)
+
+# Build PDF documentation (requires LaTeX)
+pdf:
+	@$(SPHINXBUILD) -b latex "$(SOURCEDIR)" "$(BUILDDIR)/latex" $(SPHINXOPTS) $(O)
+	@make -C $(BUILDDIR)/latex all-pdf
+
+# Build EPUB documentation
+epub:
+	@$(SPHINXBUILD) -b epub "$(SOURCEDIR)" "$(BUILDDIR)/epub" $(SPHINXOPTS) $(O)
+
+# Check links in documentation
+linkcheck:
+	@$(SPHINXBUILD) -b linkcheck "$(SOURCEDIR)" "$(BUILDDIR)/linkcheck" $(SPHINXOPTS) $(O)
+
+# Build documentation for all supported formats
+all: html epub
+
+# Check documentation for issues
+check:
+	@$(SPHINXBUILD) -b dummy "$(SOURCEDIR)" "$(BUILDDIR)/dummy" -W $(SPHINXOPTS) $(O)
+
+# Build documentation treating warnings as errors
+strict:
+	@$(SPHINXBUILD) -b html "$(SOURCEDIR)" "$(BUILDDIR)/html" -W $(SPHINXOPTS) $(O)
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

flexfloat-0.3.1/docs/README.md

@@ -0,0 +1,89 @@
+# FlexFloat Documentation
+
+This directory contains the Sphinx documentation for FlexFloat.
+
+## Quick Start
+
+### Prerequisites
+
+- Python 3.11 or higher
+- FlexFloat package installed
+
+### Setup
+
+1. Install documentation dependencies:
+   ```bash
+   pip install -e ".[docs]"
+   ```
+
+2. Build the documentation:
+   ```bash
+   cd docs
+   make html
+   ```
+
+3. View the documentation:
+   ```bash
+   # Open docs/build/html/index.html in your browser
+   ```
+
+## Building Documentation
+
+### Basic Build
+```bash
+cd docs
+make html          # Build HTML documentation
+make clean         # Clean build directory
+make linkcheck     # Check for broken links
+```
+
+### Advanced Options
+```bash
+make strict        # Build with warnings as errors
+make livehtml      # Build with live reload (requires sphinx-autobuild)
+```
+
+## Customization
+
+### Theme and Styling
+- Theme: Sphinx RTD Theme
+- Custom CSS: `source/_static/custom.css`
+
+### Configuration
+Main configuration is in `source/conf.py`:
+- Project metadata
+- Extensions
+- Theme options
+- Version information
+
+### Adding Content
+
+#### New Pages
+1. Create `.rst` files in appropriate directories
+2. Add to relevant `toctree` directives
+3. Follow existing structure and style
+
+#### API Documentation
+API docs are automatically generated from docstrings using:
+- `sphinx.ext.autodoc`
+- `sphinx.ext.autosummary`
+- `sphinx.ext.napoleon` (for Google/NumPy style docstrings)
+
+#### Examples
+Add examples in `source/examples/` directory with practical use cases.
+
+### Manual Deployment
+```bash
+# Build documentation
+make html
+
+# Deploy to GitHub Pages (manual)
+# Copy docs/build/html/* to gh-pages branch
+```
+
+## Resources
+
+- [Sphinx Documentation](https://www.sphinx-doc.org/)
+- [reStructuredText Primer](https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html)
+- [Sphinx RTD Theme](https://sphinx-rtd-theme.readthedocs.io/)
+- [Read the Docs](https://docs.readthedocs.io/)

flexfloat-0.3.1/docs/make.bat

@@ -0,0 +1,78 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+if "%1" == "" goto help
+
+if "%1" == "help" (
+	:help
+	%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+	goto end
+)
+
+if "%1" == "clean" (
+	echo.Cleaning build directory...
+	rmdir /s /q %BUILDDIR% >nul 2>&1
+	echo.Build directory cleaned.
+	goto end
+)
+
+if "%1" == "html" (
+	echo.Building HTML documentation...
+	%SPHINXBUILD% -b html %SOURCEDIR% %BUILDDIR%\html %SPHINXOPTS% %O%
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished. The HTML pages are in %BUILDDIR%\html.
+	goto end
+)
+
+if "%1" == "livehtml" (
+	echo.Starting live HTML build server...
+	sphinx-autobuild %SOURCEDIR% %BUILDDIR%\html %SPHINXOPTS% %O%
+	goto end
+)
+
+if "%1" == "linkcheck" (
+	echo.Checking external links...
+	%SPHINXBUILD% -b linkcheck %SOURCEDIR% %BUILDDIR%\linkcheck %SPHINXOPTS% %O%
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Link check complete; look for any errors in the above output or in %BUILDDIR%\linkcheck\output.txt.
+	goto end
+)
+
+if "%1" == "strict" (
+	echo.Building HTML documentation with warnings as errors...
+	%SPHINXBUILD% -b html %SOURCEDIR% %BUILDDIR%\html -W %SPHINXOPTS% %O%
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished successfully with no warnings.
+	goto end
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:end
+popd

flexfloat-0.3.1/docs/source/_autosummary/flexfloat.BigIntBitArray.rst

@@ -0,0 +1,6 @@
+flexfloat.BigIntBitArray
+========================
+
+.. currentmodule:: flexfloat
+
+.. autoclass:: BigIntBitArray

flexfloat-0.3.1/docs/source/_autosummary/flexfloat.BitArray.rst

@@ -0,0 +1,6 @@
+flexfloat.BitArray
+==================
+
+.. currentmodule:: flexfloat
+
+.. autoclass:: BitArray

flexfloat-0.3.1/docs/source/_autosummary/flexfloat.FlexFloat.rst

@@ -0,0 +1,6 @@
+flexfloat.FlexFloat
+===================
+
+.. currentmodule:: flexfloat
+
+.. autoclass:: FlexFloat

flexfloat-0.3.1/docs/source/_autosummary/flexfloat.ListBoolBitArray.rst

@@ -0,0 +1,6 @@
+flexfloat.ListBoolBitArray
+==========================
+
+.. currentmodule:: flexfloat
+
+.. autoclass:: ListBoolBitArray

flexfloat-0.3.1/docs/source/_autosummary/flexfloat.ListInt64BitArray.rst

@@ -0,0 +1,6 @@
+flexfloat.ListInt64BitArray
+===========================
+
+.. currentmodule:: flexfloat
+
+.. autoclass:: ListInt64BitArray

flexfloat-0.3.1/docs/source/_autosummary/flexfloat.math.rst

@@ -0,0 +1,6 @@
+flexfloat.math
+==============
+
+.. currentmodule:: flexfloat
+
+.. automodule:: math