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.

Sign up for GitHub

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

Jump to bottom

Create developer instructions. #57

Closed
2 tasks done
BorjaEst opened this issue Nov 23, 2020 · 4 comments
Closed
2 tasks done

Create developer instructions. #57

BorjaEst opened this issue Nov 23, 2020 · 4 comments
Assignees
@TheChristophe
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@BorjaEst
Copy link
Collaborator

BorjaEst commented Nov 23, 2020 •
edited by TheChristophe
Loading

It would be nice to have some instructions about how to do a dev installation. That way it would be easy to help you. For example:

  • How to install locally (without docker, I recommend setup, to be open in other issue)
  • How to run the unit tests (I would recommend to use tox, probably in other issue)
@BorjaEst BorjaEst added documentation Improvements or additions to documentation enhancement New feature or request labels Nov 23, 2020
@TheChristophe
Copy link
Collaborator

To run the unit tests, you can

  • setup a venv python -m venv venv,
  • enable it . ./venv/bin/activate,
  • install all requirements pip install -r requirements.txt,
  • run the command listed at the bottom of the README.md python -m unittest discover eosc_perf "*_test.py"

I'll add the venv/pip instructions to the README.md.

@TheChristophe TheChristophe self-assigned this Nov 23, 2020
TheChristophe added a commit that referenced this issue Nov 23, 2020
@TheChristophe
Add venv explanation to README.md
f89a0e8 
Related to #57
@TheChristophe
Copy link
Collaborator

I have now added instructions on how to run the tests into the README.md. If we want to migrate running tests to tox, we should create another issue about it.

@BorjaEst
Copy link
Collaborator Author

I can take the start for that.
I run the software and some of the test failed. We can review it on the next meeting and open another issue if needed.

@BorjaEst
Copy link
Collaborator Author

I created a new PR #67, to implement tox. It is quite stable for now and provide test results.
We should review it together before merge it.

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

@TheChristophe TheChristophe

Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@BorjaEst @TheChristophe