Skip to content

Commit 549c661

Browse files
authored
Merge pull request #5825 from jeffwidman/some-docs-cleanups
Some docs cleanups
2 parents 9202cf1 + 94497b2 commit 549c661

File tree

1 file changed

+15
-51
lines changed

1 file changed

+15
-51
lines changed

docs/advanced.rst

Lines changed: 15 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -77,9 +77,9 @@ file very easily.
7777
Let's take this ``Pipfile``::
7878

7979
[[source]]
80-
url = "https://pypi.python.org/simple"
81-
verify_ssl = true
8280
name = "pypi"
81+
url = "https://pypi.org/simple"
82+
verify_ssl = true
8383

8484
[packages]
8585
requests = {version="==2.18.4"}
@@ -99,7 +99,7 @@ Which generates a ``Pipfile.lock`` upon completion of running ``pipenv lock``` s
9999
"sources": [
100100
{
101101
"name": "pypi",
102-
"url": "https://pypi.python.org/simple",
102+
"url": "https://pypi.org/simple",
103103
"verify_ssl": true
104104
}
105105
]
@@ -132,7 +132,7 @@ Which generates a ``Pipfile.lock`` upon completion of running ``pipenv lock``` s
132132
Given the ``Pipfile.lock`` exists, you may generate a set of requirements out of it with the default dependencies::
133133

134134
$ pipenv requirements
135-
-i https://pypi.python.org/simple
135+
-i https://pypi.org/simple
136136
certifi==2022.9.24 ; python_version >= '3.6'
137137
chardet==3.0.4
138138
idna==2.6
@@ -143,7 +143,7 @@ As with other commands, passing ``--dev`` will include both the default and
143143
development dependencies::
144144

145145
$ pipenv requirements --dev
146-
-i https://pypi.python.org/simple
146+
-i https://pypi.org/simple
147147
colorama==0.4.5 ; sys_platform == 'win32'
148148
py==1.11.0 ; python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3, 3.4'
149149
pytest==3.2.3
@@ -159,7 +159,7 @@ development requirements you can do that too, using the ``--dev-only``
159159
flag::
160160

161161
$ pipenv requirements --dev-only
162-
-i https://pypi.python.org/simple
162+
-i https://pypi.org/simple
163163
colorama==0.4.5 ; sys_platform == 'win32'
164164
py==1.11.0 ; python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3, 3.4'
165165
pytest==3.2.3
@@ -174,14 +174,14 @@ used to write them to a file::
174174
$ pipenv requirements > requirements.txt
175175
$ pipenv requirements --dev-only > dev-requirements.txt
176176
$ cat requirements.txt
177-
-i https://pypi.python.org/simple
177+
-i https://pypi.org/simple
178178
certifi==2022.9.24 ; python_version >= '3.6'
179179
chardet==3.0.4
180180
idna==2.6
181181
requests==2.18.4
182182
urllib3==1.22
183183
$ cat dev-requirements.txt
184-
-i https://pypi.python.org/simple
184+
-i https://pypi.org/simple
185185
colorama==0.4.5 ; sys_platform == 'win32'
186186
py==1.11.0 ; python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3, 3.4'
187187
pytest==3.2.3
@@ -304,7 +304,8 @@ This is a very fancy feature, and we're very proud of it::
304304

305305
$ cat Pipfile
306306
[[source]]
307-
url = "https://pypi.python.org/simple"
307+
name = "pypi"
308+
url = "https://pypi.org/simple"
308309
verify_ssl = true
309310

310311
[dev-packages]
@@ -313,12 +314,12 @@ This is a very fancy feature, and we're very proud of it::
313314
requests = "*"
314315

315316
[requires]
316-
python_version = "3.6"
317+
python_version = "3.11"
317318

318319
$ pipenv install
319-
Warning: Python 3.6 was not found on your system...
320-
Would you like us to install latest CPython 3.6 with pyenv? [Y/n]: y
321-
Installing CPython 3.6.2 with pyenv (this may take a few minutes)...
320+
Warning: Python 3.11 was not found on your system...
321+
Would you like us to install latest CPython 3.11 with pyenv? [Y/n]: y
322+
Installing CPython 3.11.2 with pyenv (this may take a few minutes)...
322323
...
323324
Making Python installation global...
324325
Creating a virtualenv for this project...
@@ -340,47 +341,10 @@ Pipenv automatically honors both the ``python_full_version`` and ``python_versio
340341

341342
Pipenv is being used in projects like `Requests`_ for declaring development dependencies and running the test suite.
342343

343-
We have currently tested deployments with both `Travis-CI`_ and `tox`_ with success.
344-
345-
Travis CI
346-
/////////
347-
348-
An example Travis CI setup can be found in `Requests`_. The project uses a Makefile to
349-
define common functions such as its ``init`` and ``tests`` commands. Here is
350-
a stripped down example ``.travis.yml``::
351-
352-
language: python
353-
python:
354-
- "2.6"
355-
- "2.7"
356-
- "3.3"
357-
- "3.4"
358-
- "3.5"
359-
- "3.6"
360-
- "3.7-dev"
361-
362-
# command to install dependencies
363-
install: "make"
364-
365-
# command to run tests
366-
script:
367-
- make test
368-
369-
and the corresponding Makefile::
370-
371-
init:
372-
pip install pipenv
373-
pipenv install --dev
374-
375-
test:
376-
pipenv run pytest tests
377-
378-
379344
Tox Automation Project
380345
//////////////////////
381346

382-
Alternatively, you can configure a ``tox.ini`` like the one below for both local
383-
and external testing::
347+
Here's an example ``tox.ini`` for both local and external testing::
384348

385349
[tox]
386350
envlist = py37, py38, py39, py310, py311, pypy3, ruff

0 commit comments

Comments
 (0)