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

Generate dev-requirements.txt + improve readme for contributors wanting to run tests #1224

Conversation

TechnicalPirate
Copy link
Contributor

@TechnicalPirate TechnicalPirate commented Sep 1, 2021

Problem - Currently the cx_freeze project doesn't have a requirements file nor any dependency management solution - As usage of the product requires the importlib_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 basic pipenv guide here setup This PR includes a dev-requirements.txt listing the dependencies required for developers - it also contributes a Readme.md for the /test/ directory explaining how contributors can execute the tests locally

TLDR:
* Adds pipfile and pipfile.lock for contributors who use pipenv

  • Adds dev-requirements.txt to the project root
  • Adds readme.md to the tests directory
  • Adds an exclude of Pycharms .idea folder to the .gitignore

Note : Discussion here

@marcelotduarte
Copy link
Owner

@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.

@TechnicalPirate
Copy link
Contributor Author

@marcelotduarte - as you wish, give me 5min to feed the cat and i'll spit out a dev-requirements.txt and update this PR :)

Does that mean you'd want the pipenv gubbins removing though? As by leaving it we'd support pipenv users as well out the box :)

@marcelotduarte
Copy link
Owner

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....

@marcelotduarte
Copy link
Owner

gubbins

I don't know this word nor google translator knows ;-)

@TechnicalPirate
Copy link
Contributor Author

TechnicalPirate commented Sep 27, 2021

@marcelotduarte - Check now

I have:

  • generated a dev-requirements.txt from my local venv
  • Added pipenv specific files to .gitignore
  • slightly updated the README.md in the test folder

Hope that helps!

As for gubbins - apologies for slang usage - i was referring to the files used by pipenv ... which have been removed ;) :D

@TechnicalPirate TechnicalPirate changed the title Feature/pipenv dep management and test readme Generate dev-requirements.txt + improve readme for contributors wanting to run tests Sep 27, 2021
@marcelotduarte marcelotduarte merged commit 6db1dd9 into marcelotduarte:main Sep 27, 2021
@marcelotduarte
Copy link
Owner

Good! Thanks!

@TechnicalPirate TechnicalPirate deleted the feature/pipenv_dep_management_and_test_readme branch September 27, 2021 16:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants