| Name | guiguts JSON |
| Version |
2.0.0a15
JSON |
| download |
| home_page | None |
| Summary | Guiguts version 2, Python/tkinter version |
| upload_time | 2025-02-17 15:28:21 |
| maintainer | None |
| docs_url | None |
| author | Nigel |
| requires_python | <4.0,>=3.11 |
| license | None |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Guiguts
Guiguts - an application to support creation of ebooks for PG
**If you want to use Guiguts for PPing, rather than to develop the code, see below for [User Installation Notes](#user-installation-notes).**
## Common Development Setup
1. Install Python & Poetry, clone the repo and create a virtual environment,
using the OS-specific instructions below.
2. After following the OS-specific instructions, in the cloned GG2 directory,
install the GG2 python dependencies in the virtual environment. This will
install GG2 as an editable package that you can develop and run directly.
```bash
poetry install
```
If additional dependencies are added to GG2, or you use pyenv to switch
to a new version of python, you will need to re-run this command.
3. You can then run GG2 directly with `poetry run guiguts`.
An alternative to `poetry run` is to enable your shell to use the poetry
environment. How to accomplish this differs depending which version of Poetry
you're using (which you can see by running `poetry --version`):
For Poetry 1, you can start a virtual environment shell with `poetry shell`,
then run GG2 with `guiguts`.
In Poetry 2, the `shell` command has been removed; instead, activate the virtual
environment with `eval $(poetry env activate)`. Once activated, you can run GG2
using `guiguts`. To deactivate the environment and return to your base
environment, either exit the shell or run `deactivate`.
## Windows Development Setup
### Install Python
#### Single (system-wide) version
1. Download Python 3.11 from [python.org](https://www.python.org/).
2. Install – default dir is `C:\Users\<username>\AppData\Local\Programs\Python\Python311`
3. Ensure this dir is in PATH variable
#### Using pyenv to install/use multiple Python versions
[pyenv](https://github.com/pyenv/pyenv/blob/master/README.md) lets you easily switch between
multiple versions of Python, if that would be useful for development/testing.
1. Clone the pyenv-win repo: `git clone https://github.com/pyenv-win/pyenv-win.git "$HOME\.pyenv"`
2. Add environment variables (can execute these in a Powershell window):
```powershell
[System.Environment]::SetEnvironmentVariable('PYENV',$env:USERPROFILE + "\.pyenv\pyenv-win\","User")
[System.Environment]::SetEnvironmentVariable('PYENV_ROOT',$env:USERPROFILE + "\.pyenv\pyenv-win\","User")
[System.Environment]::SetEnvironmentVariable('PYENV_HOME',$env:USERPROFILE + "\.pyenv\pyenv-win\","User")
[System.Environment]::SetEnvironmentVariable('path', $env:USERPROFILE + "\.pyenv\pyenv-win\bin;" + $env:USERPROFILE + "\.pyenv\pyenv-win\shims;" + [System.Environment]::GetEnvironmentVariable('path', "User"),"User")
```
3. In a new shell, install version(s) of Python, e.g. `pyenv install 3.11.7`,
`pyenv install 3.12.0`, etc.
4. To set python version, use `pyenv global 3.11.7`, for example.
### Install Poetry
1. https://python-poetry.org/docs/#installing-with-the-official-installer
2. `(Invoke-WebRequest -Uri https://install.python-poetry.org -UseBasicParsing).Content | py -`
3. Installs into `C:\Users\<username>\AppData\Roaming`
4. Adds top-level “poetry” wrapper in `C:\Users\<username>\AppData\Roaming\Python\Scripts`
5. Ensure the latter is in PATH variable
### Clone the GG2 repo
Either clone the [GG2 Github repo](https://github.com/DistributedProofreaders/guiguts-py)
or a fork thereof.
### Create virtual environment
In the cloned GG2 directory, create a virtual environment using a version of
python you installed above.
* Single python version (in git bash shell)
```bash
poetry env use ~/AppData/Local/Programs/Python/Python311/python.exe
```
* If using pyenv (in git bash shell)
```bash
poetry config virtualenvs.prefer-active-python true
```
## macOS Development Setup
Developing Guiguts on macOS requires installing [Homebrew](https://brew.sh/) first.
### Install Python
Install python and python-tk using Homebrew. Note that we install and use a
specific version in the commands below for consistency with other developers.
```bash
brew install python@3.11 python-tk@3.11
```
### Install Poetry
We also install poetry using Homebrew.
```bash
brew install poetry
```
### Clone the GG2 repo
Either clone the [GG2 Github repo](https://github.com/DistributedProofreaders/guiguts-py)
or a fork thereof.
### Create virtual environment
In the cloned GG2 directory, create a virtual environment using a version of
python you installed above.
```bash
poetry env use $(brew --prefix)/bin/python3.11
```
## Linux Development Setup
1. Install Python, Poetry, etc.
* Example from Ubuntu 22.04 -- adapt to your own Linux distro
```bash
sudo apt install python3.11 python3-pip python3-tk idle-python3.11 git
sudo python3.11 -m pip install poetry
## Test that Tk will work
python3.11 -m tkinter
```
* The last line above tests that Tk is working with Python. It should open a small
window on your screen. Click the `Click me!` button to test mouse clicks, and
`QUIT` to close the window, ending the test.
2. Clone the [GG2 Github repo](https://github.com/DistributedProofreaders/guiguts-py)
or a fork thereof.
3. In the cloned GG2 directory, create a virtual environment using a version of
python you installed above.
```bash
poetry env use $(which python3.11)
```
## Code style
Guiguts 2 uses [flake8](https://pypi.org/project/flake8) and
[pylint](https://www.pylint.org) for static code analysis, and
[black](https://pypi.org/project/black) for consistent styling. All use default
settings, with the exception of maximum line length checking which is adjusted
in the recommended manner (using the `.flake8` file and the `tool.pylint`
section of `pyproject.toml`) to avoid conflicts with black.
All of the above tools will be installed via `poetry` as described above.
`poetry run flake8 .` will check all `src` & `tests` python files.
`poetry run pylint --recursive y .` will check all `src` & `tests` python files.
`poetry run black .` will reformat all `src` & `tests` python files where necessary.
This project uses Github Actions to ensure none of the above tools report any
error.
Naming conventions from [PEP8](https://pep8.org/#prescriptive-naming-conventions)
are used. To summarize, class names use CapWords; constants are ALL_UPPERCASE;
most other variables, functions and methods are all_lowercase.
## Documentation
[Google-style docstrings](https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings)
are used to document modules, classes, functions, etc.
[Sphinx](https://www.sphinx-doc.org/en/master/index.html) will be installed by
poetry (above) and can be used to create HTML documentation by running the following command:
```bash
poetry run python -m sphinx -b html docs docs/build`
```
HTML docs will appear in the `docs/build` directory.
Sphinx can also be used to check coverage, i.e. that docstrings have been used everywhere
appropriate:
```bash
poetry run python -m sphinx -M coverage docs docs/build`
```
This project uses Github Actions to ensure running sphinx does not report an error, and
that the coverage check does not report any undocumented items.
## Type checking
[Mypy](https://mypy.readthedocs.io/en/stable/index.html) will be installed by
poetry (above) and is used for static type checking. Where developers have added
[type hints](https://peps.python.org/pep-0484/), mypy will issue warnings when those
types are used incorrectly.
It is not intended that every variable should have its type annotated, but developers
are encouraged to add type hints to function definitions, e.g.
```python
def myfunc(num: int) -> str:
...
```
Note that functions without type annotation will not be type checked. The
[type hints cheat sheet](https://mypy.readthedocs.io/en/stable/cheat_sheet_py3.html)
has a summary of how to use type annotations for various common situations.
To type check the Guiguts package and the test routines:
```bash
poetry run mypy -p guiguts
poetry run mypy tests
```
## Testing
[Pytest](https://docs.pytest.org) will be installed by poetry (above) and is used for testing.
All tests can be run using the following command:
`poetry run pytest`
Developers are encouraged to add tests (as appropriate) when new code is added to the project.
This project uses Github Actions to ensure running `pytest` does not report an error.
## Editor / IDE additional notes
### Visual Studio Code
Several debugger configs are provided:
- "Guiguts"
- Run Guiguts with debug output enabled
- "Guiguts (most recent file)"
- Run Guiguts with debug output enabled
- Open the most recently opened file
- "Guiguts (no debug output)"
- Run Guiguts without debug output
- "Guiguts (use default settings)"
- Run Guiguts with `--nohome` to not load your settings file
- Therefore all settings should be reset to their defaults
Requirement: [Python Debugger][vsc_debugpy] extension
[vsc_debugpy]: https://marketplace.visualstudio.com/items?itemName=ms-python.debugpy
Use the "Python: Select Interpreter" command to choose the appropriate Python environment. Your Poetry config should be detected and available to choose. If the Poetry config is not auto-detected, use `poetry env info -e` in the shell to find the Poetry-configured python interpreter. Then in the "Python: Select Interpreter" command, choose "Enter interpreter path..." and paste the full path to the `python` executable.
## User Installation Notes
This section contains notes from users who have installed Guiguts 2 on various platforms to use for PPing. **If you are a developer, you probably want the [Development Installation Notes](#common-development-setup).**
Note that although the developers' installation notes specify Python 3.11,
Guiguts 2 also works with version 3.12 if that is more convenient
### Windows
1. Install Python 3.11 or 3.12 from [Python.org](https://www.python.org/downloads/windows/)
if you haven't already done that.
2. Type `pip install guiguts` (or `pip install guiguts --upgrade` to upgrade from a
previous version of GG2).
3. Type `guiguts` to run GG2.
### macOS
1. Install python 3.11 or 3.12 and python-tk using Homebrew if you don't already have it.
For example:
```bash
brew install python@3.11 python-tk@3.11
```
2. Type `pip install guiguts` (or `pip install guiguts --upgrade` to upgrade from a
previous version of GG2).
3. Type `guiguts` to run GG2.
### Linux
1. Ensure you have Python 3.11 or 3.12 installed. See Linux development instructions above
if necessary.
2. Type `pip install guiguts` (or `pip install guiguts --upgrade` to upgrade from a
previous version of GG2).
3. Type `guiguts` to run GG2.
### Chromebook (after enabling Linux)
Check you have python3:
python3 --version
If not:
sudo apt install python3
Next, check you have pip:
python3 -m pip --version
If not:
sudo apt install python3-pip
Now try this command:
python3 -m pip install guiguts
You might come across this error:
error: externally-managed-environment
× This environment is externally managed
╰─> To install Python packages system-wide, try apt install
python3-xyz, where xyz is the package you are trying to
install.
If you wish to install a non-Debian-packaged Python package,
create a virtual environment using python3 -m venv path/to/venv.
Then use path/to/venv/bin/python and path/to/venv/bin/pip. Make
sure you have python3-full installed.
If you wish to install a non-Debian packaged Python application,
it may be easiest to use pipx install xyz, which will manage a
virtual environment for you. Make sure you have pipx installed.
See /usr/share/doc/python3.11/README.venv for more information.
Let's go with the third option, and see if you have pipx:
pipx install guiguts
If you get this error:
-bash: pipx: command not found
You need to install pipx:
sudo apt install pipx
Then run this command before you install anything using pipx:
pipx ensurepath
Open a new terminal or re-login and try this command:
pipx install --include-deps guiguts
If you get an error saying no IdleLib module could be found:
sudo apt-get install python3-Tk
sudo apt-get install idle3
Now try the install command again:
pipx install --include-deps guiguts
You'll need to use this command to open GG2 each time:
pipx run guiguts
To update, you can use:
pipx upgrade guiguts
#### Sources
https://stackoverflow.com/questions/6587507/how-to-install-pip-with-python-3
https://stackoverflow.com/questions/43987444/install-pip-for-python-3
https://realpython.com/python-pipx/
https://askubuntu.com/questions/1183317/modulenotfounderror-no-module-named-idlelib
## Licensing
Copyright Contributors to the [Guiguts-py](https://github.com/DistributedProofreaders/guiguts-py) project
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License along
with this program; if not, write to the Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
Raw data
{
"_id": null,
"home_page": null,
"name": "guiguts",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.11",
"maintainer_email": null,
"keywords": null,
"author": "Nigel",
"author_email": "windymilla@users.noreply.github.com",
"download_url": "https://files.pythonhosted.org/packages/f9/be/a7eeed6f0d4dd3ca24436c10c6b780ec7c4791c50ce55e17b40e92208d1e/guiguts-2.0.0a15.tar.gz",
"platform": null,
"description": "# Guiguts\n\nGuiguts - an application to support creation of ebooks for PG\n\n**If you want to use Guiguts for PPing, rather than to develop the code, see below for [User Installation Notes](#user-installation-notes).**\n\n## Common Development Setup\n\n1. Install Python & Poetry, clone the repo and create a virtual environment,\n using the OS-specific instructions below.\n2. After following the OS-specific instructions, in the cloned GG2 directory,\n install the GG2 python dependencies in the virtual environment. This will\n install GG2 as an editable package that you can develop and run directly.\n ```bash\n poetry install\n ```\n If additional dependencies are added to GG2, or you use pyenv to switch\n to a new version of python, you will need to re-run this command.\n3. You can then run GG2 directly with `poetry run guiguts`.\n\nAn alternative to `poetry run` is to enable your shell to use the poetry\nenvironment. How to accomplish this differs depending which version of Poetry\nyou're using (which you can see by running `poetry --version`):\n\nFor Poetry 1, you can start a virtual environment shell with `poetry shell`,\nthen run GG2 with `guiguts`.\n\nIn Poetry 2, the `shell` command has been removed; instead, activate the virtual\nenvironment with `eval $(poetry env activate)`. Once activated, you can run GG2\nusing `guiguts`. To deactivate the environment and return to your base\nenvironment, either exit the shell or run `deactivate`.\n\n## Windows Development Setup\n\n### Install Python\n\n#### Single (system-wide) version\n\n1. Download Python 3.11 from [python.org](https://www.python.org/).\n2. Install \u2013 default dir is `C:\\Users\\<username>\\AppData\\Local\\Programs\\Python\\Python311`\n3. Ensure this dir is in PATH variable\n\n#### Using pyenv to install/use multiple Python versions\n\n[pyenv](https://github.com/pyenv/pyenv/blob/master/README.md) lets you easily switch between\nmultiple versions of Python, if that would be useful for development/testing.\n\n1. Clone the pyenv-win repo: `git clone https://github.com/pyenv-win/pyenv-win.git \"$HOME\\.pyenv\"`\n2. Add environment variables (can execute these in a Powershell window):\n ```powershell\n [System.Environment]::SetEnvironmentVariable('PYENV',$env:USERPROFILE + \"\\.pyenv\\pyenv-win\\\",\"User\")\n [System.Environment]::SetEnvironmentVariable('PYENV_ROOT',$env:USERPROFILE + \"\\.pyenv\\pyenv-win\\\",\"User\")\n [System.Environment]::SetEnvironmentVariable('PYENV_HOME',$env:USERPROFILE + \"\\.pyenv\\pyenv-win\\\",\"User\")\n [System.Environment]::SetEnvironmentVariable('path', $env:USERPROFILE + \"\\.pyenv\\pyenv-win\\bin;\" + $env:USERPROFILE + \"\\.pyenv\\pyenv-win\\shims;\" + [System.Environment]::GetEnvironmentVariable('path', \"User\"),\"User\")\n ```\n3. In a new shell, install version(s) of Python, e.g. `pyenv install 3.11.7`,\n`pyenv install 3.12.0`, etc.\n4. To set python version, use `pyenv global 3.11.7`, for example.\n\n### Install Poetry\n\n1. https://python-poetry.org/docs/#installing-with-the-official-installer \n2. `(Invoke-WebRequest -Uri https://install.python-poetry.org -UseBasicParsing).Content | py -`\n3. Installs into `C:\\Users\\<username>\\AppData\\Roaming`\n4. Adds top-level \u201cpoetry\u201d wrapper in `C:\\Users\\<username>\\AppData\\Roaming\\Python\\Scripts`\n5. Ensure the latter is in PATH variable\n\n### Clone the GG2 repo\n\nEither clone the [GG2 Github repo](https://github.com/DistributedProofreaders/guiguts-py)\nor a fork thereof.\n\n### Create virtual environment\n\nIn the cloned GG2 directory, create a virtual environment using a version of\npython you installed above.\n * Single python version (in git bash shell)\n ```bash\n poetry env use ~/AppData/Local/Programs/Python/Python311/python.exe\n ```\n * If using pyenv (in git bash shell)\n ```bash\n poetry config virtualenvs.prefer-active-python true\n ```\n\n## macOS Development Setup\n\nDeveloping Guiguts on macOS requires installing [Homebrew](https://brew.sh/) first.\n\n### Install Python\n\nInstall python and python-tk using Homebrew. Note that we install and use a\nspecific version in the commands below for consistency with other developers.\n\n```bash\nbrew install python@3.11 python-tk@3.11\n```\n\n### Install Poetry\n\nWe also install poetry using Homebrew.\n\n```bash\nbrew install poetry\n```\n\n### Clone the GG2 repo\n\nEither clone the [GG2 Github repo](https://github.com/DistributedProofreaders/guiguts-py)\nor a fork thereof.\n\n### Create virtual environment\n\nIn the cloned GG2 directory, create a virtual environment using a version of\npython you installed above.\n\n```bash\npoetry env use $(brew --prefix)/bin/python3.11\n```\n\n## Linux Development Setup\n\n1. Install Python, Poetry, etc.\n * Example from Ubuntu 22.04 -- adapt to your own Linux distro\n ```bash\n sudo apt install python3.11 python3-pip python3-tk idle-python3.11 git\n sudo python3.11 -m pip install poetry\n ## Test that Tk will work\n python3.11 -m tkinter\n ```\n * The last line above tests that Tk is working with Python. It should open a small\n window on your screen. Click the `Click me!` button to test mouse clicks, and\n `QUIT` to close the window, ending the test.\n2. Clone the [GG2 Github repo](https://github.com/DistributedProofreaders/guiguts-py)\n or a fork thereof.\n3. In the cloned GG2 directory, create a virtual environment using a version of\n python you installed above.\n ```bash\n poetry env use $(which python3.11)\n ```\n\n## Code style\n\nGuiguts 2 uses [flake8](https://pypi.org/project/flake8) and\n[pylint](https://www.pylint.org) for static code analysis, and\n[black](https://pypi.org/project/black) for consistent styling. All use default\nsettings, with the exception of maximum line length checking which is adjusted\nin the recommended manner (using the `.flake8` file and the `tool.pylint`\nsection of `pyproject.toml`) to avoid conflicts with black.\n\nAll of the above tools will be installed via `poetry` as described above.\n\n`poetry run flake8 .` will check all `src` & `tests` python files.\n\n`poetry run pylint --recursive y .` will check all `src` & `tests` python files.\n\n`poetry run black .` will reformat all `src` & `tests` python files where necessary.\n\nThis project uses Github Actions to ensure none of the above tools report any\nerror.\n\nNaming conventions from [PEP8](https://pep8.org/#prescriptive-naming-conventions)\nare used. To summarize, class names use CapWords; constants are ALL_UPPERCASE;\nmost other variables, functions and methods are all_lowercase.\n\n## Documentation\n\n[Google-style docstrings](https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings)\nare used to document modules, classes, functions, etc.\n\n[Sphinx](https://www.sphinx-doc.org/en/master/index.html) will be installed by\npoetry (above) and can be used to create HTML documentation by running the following command:\n```bash\npoetry run python -m sphinx -b html docs docs/build`\n```\n\nHTML docs will appear in the `docs/build` directory.\n\nSphinx can also be used to check coverage, i.e. that docstrings have been used everywhere\nappropriate:\n```bash\npoetry run python -m sphinx -M coverage docs docs/build`\n```\n\nThis project uses Github Actions to ensure running sphinx does not report an error, and\nthat the coverage check does not report any undocumented items.\n\n## Type checking\n\n[Mypy](https://mypy.readthedocs.io/en/stable/index.html) will be installed by\npoetry (above) and is used for static type checking. Where developers have added \n[type hints](https://peps.python.org/pep-0484/), mypy will issue warnings when those\ntypes are used incorrectly.\n\nIt is not intended that every variable should have its type annotated, but developers\nare encouraged to add type hints to function definitions, e.g.\n```python\ndef myfunc(num: int) -> str:\n ...\n```\nNote that functions without type annotation will not be type checked. The\n[type hints cheat sheet](https://mypy.readthedocs.io/en/stable/cheat_sheet_py3.html)\nhas a summary of how to use type annotations for various common situations.\n\nTo type check the Guiguts package and the test routines:\n```bash\npoetry run mypy -p guiguts\npoetry run mypy tests\n```\n\n## Testing\n\n[Pytest](https://docs.pytest.org) will be installed by poetry (above) and is used for testing.\n\nAll tests can be run using the following command:\n`poetry run pytest`\n\nDevelopers are encouraged to add tests (as appropriate) when new code is added to the project.\n\nThis project uses Github Actions to ensure running `pytest` does not report an error.\n\n## Editor / IDE additional notes\n\n### Visual Studio Code\n\nSeveral debugger configs are provided:\n\n- \"Guiguts\"\n - Run Guiguts with debug output enabled\n- \"Guiguts (most recent file)\"\n - Run Guiguts with debug output enabled\n - Open the most recently opened file\n- \"Guiguts (no debug output)\"\n - Run Guiguts without debug output\n- \"Guiguts (use default settings)\"\n - Run Guiguts with `--nohome` to not load your settings file\n - Therefore all settings should be reset to their defaults\n\nRequirement: [Python Debugger][vsc_debugpy] extension\n\n[vsc_debugpy]: https://marketplace.visualstudio.com/items?itemName=ms-python.debugpy\n\nUse the \"Python: Select Interpreter\" command to choose the appropriate Python environment. Your Poetry config should be detected and available to choose. If the Poetry config is not auto-detected, use `poetry env info -e` in the shell to find the Poetry-configured python interpreter. Then in the \"Python: Select Interpreter\" command, choose \"Enter interpreter path...\" and paste the full path to the `python` executable. \n\n## User Installation Notes\n\nThis section contains notes from users who have installed Guiguts 2 on various platforms to use for PPing. **If you are a developer, you probably want the [Development Installation Notes](#common-development-setup).**\n\nNote that although the developers' installation notes specify Python 3.11,\nGuiguts 2 also works with version 3.12 if that is more convenient\n\n### Windows\n\n1. Install Python 3.11 or 3.12 from [Python.org](https://www.python.org/downloads/windows/)\nif you haven't already done that.\n2. Type `pip install guiguts` (or `pip install guiguts --upgrade` to upgrade from a\nprevious version of GG2).\n3. Type `guiguts` to run GG2.\n\n### macOS\n\n1. Install python 3.11 or 3.12 and python-tk using Homebrew if you don't already have it.\nFor example:\n```bash\nbrew install python@3.11 python-tk@3.11\n```\n2. Type `pip install guiguts` (or `pip install guiguts --upgrade` to upgrade from a\nprevious version of GG2).\n3. Type `guiguts` to run GG2.\n\n### Linux\n\n1. Ensure you have Python 3.11 or 3.12 installed. See Linux development instructions above\nif necessary.\n2. Type `pip install guiguts` (or `pip install guiguts --upgrade` to upgrade from a\nprevious version of GG2).\n3. Type `guiguts` to run GG2.\n\n### Chromebook (after enabling Linux)\n\nCheck you have python3:\n\n python3 --version\n\nIf not:\n\n sudo apt install python3\n\nNext, check you have pip:\n\n python3 -m pip --version\n\nIf not:\n\n sudo apt install python3-pip\n\nNow try this command:\n\n python3 -m pip install guiguts\n\nYou might come across this error:\n\n error: externally-managed-environment\n\n \u00d7 This environment is externally managed\n \u2570\u2500> To install Python packages system-wide, try apt install\n python3-xyz, where xyz is the package you are trying to\n install.\n \n If you wish to install a non-Debian-packaged Python package,\n create a virtual environment using python3 -m venv path/to/venv.\n Then use path/to/venv/bin/python and path/to/venv/bin/pip. Make\n sure you have python3-full installed.\n \n If you wish to install a non-Debian packaged Python application,\n it may be easiest to use pipx install xyz, which will manage a\n virtual environment for you. Make sure you have pipx installed.\n \n See /usr/share/doc/python3.11/README.venv for more information.\n\nLet's go with the third option, and see if you have pipx: \n\n pipx install guiguts\n\nIf you get this error:\n\n -bash: pipx: command not found\n\nYou need to install pipx:\n\n sudo apt install pipx\n\nThen run this command before you install anything using pipx:\n\n pipx ensurepath\n\nOpen a new terminal or re-login and try this command:\n\n pipx install --include-deps guiguts\n\nIf you get an error saying no IdleLib module could be found:\n\n sudo apt-get install python3-Tk\n sudo apt-get install idle3\n\nNow try the install command again:\n\n pipx install --include-deps guiguts\n\nYou'll need to use this command to open GG2 each time:\n\n pipx run guiguts\n\nTo update, you can use:\n\n pipx upgrade guiguts\n\n#### Sources\n\nhttps://stackoverflow.com/questions/6587507/how-to-install-pip-with-python-3\nhttps://stackoverflow.com/questions/43987444/install-pip-for-python-3\nhttps://realpython.com/python-pipx/\nhttps://askubuntu.com/questions/1183317/modulenotfounderror-no-module-named-idlelib\n\n\n## Licensing\n\nCopyright Contributors to the [Guiguts-py](https://github.com/DistributedProofreaders/guiguts-py) project\n\nThis program is free software; you can redistribute it and/or modify\nit under the terms of the GNU General Public License as published by\nthe Free Software Foundation; either version 2 of the License, or\n(at your option) any later version.\n\nThis program is distributed in the hope that it will be useful,\nbut WITHOUT ANY WARRANTY; without even the implied warranty of\nMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\nGNU General Public License for more details.\n\nYou should have received a copy of the GNU General Public License along\nwith this program; if not, write to the Free Software Foundation, Inc.,\n51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.\n\n",
"bugtrack_url": null,
"license": null,
"summary": "Guiguts version 2, Python/tkinter version",
"version": "2.0.0a15",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "914bda3640b58c4bbb21a6572a70fd071c264a94a3a70656ccdd56bf8b5eca6f",
"md5": "b690bb70bb3a5e76e952c98a8990d5e1",
"sha256": "94e673de4ffecf9f62b23473d55687bc8db334a75915bfc2b3261b7101db7eff"
},
"downloads": -1,
"filename": "guiguts-2.0.0a15-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b690bb70bb3a5e76e952c98a8990d5e1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.11",
"size": 4027815,
"upload_time": "2025-02-17T15:28:13",
"upload_time_iso_8601": "2025-02-17T15:28:13.042719Z",
"url": "https://files.pythonhosted.org/packages/91/4b/da3640b58c4bbb21a6572a70fd071c264a94a3a70656ccdd56bf8b5eca6f/guiguts-2.0.0a15-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f9bea7eeed6f0d4dd3ca24436c10c6b780ec7c4791c50ce55e17b40e92208d1e",
"md5": "2bbb8aed2cb49509aa51e1ea0f1162ae",
"sha256": "3f0b8c7cfcd34a0d1d4b747dd8e1f7d0b2c727f7623734620b2d4f670877b59f"
},
"downloads": -1,
"filename": "guiguts-2.0.0a15.tar.gz",
"has_sig": false,
"md5_digest": "2bbb8aed2cb49509aa51e1ea0f1162ae",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.11",
"size": 3957124,
"upload_time": "2025-02-17T15:28:21",
"upload_time_iso_8601": "2025-02-17T15:28:21.811129Z",
"url": "https://files.pythonhosted.org/packages/f9/be/a7eeed6f0d4dd3ca24436c10c6b780ec7c4791c50ce55e17b40e92208d1e/guiguts-2.0.0a15.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-17 15:28:21",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "guiguts"
}
