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

Installation not documented; couldn't find PyPi package or run tests #49

Open
dmyersturnbull opened this issue May 1, 2020 · 1 comment
Open

Comments

@dmyersturnbull
Copy link

@dmyersturnbull dmyersturnbull commented May 1, 2020

This is an awesome library, thanks @ddbourgin!!

Users might not know the best way to install this package and try it out. (I didn't, so I eventually just copied the source files.)
Neither the readme nor readthedocs have install instructions.

I couldn't find it on PyPi or Anaconda, and there doesn't appear to be a pyproject.toml, setup.cfg, setup.py, or conda recipe.

Moreover, the tests aren't in a standard path like tests/.
This is uncommon and therefore confusion, and it makes it harder to run them.
Edit: I wasn't expecting them under the source, so I initially wrote that I couldn't find them.

I think it would be great to document how to install numpy-ml, and run its tests & see them to clarify the behavior of some of the functions.

There are some great build and CI tools for Python available, which I recently learned how to use effectively. I'm happy to make a pull request if it would be helpful.

@syncrostone
Copy link

@syncrostone syncrostone commented Jun 1, 2020

I'm seconding this -- it would be great if numpy-ml were on PyPi or conda -- then I would feel comfortable including it in my package which I plan to put on PyPi.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
2 participants
You can’t perform that action at this time.