Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Moved the pyswip package to src directory #169

Merged
merged 2 commits into from
Aug 30, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 12 additions & 5 deletions INSTALL.md
Original file line number Diff line number Diff line change
@@ -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
```
Expand All @@ -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:
```
Expand All @@ -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

Expand Down
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
build:
hatch build

clean:coveralls
clean:
rm -rf dist build pyswip.egg-info

coverage:
Expand Down
8 changes: 3 additions & 5 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -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 = [
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.