build: update pyproject.toml to conform to PEP 621
This commit is contained in:
@@ -66,25 +66,49 @@ Tests are a WIP. Recommendation is to run 'pytest' in the 'tests' directory.
|
||||
|
||||
# Development
|
||||
|
||||
I recommend pyenv to install a reliable, controlled python of preferred version locally.
|
||||
|
||||
```
|
||||
curl https://pyenv.run | bash
|
||||
|
||||
# Add to .bashrc or similar for different shells:
|
||||
tee -a "$HOME"/.profile <<'EOF'
|
||||
|
||||
export PYENV_ROOT="$HOME/.pyenv"
|
||||
[[ -d $PYENV_ROOT/bin ]] && export PATH="$PYENV_ROOT/bin:$PATH"
|
||||
eval "$(pyenv init -)"
|
||||
|
||||
EOF
|
||||
```
|
||||
* reference https://github.com/pyenv/pyenv
|
||||
|
||||
Clone the repo:
|
||||
```commandline
|
||||
git clone https://git-mirror.zavage.net/zavage-software/app_skellington.git
|
||||
```
|
||||
|
||||
Verify your desired python environment.
|
||||
|
||||
Poetry install to install dependencies and the program in your desired python environment
|
||||
```commandline
|
||||
poetry install
|
||||
# verify no errors
|
||||
```
|
||||
|
||||
Install pre-commit hooks:
|
||||
```commandline
|
||||
pre-commit install
|
||||
```
|
||||
|
||||
Begin development.
|
||||
Build:
|
||||
```
|
||||
python -m build
|
||||
```
|
||||
|
||||
Install:
|
||||
|
||||
```
|
||||
pip install .
|
||||
```
|
||||
|
||||
|
||||
|
||||
# Version
|
||||
|
||||
setuptools_scm will infer the version based on the latest tag in your Git history.
|
||||
Ensure you are tagging your commits with meaningful version numbers like v1.0.0, v1.1.0, etc.
|
||||
|
||||
# License
|
||||
|
||||
@@ -99,4 +123,7 @@ MIT no attribution required - https://opensource.org/license/mit-0
|
||||
* Project page: https://zavage-software.com/portfolio/app_skellington
|
||||
* Please report bugs, improvements, or feedback!
|
||||
* Contact: mathew@zavage.net
|
||||
|
||||
* Packing and distribution conforms to PEP 621 https://peps.python.org/pep-0621/
|
||||
* Reference https://packaging.python.org/en/latest/guides/distributing-packages-using-setuptools/
|
||||
|
||||
|
||||
Reference in New Issue
Block a user