Re: Naming advice - Our World in Data
[email protected] (Boyd Duffee) Tue, 15 Jul 2025 11:49:26 +0100
| Newsgroups | perl.module-authors |
|---|---|
| Message-ID | <CAHUp-WM5nDsT5T_5B2cMV-hxh36+oCA2GV5nVNBJAY9dq+Avkw@mail.gmail.com> |
--00000000000067d3f90639f588b0 Content-Type: text/plain; charset="UTF-8" Thanks for the feedback. It helps to see someone else write it out to see what looks good. I think I'll go with the longer name and start getting WebService::OurWorldInData ready to upload. Oh, and it's Neil's WebService::HackerNews that I stole most of the API code from, having decided to try out HTTP::Tiny instead of Mojo this time. ;) On Tue, 15 Jul 2025 at 11:14, Neil Bowers <[email protected]> wrote: > Hi Boyd, > > I'd go for WebService::OurWorldInData -- you're not going to type the > module name that many times, so I think the longer name is worth it: > > use WebService::OurWorldInData; > my $owid = WebService::OurWorldInData->new(...); > > When it shows up in various places, it will be more obvious what it is. > > Just my 2p. > > Cheers, > Neil > > On 15 Jul 2025 at 11:05 +0100, Boyd Duffee <[email protected]>, wrote: > > Hi all, > > Having no connection to the project but just goaded into it by there only > being a python client to downloading their data, I've written a Perl API > for the "Our World in Data" grapher endpoint at https://ourworldindata.org > > After looking through the maillist archive and given that the python > module for their ETL catalog endpoint is "owid-catalog", I'm thinking that > WebService::Owid or WebService::OWID are the best names for this module (as > mixed caps OWiD is just going to be visually confusing). It's short and > descriptive. > > Which would you find less annoying: all caps, ucfirst? Carolingian > majuscules? > Suggestions for better names welcome. > > Their ETL endpoint is still in beta, but I expect to incorporate that into > the same namespace at a later date. > > thanks, > -- > Boyd Duffee > > And if we put 'user fell out window' every time that happened we'd get > database normalisation warnings from the helpdesk software. - BOFH: "The > trouble with, er, windows installs" > > MAGA is a rehab facility for charlatans and the cancelled > Trump is a moron whose bankruptcy was bailed out by Putin who is now > pulling his strings. > > --00000000000067d3f90639f588b0 Content-Type: text/html; charset="UTF-8" Content-Transfer-Encoding: quoted-printable <div dir=3D"ltr"><div>Thanks for the feedback. It helps to see someone else= write it out to see what looks good. I think I'll go with the longer n= ame and start getting WebService::OurWorldInData ready to upload.<br></div>= <div><br></div><div>Oh, and it's Neil's WebService::HackerNews that= I stole most of the API code from, having decided to try out HTTP::Tiny in= stead of Mojo this time. ;)<br></div></div><br><div class=3D"gmail_quote gm= ail_quote_container"><div dir=3D"ltr" class=3D"gmail_attr">On Tue, 15 Jul 2= 025 at 11:14, Neil Bowers <<a href=3D"mailto:[email protected]">neilb@neil= b.org</a>> wrote:<br></div><blockquote class=3D"gmail_quote" style=3D"ma= rgin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:= 1ex"> <div> <div name=3D"messageBodySection"> <div>Hi Boyd,</div> <div>=C2=A0</div> <div>I'd go for WebService::OurWorldInData -- you're not going to t= ype the module name that many times, so I think the longer name is worth it= :</div> <div>=C2=A0</div> <div>=C2=A0 =C2=A0 use WebService::OurWorldInData;</div> <div>=C2=A0 =C2=A0 my $owid =3D WebService::OurWorldInData->new(...);</d= iv> <div>=C2=A0</div> <div>When it shows up in various places, it will be more obvious what it is= .</div> <div>=C2=A0</div> <div>Just my 2p.</div> <div>=C2=A0</div> <div>Cheers,</div> <div>Neil</div> <div>=C2=A0</div> </div> <div name=3D"messageReplySection">On 15 Jul 2025 at 11:05 +0100, Boyd Duffe= e <<a href=3D"mailto:[email protected]" target=3D"_blank">boyd.duffe= [email protected]</a>>, wrote:<br> <blockquote type=3D"cite"> <div dir=3D"ltr"> <div>Hi all,</div> <div><br></div> <div>Having no connection to the project but just goaded into it by there o= nly being a python client to downloading their data, I've written a Per= l API for the "Our World in Data" grapher endpoint at <a href=3D"= https://ourworldindata.org" target=3D"_blank">https://ourworldindata.org</a= ></div> <div><br></div> <div>After looking through the maillist archive and given that the python m= odule for their ETL catalog endpoint is "owid-catalog", I'm t= hinking that WebService::Owid or WebService::OWID are the best names for th= is module (as mixed caps OWiD is just going to be visually confusing). It&#= 39;s short and descriptive.<br></div> <div><br></div> <div>Which would you find less annoying: all caps, ucfirst? Carolingian maj= uscules?</div> <div>Suggestions for better names welcome.</div> <div><br></div> <div>Their ETL endpoint is still in beta, but I expect to incorporate that = into the same namespace at a later date.</div> <div><br></div> <div>thanks,<br></div> <span class=3D"gmail_signature_prefix">--</span><br> <div dir=3D"ltr" class=3D"gmail_signature"> <div dir=3D"ltr"> <div> <div dir=3D"ltr"> <div>Boyd Duffee</div> <blockquote style=3D"margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204= ,204,204);padding-left:1ex">And if we put 'user fell out window' ev= ery time that happened we'd get database normalisation warnings from th= e helpdesk software. - BOFH: "The trouble with, er, windows installs&q= uot;<br></blockquote> <div><font color=3D"#FFFFFF">MAGA is a rehab facility for charlatans and th= e cancelled</font></div> <div><font color=3D"#FFFFFF">Trump is a moron whose bankruptcy was bailed o= ut by Putin who is now pulling his strings.</font></div> </div> </div> </div> </div> </div> </blockquote> </div> </div> </blockquote></div> --00000000000067d3f90639f588b0--