New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Move Mercurial dependency to pip.txt #3488

Closed
wants to merge 1 commit into
base: master
from

Conversation

Projects
None yet
4 participants
@stsewd
Member

stsewd commented Jan 7, 2018

While replicating #3066 I was getting an error because of mercurial missing, a time ago I do this PR #3358 that add mercurial to the tests dependencies, but it's also required for the main project.

@berkerpeksag

Normally installation of the Mercurial requirement is handled by the system package manager: https://github.com/rtfd/readthedocs-docker-images/blob/454e82e586b04340084055c2be5458dbe7a625f3/Dockerfile#L17

So adding it to the base requirement file may cause a problem on production. Also, looking at https://pypi.org/project/Mercurial/#files I think installing it via pip may require a compiler on some platforms (because it's not a pure Python project)

I'd suggest adding a requirements/dev.txt file or updating the installation document.

@humitos

This comment has been minimized.

Member

humitos commented Feb 15, 2018

I think @berkerpeksag is right.

Because of the points mentioned, I think it's better to update the install docs to mention that mercurial is needed to have some extra features.

It's not an strict requirement (in case you want to contribute) --but if you want to work on something that depends on mercurial you will need to install it. So, adding this to the docs it's the best from my point of view.

@stsewd

This comment has been minimized.

Member

stsewd commented Feb 16, 2018

@humitos I thinking on improve the installation docs with this notes #3614 (comment), probably I will include the mercurial dependency there. Closing this for now.

@stsewd stsewd closed this Feb 16, 2018

@stsewd stsewd deleted the stsewd:move-dependency branch Feb 16, 2018

@stsewd stsewd referenced this pull request Feb 18, 2018

Merged

Improve installation guide #3631

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment