UDST / choicemodels

Python library for discrete choice modeling
https://udst.github.io/choicemodels
BSD 3-Clause "New" or "Revised" License
74 stars 33 forks source link

official release #18

Closed gboeing closed 6 years ago

gboeing commented 6 years ago

Moving this from slack channel conversation to a GitHub issue for tracking. We should release a v0.1 of choicemodels. @smmaurer do you want to verify the current codebase status or make any additional commits to include 0.1? After that, I can package and release on pypi and conda.

Also relevant, we should wait for this pylogit issue to be closed (ie, new release) before we release choicemodels: https://github.com/timothyb0912/pylogit/issues/15

smmaurer commented 6 years ago

I just did some docstring cleanup and set up a placeholder for sphinx documentation. I'll put that together and clean up the README, and then we should be ready for 0.1.

It seems common for projects to host sphinx docs in Github Pages, but perhaps easier and cleaner to host them on readthedocs.io. That way we would only be tracking the source files in git, not the build files. So fewer merge conflicts, cleaner repo, and easier build process. Do you have an opinion here?

Placeholder - http://choicemodels.readthedocs.io/

gboeing commented 6 years ago

I would endorse the readthedocs plan.

waddell commented 6 years ago

I second that motion.

On Thu, Nov 30, 2017 at 5:10 PM, Geoff Boeing notifications@github.com wrote:

I would endorse the readthedocs plan.

— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub https://github.com/UDST/choicemodels/issues/18#issuecomment-348371910, or mute the thread https://github.com/notifications/unsubscribe-auth/AFCBsCYopElfBDqKos6wL4WlbI2qz1Zsks5s71HygaJpZM4Qt2OF .

gboeing commented 6 years ago

I can help tackle code packaging and readthedocs setup when this is ready.

gboeing commented 6 years ago

The latest pylogit has been released, so we should be all ready to proceed.

gboeing commented 6 years ago

@smmaurer if you can confirm docstrings etc are in a reasonable state, I will start the packaging work for release. Would be important to get a 0.1 release out there in light of our related deliverables over the coming month.

smmaurer commented 6 years ago

Everything looks good to me. Go for it!