Commit Graph

597 Commits

Author SHA1 Message Date
Matt Davis 3b719cbbf2 Merge pull request #5754 from pypa/docker-images
Add docker build, update docs for using docker images
2023-07-01 19:37:16 -04:00
Oz N Tiram 4e8bcf1793 Add docker build, update docs for using docker images 2023-06-27 23:00:16 +02:00
nullSoup 0e494736db Fix for issue #5748 (#5749)
* Add missing tab from Spinx autoclass directive

* Add news description of change
2023-06-26 23:55:31 +02:00
Matt Davis bd85705fde remove skip-lock from docs 2023-06-18 22:45:06 +02:00
Matt Davis 0dcfd08cbf Improve keyring docs. (#5733) 2023-06-12 09:42:41 +02:00
Matt Davis 5ebad396fd Remove ubuntu apt install from list and some other small doc review. (#5731) 2023-06-11 08:55:46 +02:00
plgruener 9a9ee9cfda Fix formatting in /docs (#5721) 2023-06-10 22:03:44 +02:00
dependabot[bot] 58fc4e74a4 Bump requests from 2.28.2 to 2.31.0 in /docs
Bumps [requests](https://github.com/psf/requests) from 2.28.2 to 2.31.0.
- [Release notes](https://github.com/psf/requests/releases)
- [Changelog](https://github.com/psf/requests/blob/main/HISTORY.md)
- [Commits](https://github.com/psf/requests/compare/v2.28.2...v2.31.0)

---
updated-dependencies:
- dependency-name: requests
  dependency-type: direct:production
...

Signed-off-by: dependabot[bot] <support@github.com>
2023-05-25 21:38:39 +02:00
TomeHirata 0fcd7444fc Fix a typo in the document 2023-04-27 12:09:57 +09:00
Matt Davis da5e75ce46 Merge pull request #5650 from ryan-rozario/tilde_semver
Update docs for tilde-equals in package versions
2023-04-16 20:27:18 -04:00
Ryan Rozario c04ce9e2bb Added another example example 2023-04-13 15:30:11 +00:00
Christian Clauss 9525db4623 feat: Replace flake8 and isort with ruff 2023-04-13 15:58:49 +02:00
Ryan Rozario 8b225737d3 Update docs for tilde-equals in package versions 2023-04-12 18:34:29 +00:00
Sam Doran 5d0b2d23b2 Correct typo in docs 2023-03-30 15:57:15 -04:00
Matt Davis 761a03d088 Doc revisions1 (#5621)
* Begin reviewing the basics docs.

* Check in delta

* More doc revisions.

* Split apart basics docs.

* Refactor based on building docs

* add the files back as markdown.

* more conversions to markdown.

* more conversions to markdown.

* fix markdown formatting.

* convert index to markdown.

* More docs review

* More markdown and doc revisions.

* Fix docs.

* Update doc build requirements.

* fix lint

* Fix build with update/upgrade command.

* remove useless quickstart and update the commands section.

* Fix lint

* change ordering of table of contents.

* fix changelog duplicate headings.

* Start splitting advanced topics.

* minor nits

* Move some sections from advanced to shell.

* remove this section as its stale and kind of off topic.

* move scripts out into its own section.

* Wrap up revisions1

* fix lint

* address PR feedback and other nits.

* fix lint

* Try improving ordering of table of contents, fix issue with indexes.md file location.

* fix lint

* PR feedback.
2023-03-18 08:44:58 +01:00
Matt Davis ca436af2bc Issue 5600 check command should be able to pull requirements from lock file (#5607)
* Allow pipenv check inputs to be built from the lockfile categories instead of whats installed.

* fix lint

* add news fragment.

* update pipenv check documentation.

* Revise logic for pipenv check and change default behavior to check lockfile.

* fix issue revealed by tests

* fix docs for pipenv check changes.

* change conditional ordering in prep for supporting for future default categories env var.
2023-02-18 20:58:47 +01:00
chrysle 2b94966ffc Improved contributing guide (#5611)
* Improved contributing guide

* Added news entry
2023-02-14 23:07:44 +01:00
Oz Tiram fe99aa1384 Remove deprecated flag --three 2023-01-23 01:18:23 +01:00
Ben Welsh ba5d7f4214 Fix typo in docs 2022-12-14 11:42:32 -08:00
dependabot[bot] eee0eecaac Bump certifi from 2018.10.15 to 2022.12.7 in /docs
Bumps [certifi](https://github.com/certifi/python-certifi) from 2018.10.15 to 2022.12.7.
- [Release notes](https://github.com/certifi/python-certifi/releases)
- [Commits](https://github.com/certifi/python-certifi/compare/2018.10.15...2022.12.07)

---
updated-dependencies:
- dependency-name: certifi
  dependency-type: direct:production
...

Signed-off-by: dependabot[bot] <support@github.com>
2022-12-08 01:13:37 +00:00
Artur f7e5a03758 fixed broken link to non-existing philosophy subpage 2022-12-07 11:34:38 +01:00
Oz N Tiram 3deb74c626 Merge pull request #5516 from efinkler-dm/spelling-fix-quickstart-regenarate
Fix spelling error in docs/quickstart.rst
2022-12-03 08:56:09 +01:00
Ed Finkler (DM) 8492765f54 Fix spelling error in docs/quickstart.rst 2022-12-02 10:04:52 -05:00
Matt Davis acad4c4dfc Documentation updates. 2022-11-23 12:45:43 -05:00
Micah Smith 258d82f21d Fix is_env_truthy 2022-11-02 11:58:29 -04:00
Micah Smith 6463bcd702 Update docs 2022-11-01 22:34:55 -04:00
Micah Smith 932e98637a Fix rst in contributing guide 2022-10-25 10:55:21 -04:00
Oz N Tiram 3e6dcfdf2c Merge pull request #5436 from pypa/docs-improvements
Docs improvements
2022-10-24 20:20:11 +02:00
Oz N Tiram 3660a3f149 Create a new man page and add a quickstart
Previously, the changelog was included inside the man page,
which made the man page totally unreadable.
This new man page is terse, as is the norm, in man pages.
It is is also re-used as a quickstart in the landing page of the
documentation.
2022-10-24 11:12:07 +02:00
Oz N Tiram c64654717d Move Changelog to the bottom of the document 2022-10-24 10:56:34 +02:00
dojutsu-user f2484992de update docs 2022-10-22 16:09:59 +05:30
Michał Wiśniewski 2431e0d19a Add missing backtick in the contributing documentation. (#5410) 2022-10-16 07:59:12 -04:00
Oz N Tiram 8032c5bea0 Merge pull request #5400 from feuloren/patch-1
Remove recommended packages link in doc sidebar
2022-10-12 11:18:18 +02:00
Florent Thévenet f2acb5ab9e Remove recommended packages link in doc sidebar
It's about `requests` recommended packages, not about `pipenv` recommended packages.
2022-10-11 17:00:56 +02:00
jerempy e36c62a7d7 news seg and lint 2022-10-10 10:56:12 -04:00
jerempy ad589bdbe1 Update documentation 2022-10-10 10:49:45 -04:00
Matt Davis 81cde423a5 add documentation for named categories. 2022-10-08 10:54:43 -04:00
Matt Davis 8c0667539c Update docs based on PR feedback. 2022-10-04 21:45:08 -04:00
Matt Davis 32ede85a55 Clarify sentence. 2022-10-02 09:50:53 -04:00
Matt Davis 6ad06134a2 Update documentation around requirements command and provide current examples. 2022-10-02 09:37:46 -04:00
Oz N Tiram abe6f565a2 Remove the --sequential from docs
We now use the batch install method from pip directly, so it's
meaningless.
2022-09-09 22:43:37 +02:00
Matt Davis 9848862927 Convert test runner to use pypiserver package as standalone process (#5284)
* Check point progress on moving tests to pypiserver.

* Allow other indexes to mimic the pypi json API for package hashes.

* Fix these tests that run on lower python versions only.

* Try adding the pypiserver to the github actions to only run once.

* Expand the scope of fixtures for pypiserver.

* try to accomedate microsoft runner.

* Windows networking troubles.

* Remove running as a background job.

* Try to condtionally invoke different start pypi-server commands

* Try to condtionally invoke different start pypi-server commands

* Try to condtionally invoke different start pypi-server commands

* Try to condtionally invoke different start pypi-server commands

* Try to condtionally invoke different start pypi-server commands

* Try to condtionally invoke different start pypi-server commands

* Try to condtionally invoke different start pypi-server commands

* Try to introduce pypi as the root index because setuptools-scm is not in our pypi artifacts.

* see if the windows tests run faster (and the other tests) by supplying waitress.

* Only use waitress on windows because the others are fast on the default.  Fix requests pollution.

* Supply a suitable Pipfile instead for these two failing tests.

* More requests resolver cross test contamination cleanup.

* remove problematic tests because even on my version of python 3.8.12 this does not work due to AttributeError: 'HTMLParser' object has no attribute 'unescape'

* fix mirror install test.

* Fix Pipfile.

* Fix Pipfile for real

* Fix tests

* Cleanup test naming and more test enhancements.

* Save this optimization for a subsequent PR.

* Cleanup the TemporaryDirectory between tests.

* resolve merge conflict.

* Cleanup path initalization -- it hsould always be a TemporaryDirectory for tests that gets cleanedup.

* Cleanup path initalization -- it hsould always be a TemporaryDirectory for tests that gets cleanedup.

* tableflip on those requests tests that read the setup metadata in reqlib from other tests.

* Update developer documentation for running tests.

* add news fragment.

* Try gunicorn perfoormance for linux/mac

* Only use gunicorn on linux based on the results of last run.
2022-09-05 10:19:12 -04:00
tocic dd4b0eaafe Fix typos 2022-09-05 15:33:09 +02:00
Matt Davis 7b9b1aeb1c Allow users to pass a string of extra arguments to pip (#5283)
* Allow users to pass a string of extra arguments to pip install
2022-09-04 16:20:59 -04:00
Dalton Durst b38ea71658 Fix Docker example in Basic Usage
The Docker example in the Basic Usage document needed a bit of TLC. Because the name of the virtualenv changed between the builder and the runtime container, Python was unable to find itself or its site-packages directory:

coolio@674956d0c53e:/usr/src$ ./venv/bin/pip
bash: ./venv/bin/pip: /usr/src/.venv/bin/python: bad interpreter: No such file or directory

To fix this, I changed the directory of the virtualenv in the runtime container to .venv which matches the builder.

I also added an example of how to get run.py into the container in the first place, since we run it later.
2022-09-02 01:12:59 +02:00
Harun Yasar b6d9ad6a63 Fix typo in Basic Usage of Pipenv doc (#5276) 2022-08-20 08:58:40 -04:00
Matt Davis c1924dbf44 Remvoe reference to -r from documentation. (#5258) 2022-08-14 23:43:36 -04:00
otherjake ec38ae1e81 Add unit test, create a section about venv names
in advanced docs.
2022-08-04 10:56:48 +02:00
otherjake badc1f4fa9 Support PIPENV_CUSTOM_VENV_NAME from environments
in the same way as other environment variables.
Update documentation to include the new variable.
2022-08-04 10:56:48 +02:00
Oz N Tiram 37db0234df Add some documentation on how to run tests locally. 2022-07-27 06:52:30 +02:00