Publish the package on PyPI

alan-turing-institute / learning-machines-drift

A Python package for monitoring dataset drift in secure environments

4 stars 2 forks source link

Publish the package on PyPI #33

Open sgreenbury opened 1 year ago

sgreenbury commented 1 year ago

[ ] Identify requirements for publishing the package

Initial thoughts:

Complete missing docstrings ("TODO PEP257"). Do we have a docstring style we're using?
Formal documentation for API (e.g. sphinx)
New repo to remove data from previous commits
Distinct examples for demostrating the package

jsteyn commented 1 year ago

Some Notes:

PEP 427 describes how wheels should be packaged. PEP 440 describes how version numbers should be parsed. PEP 508 describes how dependencies should be specified. PEP 517 describes how a build backend should work. PEP 518 describes how a build system should be specified. PEP 621 describes how project metadata should be written. PEP 660 describes how editable installs should be performed.

jsteyn commented 1 year ago

Preparation:

(Taken from https://realpython.com/pypi-publish-python-package/)

[x] Name Your Package: learning-machines-drift
[ ] Configure Your Package
[ ] Specify Your Package Dependencies
[ ] Document Your Package
[ ] Test Your Package
[ ] Version Your Package
[ ] Add Resource Files to Your Package
[x] License Your Package
[ ] Install Your Package Locally

sgreenbury commented 1 year ago

Adding the remaining docs tasks from #35 here:

[ ] Make docstrings consistent across repo (e.g. tag should be defined in the same way across methods)
[ ] Check formatting of variables and hyperlinks are correct in the make html build
[ ] Check no warnings remain

sgreenbury commented 1 year ago

[ ] Description for SciPy KS test