[Distutils] org-mode README file formats

2018-05-07 Thread Diane Trout
Hi, I was building a package where I had a README.org file, which setuptools couldn't find. It listed .md as a valid format, so I was wondering if org-mode was sufficiently plain text to be added to the list of accepted README file formats? For what it's worth, github-markup can handle .org

[Distutils] Re: requirements.txt or not requirements.txt?

2018-05-07 Thread Carles Sala Cladellas
Hi! Thanks for all the useful responses! I am basically working on libraries that will be distributed on PyPi, such as https://github.com/HDI-Project/BTB/ and https://github.com/HDI-Project/ATM/ (Auto Machine Learning and Model Tuning libraries developed by Data to AI lab, in MIT). It looks

[Distutils] Re: requirements.txt or not requirements.txt?

2018-05-07 Thread Alessandro Dentella
On Mon, May 07, 2018 at 11:33:44AM +0300, Marius Gedminas wrote: > On Mon, May 07, 2018 at 08:48:23AM +0200, Carles Sala Cladellas wrote: > > Hello here! > > > > TL;DR: Should I use requirements.txt, or should I have my dependencies only > > listed inside setup.py? > > Short answer: only setup.py,

[Distutils] Re: requirements.txt or not requirements.txt?

2018-05-07 Thread Marius Gedminas
On Mon, May 07, 2018 at 08:48:23AM +0200, Carles Sala Cladellas wrote: > Hello here! > > TL;DR: Should I use requirements.txt, or should I have my dependencies only > listed inside setup.py? Short answer: only setup.py, unless you find a reason to also use a requirements.txt. Long answer:

[Distutils] Re: requirements.txt or not requirements.txt?

2018-05-07 Thread Thomas Kluyver
The recommendation is typically: setup.py for libraries, requirements.txt for applications. But you may also use requirements.txt for specific tasks associated with a library, like building the docs. Donald wrote a blog post which better explains what these two formats

[Distutils] Re: requirements.txt or not requirements.txt?

2018-05-07 Thread Steve Piercy - Website Builder
On 5/7/18 at 8:48 AM, car...@pythiac.com (Carles Sala Cladellas) pronounced: But then I came across this, https://stackoverflow.com/a/28842733, which recommends using a `dev` entry in `extras_require` and then using `pip install -e .[dev]` to install them, which could be easily extended to also

[Distutils] Re: requirements.txt or not requirements.txt?

2018-05-07 Thread Chris Jerdonek
What kind of project is it? For example, is it a software library e.g. to put on PyPI, or a website application for a company to run? The answer to this question will help people answer your question because it has a big impact on what practice will be best for you. —Chris On Sun, May 6, 2018 at

[Distutils] requirements.txt or not requirements.txt?

2018-05-07 Thread Carles Sala Cladellas
Hello here! TL;DR: Should I use requirements.txt, or should I have my dependencies only listed inside setup.py? Long version: The two most common ways to have dependencies listed in a python package are either having them listed both in setup.py and requirements.txt files, or having them only