Remove usage of Pipenv, rely on good ol' pip
and virtualenv
in docs (#2717)
This commit is contained in:
parent
7c94ed61a5
commit
c758126a27
49
Pipfile
49
Pipfile
@ -1,49 +0,0 @@
|
||||
[[source]]
|
||||
name = "pypi"
|
||||
url = "https://pypi.python.org/simple"
|
||||
verify_ssl = true
|
||||
|
||||
[dev-packages]
|
||||
# Testing related requirements.
|
||||
coverage = ">= 5.3"
|
||||
pytest = " >= 6.1.1"
|
||||
pytest-xdist = ">= 2.2.1"
|
||||
pytest-cov = ">= 2.11.1"
|
||||
tox = "*"
|
||||
|
||||
# Linting related requirements.
|
||||
pre-commit = ">=2.9.2"
|
||||
flake8 = ">=3.9.2"
|
||||
flake8-bugbear = "*"
|
||||
mypy = ">=0.910"
|
||||
types-dataclasses = ">=0.1.3"
|
||||
types-typed-ast = ">=1.4.1"
|
||||
types-PyYAML = ">=5.4.1"
|
||||
|
||||
# Documentation related requirements.
|
||||
Sphinx = ">=4.1.2"
|
||||
MyST-Parser = ">=0.15.1"
|
||||
sphinxcontrib-programoutput = ">=0.17"
|
||||
sphinx-copybutton = ">=0.4.0"
|
||||
docutils = "==0.17.1" # not a direct dependency, see https://github.com/pypa/pipenv/issues/3865
|
||||
|
||||
# Packaging related requirements.
|
||||
setuptools = ">=39.2.0"
|
||||
setuptools-scm = "*"
|
||||
twine = ">=1.11.0"
|
||||
wheel = ">=0.31.1"
|
||||
readme_renderer = "*"
|
||||
|
||||
black = {editable = true, extras = ["d", "jupyter"], path = "."}
|
||||
|
||||
[packages]
|
||||
aiohttp = ">=3.7.4"
|
||||
platformdirs= ">=2"
|
||||
click = ">=8.0.0"
|
||||
mypy_extensions = ">=0.4.3"
|
||||
pathspec = ">=0.8.1"
|
||||
tomli = ">=1.1.0, <3.0.0"
|
||||
typed-ast = "==1.4.3"
|
||||
typing_extensions = {markers = "python_version < '3.10'", version = ">=3.10.0.0"}
|
||||
black = {editable = true,extras = ["d"],path = "."}
|
||||
dataclasses = {markers = "python_version < '3.7'", version = ">0.1.3"}
|
1958
Pipfile.lock
generated
1958
Pipfile.lock
generated
File diff suppressed because it is too large
Load Diff
@ -10,20 +10,11 @@ You can use any operating system.
|
||||
Install all development dependencies using:
|
||||
|
||||
```console
|
||||
$ pipenv install --dev
|
||||
$ pipenv shell
|
||||
$ pre-commit install
|
||||
```
|
||||
|
||||
If you haven't used `pipenv` before but are comfortable with virtualenvs, just run
|
||||
`pip install pipenv` in the virtualenv you're already using and invoke the command above
|
||||
from the cloned _Black_ repo. It will do the correct thing.
|
||||
|
||||
Non pipenv install works too:
|
||||
|
||||
```console
|
||||
$ pip install -r test_requirements.txt
|
||||
$ pip install -e .[d]
|
||||
$ python3 -m venv .venv
|
||||
$ source .venv/bin/activate
|
||||
(.venv)$ pip install -r test_requirements.txt
|
||||
(.venv)$ pip install -e .[d]
|
||||
(.venv)$ pre-commit install
|
||||
```
|
||||
|
||||
Before submitting pull requests, run lints and tests with the following commands from
|
||||
@ -31,16 +22,16 @@ the root of the black repo:
|
||||
|
||||
```console
|
||||
# Linting
|
||||
$ pre-commit run -a
|
||||
(.venv)$ pre-commit run -a
|
||||
|
||||
# Unit tests
|
||||
$ tox -e py
|
||||
(.venv)$ tox -e py
|
||||
|
||||
# Optional Fuzz testing
|
||||
$ tox -e fuzz
|
||||
(.venv)$ tox -e fuzz
|
||||
|
||||
# Optional CI run to test your changes on many popular python projects
|
||||
$ black-primer [-k -w /tmp/black_test_repos]
|
||||
(.venv)$ black-primer [-k -w /tmp/black_test_repos]
|
||||
```
|
||||
|
||||
### News / Changelog Requirement
|
||||
@ -70,9 +61,9 @@ formatting don't need to be mentioned separately though.
|
||||
If you make changes to docs, you can test they still build locally too.
|
||||
|
||||
```console
|
||||
$ pip install -r docs/requirements.txt
|
||||
$ pip install [-e] .[d]
|
||||
$ sphinx-build -a -b html -W docs/ docs/_build/
|
||||
(.venv)$ pip install -r docs/requirements.txt
|
||||
(.venv)$ pip install [-e] .[d]
|
||||
(.venv)$ sphinx-build -a -b html -W docs/ docs/_build/
|
||||
```
|
||||
|
||||
## black-primer
|
||||
|
Loading…
Reference in New Issue
Block a user