Skip to content
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

Update development installation instructions #255

Closed
Roel opened this issue Apr 18, 2020 · 2 comments
Closed

Update development installation instructions #255

Roel opened this issue Apr 18, 2020 · 2 comments
Assignees
Labels
Milestone

Comments

@Roel
Copy link
Member

Roel commented Apr 18, 2020

From the pyOpenSci review:

There is no instructions about how to install the package for development in README file (e.g. prepare the environment: "pip install -r requirements_dev.txt", install the package in the development mode "python setup.py develop", etc)

There are bits and pieces of this information in the docs (in the installation section and the contributing section for example), but this might be hard to find and assemble.

I suggest:

  • adding development installation instructions to the README
  • adding the same instructions in the installation section in the docs
  • add cross-reference between installation section and contributing section, maybe with a bit more info in the latter (regarding the different requirements files etc.)
@Roel Roel added the docs Documentation label Apr 18, 2020
@Roel Roel added this to the v2.0.0 milestone Apr 18, 2020
@stijnvanhoey stijnvanhoey self-assigned this May 28, 2020
@stijnvanhoey
Copy link
Collaborator

stijnvanhoey commented May 28, 2020

Basically, the dev get started boils down to...

Clone repo

git clone [email protected]:DOV-Vlaanderen/pydov.git

Setup a development environment

conda create -n pydov python=3.7
conda activate pydov

or

virtualenv pydov
source pydov/bin/activate | pydov\Scripts\activate

Install dependencies for development

Inside the environment:

pip install -e .[devs]

I would put this in the README and docs installation section and refer to the contirbuting guidelines for more in-depth information. I'm rewriting these guidelines as well to better align.

@stijnvanhoey stijnvanhoey changed the title Add development installation instructions Update development installation instructions May 29, 2020
@Roel
Copy link
Member Author

Roel commented May 29, 2020

Closed in #274

@Roel Roel closed this as completed May 29, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants