Getting Started with the Environment

[jtmonroe]

Hello All,

I asked this question in an email directly to the creator, but he suggested this would be a better question for the actual page. What is the setup used for testing and development? As someone who wants to contribute, a "shortest path to starting" would be helpful.

[agronholm]

Was my email answer incomplete somehow? Let me know if you have difficulties with that.

For anyone else reading this, my reply was:

The normal testing procedure is to just do an editable install with testing dependencies (pip install --group test -e .) and then run "pytest". Alternatively you can use "tox" to test against multiple Python versions at once.

[jtmonroe]

My apologies if I gave that impression. No, your email was entirely sufficient, I was working off of the start of your message.

This would have been better sent as a question on GitHub discussions, as I am not the only maintainer of this project.

I supposed that others may benefit from my question, and that you may be been entailing that other maintainers may have important input to my question. Again, my apologies if I entailed that your response was insufficient.

[sheinbergon]

@jtmonroe as the 2nd maintainer, I feel this repo has a pretty straight forward approach when it comes to code contribution. In fact, many users have done so in the past year without any special issues. If you feel something is missing, feel free to open a PR with README.md improvements 😉.