orator icon indicating copy to clipboard operation
orator copied to clipboard

Add setup.py and requirements.txt

Open paladini opened this issue 7 years ago • 6 comments

Another thing that can help developers code some new features for your project is to remove "setup.py" and "requirements.txt" from your .gitignore file. This way we can make changes on the library, install all the dependencies and then test it locally before submitting it as a PR.

paladini avatar May 12 '17 06:05 paladini

Those are not needed since Orator now uses Poet to handle dependency management and packaging.

sdispater avatar May 12 '17 17:05 sdispater

Oh, this sounds nice :) Thanks for the fast answer!

I would like to suggest you to write some documentation on how to use Poet within your project (Orator). Do you need some help with documentation? I've noticed that Orator has a good documentation, but it's far to cover everything it should.

paladini avatar May 13 '17 05:05 paladini

I think I will add a Contributing section to the README to make it more clear.

sdispater avatar May 16 '17 15:05 sdispater

Thank you @sdispater !

paladini avatar May 18 '17 04:05 paladini

The setup.py file is required if we want to install the package from source https://pip.pypa.io/en/stable/reference/pip_install/#vcs-support

psincraian avatar Mar 07 '19 16:03 psincraian

I'm afraid I'd never heard of Poet/Poetry before for Python dependency management (no offence), and I was quite surprised that a Python open source project did not have a requirements.txt file. It took some digging to get a sense of what the dependencies were, and how things hang together. It would be really convenient to have a requirements.txt file that one can just pip install from. I built one and it seems to work well. I can submit a PR if you like.

mohanrohit avatar Apr 04 '20 03:04 mohanrohit