Move libsemigroups_pybind11 to src

Author: Joseph-Edwards

CONTRIBUTING.rst

@@ -208,13 +208,14 @@ A class with no helpers or templates
 ____________________________________
 
 If the class you are binding has no templates or helper functions, then you
-need to add it to the list imports in `<libsemigroups_pybind11/__init__.py>`__.
+need to add it to the list imports in 
+`<src/libsemigroups_pybind11/__init__.py>`__.
 
 A class with helpers
 ____________________
 
 If a class has a helper namespace, this should be respected in Python by
-creating a module with the same name in the ``libsemigroups_pybind11``
+creating a module with the same name in the ``src/libsemigroups_pybind11``
 directory. In that module, all of the relevant helper functions should be
 imported from ``_libsemigroups_pybind11``.
 
@@ -226,7 +227,7 @@ will be one class for each combination of templates. Instead of calling these
 directly, a Python function should be created that acts as a constructor, that
 then calls the the corresponding ``_libsemigroups_pybind11`` constructor
 depending on the keyword arguments specified. This function should then be
-imported in `<libsemigroups_pybind11/__init__.py>`__.
+imported in `<src/libsemigroups_pybind11/__init__.py>`__.
 
 The documentation
 -----------------
@@ -439,10 +440,10 @@ whilst contributing are::
   │       └── index.rst
   ├── etc/
   │   └── replace-string-in-doc.py
-  ├── libsemigroups_pybind11/
-  │   ├── __init__.py
-  │   └── class_name.py
   ├── src/
+  |   ├──libsemigroups_pybind11/
+  │   |   ├── __init__.py
+  │   |   └── class_name.py
   │   └── class-name.cpp
   ├── tests/
   │   └── test_class_name.py

Makefile

@@ -19,14 +19,14 @@ install:
 	pip3 install . --use-feature=in-tree-build
 
 black:
-	black setup.py tests/*.py libsemigroups_pybind11/*.py docs/source/conf.py
+	black setup.py tests/*.py src/libsemigroups_pybind11/*.py docs/source/conf.py
 
 check: doctest
 	pytest -vv tests/test_*.py
 
 lint:
-	ruff check --exit-zero setup.py tests/*.py libsemigroups_pybind11/*.py docs/source/*.py
-	pylint --exit-zero setup.py tests/*.py libsemigroups_pybind11/*.py libsemigroups_pybind11/**/*.py
+	ruff check --exit-zero setup.py tests/*.py src/libsemigroups_pybind11/*.py docs/source/*.py
+	pylint --exit-zero setup.py tests/*.py src/libsemigroups_pybind11/*.py src/libsemigroups_pybind11/**/*.py
 	cpplint src/*.hpp src/*.cpp
 
 coverage:
@@ -39,8 +39,8 @@ clean-doc:
 	rm -rf docs/_build
 
 clean: clean-doc
-	rm -rf __pycache__ libsemigroups_pybind11.egg-info
-	rm -rf tests/__pycache__ libsemigroups_pybind11/__pycache__
+	find . -type d -name __pycache__ -prune -exec rm -rf {} \;
+	rm -rf libsemigroups_pybind11.egg-info
 	rm -f *.whl
 	rm -rf build/
 

libsemigroups_pybind11/tools.py

@@ -10,7 +10,7 @@
 This package provides the user-facing python part of libsemigroups_pybind11
 """
 
-import pkgconfig
+from ._version import version as __version__
 
 from .detail.dot import _Dot as Dot
 
@@ -48,8 +48,6 @@
     "https://github.com/libsemigroups/libsemigroups_pybind11)"
 )
 
-assert pkgconfig.exists("libsemigroups")
-
 try:
     from _libsemigroups_pybind11 import (  # pylint: disable=no-name-in-module
         AhoCorasick,