MJCruickshank / SARfish

Ship detection in Sentinel 1 Synthetic Aperture Radar (SAR) imagery
MIT License
138 stars 7 forks source link

setup as package #5

Open tacaswell opened 2 years ago

tacaswell commented 2 years ago

Would a PR adding a project.toml (making this a pip-installable package) + entry points + docs + tests be welcome?

This is also the first step in getting this packagable for conda-forge.

meghankane commented 2 years ago

Yes, that would be really cool and appreciated if you have time to do that! 😄

MJCruickshank commented 2 years ago

Seconded - that would be amazing if you aren't too busy!

meghankane commented 2 years ago

and we'll make sure to review it faster next time

giswqs commented 2 years ago

I have a Python Cookiecutter package template that might be useful for this. It has mkdocs-material built in. https://github.com/giswqs/pypackage

Check out my Python packages built using the template:

tacaswell commented 2 years ago

Sorry, I got way busier than I expected. I'll still try to get to this when I have time maybe later this week or next weekend, but will not be upset in the slightest if someone else did it ;)

I was going to start with https://nsls-ii.github.io/scientific-python-cookiecutter/ + some modernizations (gha instead of travis, pyproject.toml instead of setup.py etc)