search

gdcc / pyDataverse

Python module for Dataverse Software (dataverse.org).
http://pydataverse.readthedocs.io/
MIT License
63 stars 43 forks source link

Documentation update #39

Closed j-n-c closed 4 years ago

j-n-c commented 4 years ago

Corrected paths for requirements files Added tox package to test-requirements file Added more detail to installation instructions

skasberger commented 4 years ago

Great, thanks for the PR. This is a great contribution. Here some comments about it:

  1. add tox to test-requirements.txt: The requirements are called by tox, so the installation after it is redundantent. but the installation of tox, as you mentioned in Tromso, must be done before that. I have found my internal notes on how to setup the dev environment (which I thought were already online).
virtualenv --python=/usr/bin/python3 venv
source venv/bin/activate
pip install requests
pip install -e .
pip install tox

  1. virtual env I would reduce the intro to virtual environments to some links for further reading (how to install, which ones are out there) and the basic idea, why we use it for developing or using pyDataverse. The scope of the documentation does not include the environment tools (e.g. how to use pytest, tox, virtualenv, sphinx, travis-ci, coveralls, etc.), but it definitely should make it easy for others to get into that. At least we should provide information about what we use, why we use it and how we use it. There is still lot of documentation missing here.

  2. add tox to external packages I would not do that, because it is only required for development, not for running.

This reminds me, that I should write down the politics and scope of the project and its documentation, so it's easier in the future for others to make contributions. Maybe you are interested in doing it together, @j-n-c ??

j-n-c commented 4 years ago

Hi @skasberger. Thanks for your feedback! Below are some notes on your comments:

  1. add tox to test-requirements.txt: The requirements are called by tox, so the installation after it is redundantent. but the installation of tox, as you mentioned in Tromso, must be done before that. I have found my internal notes on how to setup the dev environment (which I thought were already online).
virtualenv --python=/usr/bin/python3 venv
source venv/bin/activate
pip install requests
pip install -e .
pip install tox

Makes sense. I will change this based on your input. Should I close this PR and crete a new one with the changes or continue with this one? One other thing, since, requirements are installed by tox when testing or generating documentation, then the 

pip install -r deps/tests-requirements.txt
...

entries no longer make sense, right?

  1. virtual env I would reduce the intro to virtual environments to some links for further reading (how to install, which ones are out there) and the basic idea, why we use it for developing or using pyDataverse. The scope of the documentation does not include the environment tools (e.g. how to use pytest, tox, virtualenv, sphinx, travis-ci, coveralls, etc.), but it definitely should make it easy for others to get into that. At least we should provide information about what we use, why we use it and how we use it. There is still lot of documentation missing here.

Ok. I can make the changes regarding the virtual environment setup. Regarding the environment tools, how would You like to proceed? Should we review the documentation sections to come up with with a basic structure and them fill them with detailed data?

  1. add tox to external packages I would not do that, because it is only required for development, not for running.

Makes sense. Will remove it.

This reminds me, that I should write down the politics and scope of the project and its documentation, so it's easier in the future for others to make contributions. Maybe you are interested in doing it together, @j-n-c ??

Sure! How do you propose to proceed?

skasberger commented 4 years ago

So, finally I come to close the PRs (the next release is right in front, and it will be the start to a proper open source project management and a stable software architecture).

One other thing, since, requirements are installed by tox when testing or generating documentation, then the

pip install -r deps/tests-requirements.txt ...

entries no longer make sense, right?

They make sense, cause they will be called by tox commands. But Tox and pyDataverse are already installed, when the different requirement files are called.

This reminds me, that I should write down the politics and scope of the project and its documentation, so it's easier in the future for others to make contributions. Maybe you are interested in doing it together, @j-n-c ??

Sure! How do you propose to proceed?

Cause I did a lot of changes since the last version and the code (including tests and data) are way more mature now, I think it's best to move on, and work in a more organized way from now on. Thanks for your contribution. It started interesting questions and