petermr / docanalysis

Semantic analysis of text documents including sentence and paragraph splitting
Apache License 2.0
12 stars 3 forks source link

[WIP] chore: basic linting/formatting/ci #4

Open kjappelbaum opened 2 years ago

kjappelbaum commented 2 years ago

Hi, completely fine if you do not want to merge any of this - it is probably mostly my own preference (except for the things in the setup.py).

Still WIP.

petermr commented 2 years ago

Copied to Shweata (owner) and Ayush, We are currently working on the installation in PyPI. There seems to be a dependency of ScispaCy which needs a venv.

Would you be interested in having a demo on Wed in the Lightning BYOC 5-minutes talks? Or maybe you are full?

On Tue, Feb 8, 2022 at 1:18 PM Kevin Jablonka @.***> wrote:

Hi, completely fine if you do not want to merge any of this - it is probably mostly my own preference (except for the things in the setup.py).

Still WIP.

You can view, comment on, or merge this pull request online at:

https://github.com/petermr/docanalysis/pull/4 Commit Summary

File Changes

(10 files https://github.com/petermr/docanalysis/pull/4/files)

Patch Links:

— Reply to this email directly, view it on GitHub https://github.com/petermr/docanalysis/pull/4, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAFTCS4WK3DS57YW2ALMCD3U2EJ3JANCNFSM5N2OATXA . Triage notifications on the go with GitHub Mobile for iOS https://apps.apple.com/app/apple-store/id1477376905?ct=notification-email&mt=8&pt=524675 or Android https://play.google.com/store/apps/details?id=com.github.android&referrer=utm_campaign%3Dnotification-email%26utm_medium%3Demail%26utm_source%3Dgithub.

You are receiving this because you are subscribed to this thread.Message ID: @.***>

-- Peter Murray-Rust Founder ContentMine.org and Reader Emeritus in Molecular Informatics Dept. Of Chemistry, University of Cambridge, CB2 1EW, UK

ml-evs commented 2 years ago

We certainly have time for a demo! I will also respond to your email.

petermr commented 2 years ago

I thin Ayush has fixed the problems that I mentioned. Shweata is up for the demo (and she has had experience in virtual meetings). Ayush and Shweata will deal with the PR

kjappelbaum commented 2 years ago

Will continue working on the PR later / or we can discuss how much you want to adapt some linting/style/code layout "semi"-standards.

ml-evs commented 2 years ago

One very useful set of tools that @kjappelbaum could share our expertise on would be employing continuous integration (via GitHub actions, for example). I was speaking about this earlier on Gather

petermr commented 2 years ago

We are delighted to have your experience. We believe in testing, linting, PEP-8 and all the other Knights of the Python Table.

At the moment we are concentrated on getting a good demo for Shweata tomorrow, but after that we would be delighted to have your suggestions.

All codes have some, but not enough, docstrings; some but not enough tests; some but not enough examples/tutorials.

All the code is aiming towards argparsing - docanalysis + pygetpapers has the main framework; py4ami has a lot but is probably bloated; pyamiimage has many tests, some examples but not yet CLI.

P.

On Tue, Feb 8, 2022 at 4:56 PM Kevin Jablonka @.***> wrote:

Will continue working on the PR later / or we can discuss how much you want to adapt some linting/style/code layout "semi"-standards.

— Reply to this email directly, view it on GitHub https://github.com/petermr/docanalysis/pull/4#issuecomment-1032841799, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAFTCS6HSTAJMHQ3SNNDGNTU2FDMDANCNFSM5N2OATXA . Triage notifications on the go with GitHub Mobile for iOS https://apps.apple.com/app/apple-store/id1477376905?ct=notification-email&mt=8&pt=524675 or Android https://play.google.com/store/apps/details?id=com.github.android&referrer=utm_campaign%3Dnotification-email%26utm_medium%3Demail%26utm_source%3Dgithub.

You are receiving this because you commented.Message ID: @.***>

-- Peter Murray-Rust Founder ContentMine.org and Reader Emeritus in Molecular Informatics Dept. Of Chemistry, University of Cambridge, CB2 1EW, UK

ml-evs commented 2 years ago

We are delighted to have your experience.

Happy to give a demo tomorrow in one of the breaks. I can make a draft PR to whichever repo you think would be most useful, the test harness could then be used across each of these related packages

ml-evs commented 2 years ago

In fact, I see pygetpapers already uses this, so perhaps just a demo will suffice :)

kjappelbaum commented 2 years ago

one can maybe just use one of the cookiecutters ;) https://github.com/kjappelbaum/cookiecutter-snekpack (a broken fork of charlie's)

petermr commented 2 years ago

Yes, I think Ayush introduced this for pygetpapers a few months back. We haven't done it for all the code yet.

P.

On Tue, Feb 8, 2022 at 5:41 PM Matthew Evans @.***> wrote:

In fact, I see pygetpapers already uses this, so perhaps just a demo will suffice :)

— Reply to this email directly, view it on GitHub https://github.com/petermr/docanalysis/pull/4#issuecomment-1032885615, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAFTCSYDZV5CBD7HA5HQMRDU2FIUTANCNFSM5N2OATXA . Triage notifications on the go with GitHub Mobile for iOS https://apps.apple.com/app/apple-store/id1477376905?ct=notification-email&mt=8&pt=524675 or Android https://play.google.com/store/apps/details?id=com.github.android&referrer=utm_campaign%3Dnotification-email%26utm_medium%3Demail%26utm_source%3Dgithub.

You are receiving this because you commented.Message ID: @.***>

-- Peter Murray-Rust Founder ContentMine.org and Reader Emeritus in Molecular Informatics Dept. Of Chemistry, University of Cambridge, CB2 1EW, UK

petermr commented 2 years ago

Would be happy to see cookiecutters in action. I tried this some months back to try to structure my projects but I didn't know enough Python then.

On Tue, Feb 8, 2022 at 6:09 PM Kevin Jablonka @.***> wrote:

one can maybe just use one of the cookiecutters ;) https://github.com/kjappelbaum/cookiecutter-snekpack (a broken fork of charlie's)

— Reply to this email directly, view it on GitHub https://github.com/petermr/docanalysis/pull/4#issuecomment-1032912219, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAFTCS56RY2RIOTXQD3FZYTU2FL55ANCNFSM5N2OATXA . Triage notifications on the go with GitHub Mobile for iOS https://apps.apple.com/app/apple-store/id1477376905?ct=notification-email&mt=8&pt=524675 or Android https://play.google.com/store/apps/details?id=com.github.android&referrer=utm_campaign%3Dnotification-email%26utm_medium%3Demail%26utm_source%3Dgithub.

You are receiving this because you commented.Message ID: @.***>

-- Peter Murray-Rust Founder ContentMine.org and Reader Emeritus in Molecular Informatics Dept. Of Chemistry, University of Cambridge, CB2 1EW, UK

kjappelbaum commented 2 years ago

Happy to show once (i love https://timothycrosley.com/project-6-cruft for this) - unfortunately was too busy with the breakout rooms and other orga things to join the hacking room today :(