diff --git a/INSTALL.md b/INSTALL.md index 9fa6b7e..2a30c47 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -1,8 +1,15 @@ -# PySwip INSTALL +# Installing PySwip -PySwip has no dependencies beyond Python's standard library. Some operating systems do not install the full standard library. In that case make sure that your Python setup includes `ctypes`. +Requirements: -We recommend installing PySwip into a virtual environment. Python3 already has built-in support for that. You can create a virtual environment in `pyswip_env` directory using: + +PySwip has no dependencies beyond Python's standard library. +Some operating systems do not install the full standard library. +In that case make sure that your Python setup includes the `ctypes` module. + +We recommend installing PySwip into a virtual environment. +Python3 already has built-in support for that. +You can create a virtual environment in `pyswip_env` directory using: ``` python3 -m venv pyswip_env ``` @@ -25,7 +32,7 @@ See the [Python documentation](https://docs.python.org/3/library/venv.html) for ### Arch Linux -[Alexander Rødseth](https://roboticoverlords.org) maintains the [Arch Linux package](https://www.archlinux.org/packages/community/any/python-pyswip/). +[Alexander Rødseth](https://roboticoverlords.org) maintains the [Arch Linux package](https://archlinux.org/packages/extra/any/python-pyswip/). Install PySwip with dependencies using: ``` @@ -34,7 +41,7 @@ sudo pacman -S python-pyswip ### Manjaro Linux -Same as the Arch Linux instructions. See: https://discover.manjaro.org/packages/python-pyswip +Same as the Arch Linux instructions. See: https://manjaristas.org/branch_compare?q=pyswip ### Parabola GNU/Linux-libre diff --git a/Makefile b/Makefile index c16f830..9f16900 100644 --- a/Makefile +++ b/Makefile @@ -3,7 +3,7 @@ build: hatch build -clean:coveralls +clean: rm -rf dist build pyswip.egg-info coverage: diff --git a/pyproject.toml b/pyproject.toml index d0495e0..5036e47 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -41,15 +41,13 @@ Download = "https://github.com/yuce/pyswip/releases" Homepage = "https://github.com/yuce/pyswip" [tool.hatch.version] -path = "pyswip/__init__.py" +path = "src/pyswip/__init__.py" [tool.hatch.build.targets.sdist] -include = [ - "/pyswip", -] +packages = ["src/pyswip"] [tool.hatch.build.targets.wheel] -packages = ["pyswip"] +packages = ["src/pyswip"] [tool.hatch.envs.test] dependencies = [ diff --git a/pyswip/__init__.py b/src/pyswip/__init__.py similarity index 100% rename from pyswip/__init__.py rename to src/pyswip/__init__.py diff --git a/pyswip/core.py b/src/pyswip/core.py similarity index 100% rename from pyswip/core.py rename to src/pyswip/core.py diff --git a/pyswip/easy.py b/src/pyswip/easy.py similarity index 100% rename from pyswip/easy.py rename to src/pyswip/easy.py diff --git a/pyswip/prolog.py b/src/pyswip/prolog.py similarity index 100% rename from pyswip/prolog.py rename to src/pyswip/prolog.py