package for pip install

[campey]

https://packaging.python.org/en/latest/tutorials/packaging-projects/

this will involve

1. thinking through package/module structure, with an eye on KISS (keep it simple, stupid), at the level of e.g. import fudo still working
2. Actually doing the dance and getting it into PyPI

[james-smith-za]

So my proposal, as discussed yesterday, would be to structure the module with a src layout. So something like this:

└── turtle-translated
  ├── CHANGELOG
  ├── LICENSE
  ├── README.md
  ├── src
  │   ├── fudo
  │   │   ├── fudo.py
  │   │   └── __init__.py
  │   └── fudu
  │       ├── fudu.py
  │       └── __init__.py
...
...

You'd need a setup.cfg with something like this:

[options]
packages = find:
package_dir =
    =src

There would be a few more tweaks and adjustments that would be needed but the above I think more or less captures it. Then you'd be able to do

pip install turtle-translated

(eventually, anyway, once we get it to PyPI)
and that should make each of the individual packages available, so the student would be able to

>>> import fudo

[The above is subject to testing, I've not actually tried it, just a quick glance through documentation.]

@campey I may or may not get something working during today, but there will definitely be a PR ready for you to look at within a few days.

That will solve the first of your points, for point two there would need to be a bit more logistics - do you have an account on PyPI? I need to go through the process for listing one of our own modules, so I'll be able to share a HOWTO soon enough.

[james-smith-za]

So there's a bit more clean-up that I'd like to do before I'd be comfortable to put this on PyPI, the main one being to find a better way to introduce new languages than copy-paste-search-replace.

My current thinking is to do something like:

import turtle

class Fudo(Turtle):
    def phambili(self, distance):  # though we should probably translate `distance` too!
        super().forward(distance)

Including docstrings of course, I just think it'll be much neater and cleaner this way.

The other major thing being the licencing, I'd just want to make sure that we are compatible with whatever the original code is licenced under.

@campey if you want, I am happy to manage the process, just give me the go-ahead.

[campey]

Agreed this ideally would have #2 implemented before we ship it.

I'll continue the discussion of what we do "best" in there, but in essence 100% happy for you to run with this, it will move us forward.
"the perfect is the enemy of the good" "done is better than perfect"

[james-smith-za]

Great! I can't promise a time-line, though I may get to do some work on it during the December break.

Can you add me as a collaborator to this repo? Once we're ready to release I'll create a project on PyPI, and if you've got an account there I can add you as an owner as well.

[campey]

Running pip . successfully installs, thanks @james-smith-za .

Set up my PyPI account, auth'd but ran into a file format issue when trying to upload with twine following the packaging notes here: https://packaging.python.org/en/latest/tutorials/packaging-projects/

But, I wasn't using the pyproject.toml they reference there rather the setuptools setup.cfg as it is in the repo. Also I was getting an egg not a wheel, so, better luck next time maybe. I'll go back and see if I missed something.