Merge pull request #40 from martinfleis/infra

MAINT: update infrastructure

Author: sjsrey

.gitattributes

@@ -0,0 +1,19 @@
+changelog:
+  exclude:
+    labels:
+      - ignore-for-release
+    authors:
+      - dependabot
+  categories:
+    - title: Bug Fixes
+      labels:
+        - bug
+    - title: Enhancements
+      labels:
+        - enhancement
+    - title: Maintenance
+      labels:
+        - maintenance
+    - title: Other Changes
+      labels:
+        - "*"

.github/release.yml

@@ -0,0 +1,60 @@
+ # Release package on GitHub and publish to PyPI
+
+ # Important: In order to trigger this workflow for the organization
+ # repo (organzation-name/repo-name vs. user-name/repo-name), a tagged
+ # commit must be made to *organzation-name/repo-name*. If the tagged
+ # commit is made to *user-name/repo-name*, a release will be published
+ # under the user's name, not the organzation.
+
+ #--------------------------------------------------
+    name: Release & Publish
+
+    on:
+      push:
+        # Sequence of patterns matched against refs/tags
+        tags:
+          - "v*" # Push events to matching v*, i.e. v1.0, v20.15.10
+      workflow_dispatch:
+        inputs:
+          version:
+            description: Manual Release
+            default: test
+            required: false
+
+    jobs:
+      build:
+        name: Create release & publish to PyPI
+        runs-on: ubuntu-latest
+
+        steps:
+          - name: Checkout repo
+            uses: actions/checkout@v4
+            with:
+              fetch-depth: 0 # Fetch all history for all branches and tags.
+
+          - name: Set up python
+            uses: actions/setup-python@v5
+            with:
+              python-version: "3.x"
+
+          - name: Install Dependencies
+            run: |
+              python -m pip install --upgrade pip build twine
+              python -m build
+              twine check --strict dist/*
+
+          - name: Create Release Notes
+            uses: actions/github-script@v7
+            with:
+              github-token: ${{secrets.GITHUB_TOKEN}}
+              script: |
+                await github.request(`POST /repos/${{ github.repository }}/releases`, {
+                   tag_name: "${{ github.ref }}",
+                   generate_release_notes: true
+                 });
+
+          - name: Publish distribution 📦 to PyPI
+            uses: pypa/gh-action-pypi-publish@release/v1
+            with:
+              user: __token__
+              password: ${{ secrets.PYPI_PASSWORD }}

.github/workflows/release.yml

@@ -0,0 +1,11 @@
+files: 'geoplanar\/'
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.4.2
+    hooks:
+      - id: ruff
+      - id: ruff-format
+
+ci:
+  autofix_prs: false
+  autoupdate_schedule: quarterly

.pre-commit-config.yaml

@@ -4,29 +4,26 @@
 # list see the documentation:
 # https://www.sphinx-doc.org/en/master/usage/configuration.html
 
-import os
-import pathlib
-import shutil
-import subprocess
-
-
 # -- Path setup --------------------------------------------------------------
-
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 #
 import os
+import pathlib
+import shutil
+import subprocess
 import sys
-sys.path.insert(0, os.path.abspath('../'))
+
+sys.path.insert(0, os.path.abspath("../"))
 
 
 # -- Project information -----------------------------------------------------
 import geoplanar
 
-project = 'geoplanar'
-copyright = '2021-, Serge Rey & geoplanar contributors'
-author = 'Serge Rey & geoplanar contributors'
+project = "geoplanar"
+copyright = "2021-, Serge Rey & geoplanar contributors"
+author = "Serge Rey & geoplanar contributors"
 
 # The full version, including alpha/beta/rc tags
 release = geoplanar.__version__
@@ -38,42 +35,38 @@
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions = [
-    "sphinx.ext.autodoc",
-    "numpydoc",
-    "nbsphinx"
-]
+extensions = ["sphinx.ext.autodoc", "numpydoc", "nbsphinx"]
 
 # nbsphinx do not use requirejs (breaks bootstrap)
 nbsphinx_requirejs_path = ""
 
 # Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
+templates_path = ["_templates"]
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This pattern also affects html_static_path and html_extra_path.
-exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
 
 
 # -- Options for HTML output -------------------------------------------------
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = 'pydata_sphinx_theme'
+html_theme = "pydata_sphinx_theme"
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+html_static_path = ["_static"]
 
 html_css_files = [
-    'css/custom.css',
+    "css/custom.css",
 ]
 
 html_sidebars = {
-   '**': ['docs-sidebar.html'],
+    "**": ["docs-sidebar.html"],
 }
 
 # ---------------------------------------------------------------------------
@@ -99,4 +92,4 @@
 
 # convert README to rst
 
-subprocess.check_output(['pandoc','--to', 'rst', '-o', 'README.rst', '../README.md'])
+subprocess.check_output(["pandoc", "--to", "rst", "-o", "README.rst", "../README.md"])

MANIFEST.in

@@ -4,14 +4,14 @@
 A module for handling planar enforcement for polygon geoseries.
 """
 
-from geoplanar.overlap import trim_overlaps, is_overlapping, overlaps
-from geoplanar.gap import (gaps, fill_gaps)
-from geoplanar.hole import (add_interiors, missing_interiors)
-from geoplanar.planar import (planar_enforce, is_planar_enforced,
-                              fix_npe_edges, insert_intersections,
-                              non_planar_edges, check_validity,
-                              self_intersecting_rings)
-from geoplanar.valid import isvalid
+import contextlib
+from importlib.metadata import PackageNotFoundError, version
 
-from . import _version
-__version__ = _version.get_versions()['version']
+from geoplanar.gap import *
+from geoplanar.hole import *
+from geoplanar.overlap import *
+from geoplanar.planar import *
+from geoplanar.valid import *
+
+with contextlib.suppress(PackageNotFoundError):
+    __version__ = version("geoplanar")