Add just enough boilerplate for a working python package

BritishGeologicalSurvey / stratigraph

Network stratigraphy through text mining

GNU Lesser General Public License v3.0

4 stars 0 forks source link

Add just enough boilerplate for a working python package #4

Closed metazool closed 3 years ago

metazool commented 3 years ago

add setup.py to document the package / facilitate build and install https://packaging.python.org/tutorials/packaging-projects/
add an empty __init__.py in the stratigraph directory so it's recognised as a python package
add a stub test that just imports it and passes
Add a Github Action that runs the tests in a pipeline
Also add the LGPL licence boilerplate

metazool commented 3 years ago

Hi @rachelheaven I know you're mostly homeschooling this week but thought you might be interested in this, it is the minimum-necessary configuration to get an installable python package going with its tests running continuously (there isn't anything to test yet but this is for moving existing code here as per #2