Commit Graph

573 Commits

Author SHA1 Message Date
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
Matt Davis 0ee8234890 Issue 5000 remove requests certifi (#5146)
* Depend on requests and certifi from vendored pip and remove it as explicit vendor dependency.

* Documentation tweak.

* Add a news fragment.

* Update remaining vendor dependencies to point at the pip requests.

* vendoring task needs requests.
2022-06-27 21:13:30 +02:00
Oz N Tiram fb0f8884ad Fix Broken CLI docs (#5148)
* Fix building CLI docs

* Fix contributing docs

   Double colon before block directive is wrong.
2022-06-27 09:40:03 +02:00
ImreC 37b1fb422b Include markers issue #5092 (#5114)
* Include markers

* Change to marker flag and include test

* Flip markers flag to exclude by default

* Docs and newsfile

* Let default dependencies update dev dependencies
2022-06-25 13:23:04 +02:00
ImreC 6e26552628 Update docs and add deprecation warning for lock -r (#5069)
* Update docs and add deprecation warning for lock -r
2022-04-30 10:22:51 +02:00
Matt Davis dc8ac38b1b Allow pipenv option to consider all listed package sources when syncing the Pipfile.lock (#5039)
* Allow option to search all sources during installation.

* Add documentation for new Pipenv option ``install_search_all_sources``.
2022-04-20 21:21:38 -04:00
Jonathan ca8ff553a8 [fix] allow the user to overwrite the no_input flag to pip (#5036)
Support `no_input` flag for when you want to e.g. use keyring to authenticate against Google Artifact Registry.
2022-04-20 19:16:48 -04:00
Matt Davis 6034244498 cleanup stale links (#5048)
* cleanup stale links

* only support one sidebar html file. Address PR feedback.  HTML5 attributes.

* Update sphinx dependenencies

* Corrected CLI patch for new version of sphinx-click.

* fix placement of search bar back to original spot.

* cleanup a sphinx build warning.
2022-04-18 06:59:16 +02:00
Matt Davis 4f676ac9c8 sphinx formatting change and fix CLI docs (#5032)
* sphinx formatting change.

* minor doc formatting improvements.

* check point progress

* Get the CLI docs generating again.

* Add news item for fixed CLI documentation.

* Dont skip build of docs changes.

* fix linting
2022-04-08 11:36:18 +02:00
Matt Davis 99cf729dd5 Improve documentation around index restrictions (#5029)
* Improve documentation around index restrictions

* Update docs/advanced.rst

* Refine index documentation updates.   Factor out and re-use method before closing down other PR.

* Fully remove the --extra-index-url argument

Co-authored-by: Yusuke Nishioka <yusuke.nishioka.0713@gmail.com>
2022-04-06 11:16:13 +02:00
ImreC 63ac0d03a9 Implements requirements command as per #4959 (#5013)
* Implements reqs command

* Add news document

* Process comments

* Rename newsfile

* Adds --dev-only and --hash args

* Linting fixes

Co-authored-by: Imre Persoonlijk <imre1@pop-os.localdomain>
2022-04-05 14:13:33 +02:00
Matt Davis 9a3b3ce706 Issue 4993 Add standard pre commit hooks and apply linting. (#4994)
* Add .pre-commit-config.yaml to the project and exclude tests (for now).  This does not include the MyPy linting that pip does but does include everything else.
2022-03-29 23:01:50 -04:00
Matt Davis 79389f0031 Remove mention of the --two flag and python2 2022-03-12 03:07:48 -05:00
Oz N Tiram ce83c62938 Merge branch 'main' into master 2022-02-10 11:17:28 +01:00
Oz N Tiram 880f91c877 Merge pull request #4896 from den4uk/verify-hash-command
New command: verify Pipfile.lock hash is up to date
2022-02-10 11:14:31 +01:00
Thomas Sorrel 1d8f08100b doc fix docker container title 2022-02-09 18:04:02 +01:00
Oz N Tiram e6b15166f5 Fix typo in docker documnetation
This is now the correct path for running the application code.
2022-01-23 21:08:17 +01:00
Oz N Tiram aa68371bf4 Merge pull request #4921 from pypa/update-contributing.rst-and-run-tests
Update contributing.rst and run tests
2022-01-14 09:39:40 +01:00
Oz N Tiram ecef2d48e9 Fix some typos in contributing.rst 2022-01-13 13:02:23 +01:00
Oz N Tiram 9a5b14bafd Clarify usage of run-tests.sh
Explain how to override the default Python binary and the
Python version used by pipenv.
2022-01-13 12:54:57 +01:00
Oz N Tiram e8e24444fb Remove circular reference to CONTRIBUING.md
Also restore the link to be cordial ...
2022-01-13 10:08:25 +01:00
Sardorbek Imomaliev e9fa01620d Fix typo in docs/basics.rst for docker example 2022-01-13 14:17:34 +07:00
Oz N Tiram 5deb3af86a Remove the philosophy document
This document is no longer useful. KR has stepped down
and all the other maintainers are emeritus.

The rest of the philosophy is exlusive and could be removed
without doing any harm. KR still has earned his respect starting
this project.
2022-01-12 23:44:35 +01:00
Oz N Tiram d59c0de867 Update contributing.rst and refer to in CONTRIBUTING.md
There should be only one document describing how to contribute
to pipenv. Having both documents caused a drift between both.
2022-01-12 23:41:50 +01:00
Denis Sazonov 41e174898c docs update for cli verify command 2022-01-12 09:57:22 +00:00