-
-
Notifications
You must be signed in to change notification settings - Fork 220
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
Generate dev-requirements.txt
+ improve readme for contributors wanting to run tests
#1224
Generate dev-requirements.txt
+ improve readme for contributors wanting to run tests
#1224
Conversation
@TechnicalPirate About this PR I've been thinking that the best would be if you create a dev-requirements.txt or test-requirements.txt file as I see in other projects (for example in pyzmq), so don't force the developer to use pipenv, and he/she can use whatever he/she wants. |
@marcelotduarte - as you wish, give me 5min to feed the cat and i'll spit out a Does that mean you'd want the |
How will I explain to you. I don't pipenv normally, and don't plan to use it. But I use it in a CI test just to see if cx_Freeze runs some samples. Then I will run the tests you are implementing. With the requirements we can create a Pipfile.... |
I don't know this word nor google translator knows ;-) |
@marcelotduarte - Check now I have:
Hope that helps! As for gubbins - apologies for slang usage - i was referring to the files used by |
dev-requirements.txt
+ improve readme for contributors wanting to run tests
Good! Thanks! |
Problem - Currently the
cx_freeze
project doesn't have arequirements
file nor any dependency management solution - As usage of the product requires theimportlib_metadata
dependency and additional dependencies are required to contribute as a developer (nose
/pygments
) this can be a barrier to contributors.Solution -
This PR contributes a basicThis PR includes apipenv
guide here setupdev-requirements.txt
listing the dependencies required for developers - it also contributes aReadme.md
for the/test/
directory explaining how contributors can execute the tests locallyTLDR:
* Addspipfile
andpipfile.lock
for contributors who usepipenv
dev-requirements.txt
to the project rootreadme.md
to the tests directory.idea
folder to the.gitignore
Note : Discussion here