Commit Graph

28 Commits

Author SHA1 Message Date
Thiago Gariani 9b2e0d41a8 5881-Full conversion from rst to md (#5909)
* add the files from rst -> md
2023-09-05 21:19:27 -04:00
chrysle 2b94966ffc Improved contributing guide (#5611)
* Improved contributing guide

* Added news entry
2023-02-14 23:07:44 +01:00
Artur f7e5a03758 fixed broken link to non-existing philosophy subpage 2022-12-07 11:34:38 +01:00
Micah Smith 932e98637a Fix rst in contributing guide 2022-10-25 10:55:21 -04:00
Michał Wiśniewski 2431e0d19a Add missing backtick in the contributing documentation. (#5410) 2022-10-16 07:59:12 -04: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
Oz N Tiram 37db0234df Add some documentation on how to run tests locally. 2022-07-27 06:52: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
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
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
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
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
Paul Crowley 7c282aea62 Replace docs.pipenv.org with pipenv.pypa.io
`dig pipenv.org ns` currently shows no nameserver for that domain;
pipenv.pypa.io is the new home for documentation, so use that
everywhere (contributors guides, `pipenv --envs` output).
2020-03-28 06:06:02 -07: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
Frost Ming 2f619df5f9 Merge branch master 2019-07-14 15:36:41 +08:00
Dan Ryan 1adb502b18 Update test runner code and contribution guide
Signed-off-by: Dan Ryan <dan@danryan.co>
2019-06-03 22:01:09 -04:00
Brianna Laugher 0798091d15 Consolidate all contributing docs in the rst file 2018-11-22 09:08:46 +08:00
Jeremy Carroll 735119e63b Added run-tests.bat as alternative to run-tests.sh 2018-10-30 10:52:48 -04:00
Jeremy Carroll d923a58ca7 Correction from PR comment 2018-10-30 10:52:48 -04:00
Jeremy Carroll dd8c61addb More specific comment about PIP_FIND_LINKS 2018-10-30 10:52:48 -04:00
Jeremy Carroll 167c417183 Documenting how I got the tests to run 2018-10-30 10:52:48 -04:00
Reinout van Rees 08cfe3fe5f Fixed link to the "be cordial" essay in the contribution doc. 2018-08-29 15:46:36 +02:00
Tzu-ping Chung 4fb6cc3631 Installation documentation updates
Removed ppa mentions from documentation, and re-organised the page a bit
to make it structurally easier to upderstand.

Both the documentation's front page and README.rst now actively refer to
the page so user can be directed to better installation methods. (I
don't think this is very useful TBT because people don't use manuals,
but we should still do it.)

Also fixed many Sphinx warnings during documentation builds.
2018-07-11 13:45:37 +08:00
Charles Lai b1a9b03913 Change Github Pull Pipenv to Github Pull Requests in contributing.rst 2018-07-09 00:08:07 -07:00
Nate Prewitt 968223448a adding contribution docs and guidelines to Pipenv 2018-05-16 08:44:52 -07:00