Commit Graph

264 Commits

Author SHA1 Message Date
Christian Clauss 9525db4623 feat: Replace flake8 and isort with ruff 2023-04-13 15:58:49 +02: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
Oz Tiram fe99aa1384 Remove deprecated flag --three 2023-01-23 01:18:23 +01: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
dojutsu-user f2484992de update docs 2022-10-22 16:09:59 +05:30
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 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 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
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
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
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 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
Denis Sazonov 41e174898c docs update for cli verify command 2022-01-12 09:57:22 +00:00
Frost Ming 1524315baf make the doc more accurate
close #4856
2021-11-11 17:23:13 +08:00
Frost Ming 57d6ce2646 Replace click-completion with click's own completion code 2021-11-09 11:14:42 +08:00
Frost Ming a95ed5281f Update the section in document 2020-11-13 11:38:41 +08:00
Frost Ming 72b571bd06 Change multiple styles in CLI output 2020-11-02 11:11:54 +08:00
Glen Smith 6897ebffa3 Add documentation of new scripts command. 2020-09-08 08:41:48 -06:00
Dan Ryan 46f3e5162c Merge branch 'master' into issue-3316-lock-all-deps-with-dev 2020-05-06 21:50:56 -04:00
Dan Ryan 2f460a9128 Add sphinx spellcheck addon (#4209)
Co-Authored-By: Frost Ming <mianghong@gmail.com>
Co-Authored-By: Sumana Harihareswara <sh@changeset.nyc>
2020-04-29 02:39:06 -04:00
Dan Ryan a68166af55 Reword note about pyup
Reword `pipenv check` note in docs

Co-Authored-By: Sumana Harihareswara <sh@changeset.nyc>
2020-04-28 12:19:19 -04:00
Dan Ryan 42321376c9 Update documentation to reflect accurate pyup use
- Remove bits about CC-BY-SA licensing
- Remove bits about using an embedded API key
- Add a little flair to the readme to acknowledge pyup

Signed-off-by: Dan Ryan <dan.ryan@canonical.com>
2020-04-26 02:50:40 -04:00
Nick Coghlan 1e54399de7 Default dependencies, not production dependencies 2020-04-10 15:58:38 +10:00
Nick Coghlan 592cbe54a1 Issue #3316: Include all deps in 'pipenv lock -r --dev'
* Implements PEEP-006
* `pipenv lock -r --dev` is now consistent with other commands
  and the CLI help output, and includes both default and dev
  dependencies in the result
* New `--dev-only` option allows requesting the previous behaviour
  (which was specifically designed to support the traditional
  `requirements.txt`/`dev-requirements.txt` split)
2020-04-10 15:51:58 +10:00
Frost Ming a883ef5159 Merge pull request #4100 from timhughes/dotenv_docs
Dotenv docs
2020-03-26 10:59:48 +08:00
Sumana Harihareswara 603a20bf45 Update links in documentation
The canonical Pipenv documentation is now at pipenv.pypa.io.
Also, the canonical GitHub repositories for Pipenv and
Requests have changed, and some other communications links
(Twitter, mailing list, "thank you") were no longer
operational. This commit updates those and clarifies that
Pipenv is a project maintained by the PyPA.

Fixes #4137.

Signed-off-by: Sumana Harihareswara <sh@changeset.nyc>
2020-03-05 20:55:28 -05:00
Tim Hughes 1fcb1b5bc1 [docs] mention variable expansion in .env files
fix #3610
2020-01-15 12:49:14 +00:00
frostming 79a12c35db Add missing blank line in code block 2019-07-15 13:59:17 +08:00
Frost Ming 2f619df5f9 Merge branch master 2019-07-14 15:36:41 +08:00
Doc Developer d503c496b7 Fixes formatting 2019-07-11 21:28:20 +02:00
Doc Developer fca99b4323 Merge branch 'master' into patch-2 2019-07-08 11:45:22 +02:00
Dan Ryan 0e56fef36f Clean up env variable documentation
Signed-off-by: Dan Ryan <dan@danryan.co>
2019-05-27 13:11:36 -04:00
Gilberto Corrêa de Souza 4b108dfd49 change wording for Environment Variables options 2019-05-27 13:04:59 -04:00
Gilberto Corrêa de Souza 3402ed9615 clarified the use of environment variables 2019-05-27 13:04:19 -04:00
Jordan Pittier 788194d749 Doc: advanced.rst: Use "pytest" as the new recommended entrypoint for Pytest
According to https://github.com/pytest-dev/pytest/issues/1629 the recommended
entrypoint for `pytest` is `pytest`. Usage of `py.test` has been deprecated
for 2 years now.
2019-05-27 10:36:02 +02:00
Doc Developer 5782ce06bb Adds info on env variables
Adds info about using quotation marks if credentials contain special characters
2019-05-23 11:38:34 +02:00