better document on cvs support in pip
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 10.3k
- Forks
- 3.4k
- Avg merge
- 19h 49m
- Merged PRs (30d)
- 7
Description
I accidentally rushed things too much before and did not look at pip --help as well as I should of. I feel i been complaining about the same thing so I don't want to make a new issue but I feel i should edit my current one and make it better then the old. For clarity I marked what was old. I feel the main issue i am have is the documention on cvs(git svn etc) is not cleanly explaining How i can do bellow.
What's the problem this feature will solve?
old
I trying to do 3 things that as far as I know you can not do with pip
1.) download the source from git(or other) into a dir let say ~/pip-source
2.)prefix all script_entry with a d(d 4 development or other) so the entry point for pip would then be >dpip
3.) when the entry point is run have it automatically update git before executing
while this is still true I did not put down why this is difficult
sbidoul said I should
pip install --src ~pip-source --editable
I am very confused how all this works and the document that you provide are not helping me much.
for example I found from here
https://github.com/pypa/pip/blob/master/docs/html/reference/pip_install.rst
It said
The "project name" component of the URL suffix egg= is used by pip in its dependency logic to identify the project prior to pip downloading and analyzing the metadata. For projects where setup.py is not in the root of project, the "subdirectory" component is used.
What with egg. Egg is an old format I thought we are supposed to use wheel?
Why do we need the "+git+https" prefix can't we have git this from the url?
Is an sdist (source distribution) be installed or the git repostory?
I think a source distrbion is a zip archived of the source is it ?
old
This would allow for easy testing of development version along side stable.
Describe the solution you'd like
new
I think there is a need to expand on the documentation here the current documentation does not make any sense at least to me.
I also wondering if some of this should be moved to a new tool.
old
I Think I done a good explain of this above but i would like to add I would like to help if you deside you would like to implement this i have been playing around with implementing this for fun https://github.com/frog-o/pip/tree/pip-source in the dir fedp(fedp is just a simply python distribution that install a script dpip to launch the devlopment version of pip).
old
I started with fedp(to help me run a devolment version of pip along side the original source) I would like to start and add devloper dependency to setup.py and do other things.
I have many ideas on this if your are interested in helping me.
Alternative Solutions
old
right know the work around was for me to create fedp.
Additional context
old
I would like to edit my https://github.com/frog-o/pip/blob/pip-source/fedp/src/fedp/cli/main.py
from my https://github.com/frog-o/pip/tree/pip-source and read a couple of new values(I would have to create) from setup.py such as dev_config dentry_point and source_dir etc.
My current plan if you think it is worth while is I would like to add an --with-cvs-source to download and install Commands.
Please note: I don't know much about python or git and I am still learning stumbling my way around right now.
Do you guys think this is doable?
Should i continue with my work?
Any commit on my code or things I should do would be welcomed.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with docs/html/reference/pip_install.rst and compare its VCS-installation explanations with pip --help. Clarify the documented behavior and terminology for Git or other VCS URLs, editable installs, source distributions, and wheels; done means a newcomer can understand how to perform the described workflow without relying on the old issue text.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- git, python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100