Przeglądaj źródła

Recommend uv and move default venv location to .venv

tags/v0.4.1
Ben Kurtovic 5 miesięcy temu
rodzic
commit
bc61c71d42
4 zmienionych plików z 14 dodań i 4 usunięć
  1. +1
    -1
      .gitignore
  2. +7
    -2
      README.rst
  3. +5
    -0
      docs/installation.rst
  4. +1
    -1
      pyproject.toml

+ 1
- 1
.gitignore Wyświetl plik

@@ -6,4 +6,4 @@ __pycache__
build
dist
docs/_build
venv
.venv

+ 7
- 2
README.rst Wyświetl plik

@@ -57,10 +57,14 @@ You can install the development version of the bot::

git clone https://github.com/earwig/earwigbot.git
cd earwigbot
python3 -m venv venv
. venv/bin/activate
python3 -m venv .venv
. .venv/bin/activate
pip install -e '.[crypto,sql,copyvios,dev]'

Or with `uv`_::

uv sync --all-extras

To run the bot's unit tests, run ``pytest`` (requires the ``dev``
dependencies). Coverage is currently rather incomplete.

@@ -180,6 +184,7 @@ docstrings`_ to learn how to use it in a more hands-on fashion. For reference,
.. _Python Package Index: https://pypi.python.org/pypi/earwigbot
.. _Toolforge: https://wikitech.wikimedia.org/wiki/Portal:Toolforge
.. _this StackOverflow post: https://stackoverflow.com/questions/6504810/how-to-install-lxml-on-ubuntu/6504860#6504860
.. _uv: https://docs.astral.sh/uv/
.. _documentation: https://pythonhosted.org/earwigbot/
.. _earwigbot.bot.Bot: https://github.com/earwig/earwigbot/blob/main/earwigbot/bot.py
.. _earwigbot.config.BotConfig: https://github.com/earwig/earwigbot/blob/main/earwigbot/config.py


+ 5
- 0
docs/installation.rst Wyświetl plik

@@ -40,6 +40,10 @@ You can install the development version of the bot::
. venv/bin/activate
pip install -e '.[crypto,sql,copyvios,dev]'

Or with `uv`_::

uv sync --all-extras

To run the bot's unit tests, run :command:`pytest` (requires the ``dev``
dependencies). Coverage is currently rather incomplete.

@@ -48,3 +52,4 @@ dependencies). Coverage is currently rather incomplete.
.. _Python Package Index: https://pypi.python.org/pypi/earwigbot
.. _Toolforge: https://wikitech.wikimedia.org/wiki/Portal:Toolforge
.. _this StackOverflow post: https://stackoverflow.com/questions/6504810/how-to-install-lxml-on-ubuntu/6504860#6504860
.. _uv: https://docs.astral.sh/uv/

+ 1
- 1
pyproject.toml Wyświetl plik

@@ -61,7 +61,7 @@ build-backend = "setuptools.build_meta"
[tool.pyright]
pythonVersion = "3.11"
venvPath = "."
venv = "venv"
venv = ".venv"

[tool.ruff]
target-version = "py311"


Ładowanie…
Anuluj
Zapisz