Create scikit-surgery as placeholder package #14

Closed thompson318 closed 4 years ago

In GitLab by @MattClarkson on Oct 24, 2018, 22:49

Should scikit-surgery be created as a placeholder or root package?

The proposed aim would be that:

pip install scikit-surgery

installs all the other packages like scikit-surgeryimage, scikit-surgerygui etc. So, the scikit-surgery package would probably just be a front page readme, and a bunch of config files like setup.py.

In GitLab by @MattClarkson on Oct 24, 2018, 22:50

changed the description

In GitLab by @ThomasDowrick on Nov 13, 2018, 11:58

Done. I just created a new project called scikit-surgery from PythonTemplate and pushed it to PyPi.

It seems to work, can someone double check @MattClarkson @StephenThompson, ideally in a a clean virtual environment:

pip install scikit-surgery
python -c "from sksurgery.ui import sksurgery_demo; sksurgery_demo.run_demo(True,'Hello')"

It should just print 'Hello' if it works.

I will write up a Wiki page detailing the steps involved.

In GitLab by @StephenThompson on Nov 13, 2018, 12:05

Works for me, thanks.

In GitLab by @MattClarkson on Nov 13, 2018, 12:35

assigned to @ThomasDowrick

In GitLab by @MattClarkson on Nov 13, 2018, 12:39

Cool. Thanks. Before this ticket is closed, can we:

Ensure the gitlab repo is public, and has a reasonably accurate README.rst
Docs are published on readthedocs so that the front page links and badges work
Simple explanation of what we are doing, even if its "Placeholder - image guided surgery platform, more to follow", or similar
Ensure the unittest unit test is removed, so only pytest is running
Ensure that the dummy gui doesnt contribute to coverage
Then presumably, even with nothing else implemented we still need a version number, so call it 0.1.0 or something.

In GitLab by @ThomasDowrick on Nov 13, 2018, 12:40

I've put some instructions in the wiki.

https://weisslab.cs.ucl.ac.uk/WEISS/PlatformManagement/SNAPPY/wikis/pushing-package-to-pypi

I created a 'weiss_ucl' user on PyPI. I will e-mail you both the password.

In GitLab by @MattClarkson on Nov 13, 2018, 12:40

Great. Thanks.

In GitLab by @ThomasDowrick on Nov 13, 2018, 12:41

It is mandatory to have a version number to push to PyPI - for no particular reason it ended up at v0.1.2 after all my playing around. I will address the other points you raised this afternoon.

In GitLab by @MattClarkson on Nov 13, 2018, 12:45

I thought it would be. Im happy to start with whatever version number we end up with, but as a policy we should use semantic versioning.

i.e major = breaking API change minor = additional features, no breaking API change patch = bugfix

This should probably be a reminder in the Python Template aswell. I'll raise a ticket to make it more obvs.

In GitLab by @ThomasDowrick on Nov 13, 2018, 17:05

So I think I've covered all the above. There is a strange issue with the badges/logo not showing properly - not quite sure what that is about. Once/if we get to a 'final' version for PythonTemplate, we can refresh scikit-surgery with a newly generated template.

In GitLab by @MattClarkson on Nov 13, 2018, 21:40

Badges sorted. The repo was miss named, with a missing i. You had sckit instead of scikit, so you will need to reclone. I renamed repo, badges work, CI works and read-the-docs work.

In GitLab by @MattClarkson on Nov 13, 2018, 21:40

closed

SciKit-Surgery / scikit-surgery

Create scikit-surgery as placeholder package #14