add stub file; add path.locate(ref) -> offset (#28)

* add docstring

* more docstring

* lint code

* fix

* not ready

* fix

* fix

* add stubs

* update

* fix

* fix

* fix

* fix

* fix

* fix

---------

Co-authored-by: tang zhixiong <[email protected]>

Author: district10

.github/workflows/wheels.yml

@@ -50,11 +50,13 @@ jobs:
       with:
         submodules: true
 
-    - uses: pypa/cibuildwheel@v2.16
+    - uses: pypa/cibuildwheel@v2.21.1
       env:
         CIBW_ARCHS_MACOS: universal2
         CIBW_ARCHS_WINDOWS: auto ARM64
         CIBW_BEFORE_BUILD: pip install pytest networkx --prefer-binary
+        CIBW_SKIP: "*musllinux*"
+        CIBW_TEST_SKIP: pp*
 
     - name: Verify clean directory
       run: git diff --exit-code

.gitignore

@@ -143,3 +143,4 @@ _skbuild/
 .pyodide-xbuildenv/
 tests/graph.py
 core.*
+stubs

Makefile

@@ -15,7 +15,7 @@ reset_submodules:
 	git submodule update --init --recursive
 
 clean:
-	rm -rf build *.egg-info dist
+	rm -rf build *.egg-info dist stubs
 force_clean:
 	docker run --rm -v `pwd`:`pwd` -w `pwd` -it alpine/make make clean
 
@@ -66,6 +66,10 @@ python_sdist:
 python_test: pytest
 .PHONY: build
 
+restub:
+	pybind11-stubgen networkx_graph._core -o stubs
+	cp stubs/networkx_graph/_core.pyi src/networkx_graph
+
 # conda create -y -n py36 python=3.6
 # conda create -y -n py37 python=3.7
 # conda create -y -n py38 python=3.8

docs/conf.py

@@ -58,9 +58,9 @@
 # built documents.
 #
 # The short X.Y version.
-version = '0.2.4'
+version = '0.2.5'
 # The full version, including alpha/beta/rc tags.
-release = '0.2.4'
+release = '0.2.5'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

pyproject.toml

@@ -5,7 +5,7 @@ build-backend = "scikit_build_core.build"
 
 [project]
 name = "networkx_graph"
-version = "0.2.4"
+version = "0.2.5"
 url = "https://github.com/cubao/networkx-graph"
 description = "Some customized graph algorithms"
 readme = "README.md"