search

kneasle / wheatley

An AI for Ringing Room that can ring any number of bells to increase the scope of practices.
https://pypi.org/project/wheatley/
MIT License
15 stars 13 forks source link

CompLib substituted methods and private access key #201

Closed ajohnson1 closed 3 years ago

ajohnson1 commented 3 years ago

Please could you update the home page https://pypi.org/project/wheatley/ to explain how to use private compositions and substituted methods with Wheatley.

I see there are some tests: https://github.com/kneasle/wheatley/blob/master/tests/row_generation/test_ComplibCompositionRowGenerator.py but a test for substituted methods would be worthwhile too, as the original method is the title, the substituted method is lower down the page.

There is a concern on CompLib that users might be creating duplicate compositions with different methods on CompLib instead of using the substitutedmethodid feature.

simon-bond commented 3 years ago

This particular genie might already be out of the bottle (I can point to a few Complib users that I reckon are publishing short touches specifically for use with Wheatley), put trying to limit the damage will be helpful.

centreboard commented 3 years ago

@kneasle added better support in #147 for access keys and substituted methods. This should all be released in v0.6.0. There's a note in the change log, but not in the readme or command line help https://github.com/kneasle/wheatley/blob/90e52b6390ea4c1a0c2f37d6be3bc879ac1eeb33/wheatley/main.py#L295

The tests for it were to do with parsing https://github.com/kneasle/wheatley/blob/90e52b6390ea4c1a0c2f37d6be3bc879ac1eeb33/tests/test_parsing.py#L160-L169

kneasle commented 3 years ago

For sure, more examples are always useful - I wasn't sure how many people are still using CLI Wheatley (and furthermore how many people are on the latest version - see #168). Adding these examples would make a good first issue, so if @ajohnson1 or @simon-bond wants to make a first contribution then that'd be cool (and you'd get a shout-out in the next release) - I'm up to my ears in revision so can't spend much time on side projects.

I see no reason for practice touches to be excluded from CompLib - they make the library more complete and don't interfere with searches or slow the site down. We should probably release 0.7.0 actually, since it adds --place-notation which would stop people publishing plain courses of unrung methods. This would also push any README changes to the PyPI page too.