From e1bcac42e37cd3ff809b8100047cd68cbb04cbb0 Mon Sep 17 00:00:00 2001 From: Felipe Moreno Date: Mon, 20 May 2024 17:04:31 -0400 Subject: [PATCH 01/13] remove vale config file --- .gitignore | 1 - 1 file changed, 1 deletion(-) diff --git a/.gitignore b/.gitignore index dffa67c9..76f84092 100644 --- a/.gitignore +++ b/.gitignore @@ -8,5 +8,4 @@ __pycache__ *notes-from-review.md *.idea* # Grammar / syntax checkers -.vale.ini styles/ From a8db9a2e23a298879efd7b3a83ecfccdfa9dde72 Mon Sep 17 00:00:00 2001 From: Felipe Moreno Date: Mon, 20 May 2024 17:05:37 -0400 Subject: [PATCH 02/13] add basic vale config file --- .vale.ini | 35 +++++++++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) create mode 100644 .vale.ini diff --git a/.vale.ini b/.vale.ini new file mode 100644 index 00000000..2dc6e24c --- /dev/null +++ b/.vale.ini @@ -0,0 +1,35 @@ +# Configuration file for using Vale in the python-package-guide repository +# +# This file, along with the rules defined in the styles directory (in YAML files), will be need to be updated based on the preferences +# of the editorial team. +# +# Some configuration notes: +# +# 1) Disabling checks on some places +# +# During the initial tests, it is clear that vale rules are too strict. If you decide to adopt the internal rules, checks will need +# to be disabled in some places. This can be done in MarkDown and HTML files by defining sections using: +# to disabled Vale checks after this line +# to enable Vale checks after this line +# +# More details about other ways to disable Vale in parts of file can be found in the config options like IgnoredScopes and IgnoredClasses +# +# In general, for information about the configuration can be found here: https://vale.sh/docs/topics/config + + +# Path to the styles directory, where the style rules are defined +StylesPath = styles + +# Path to a dictionary folders inside the StylesPath config directory (for example styles/sample) +# This folder can have two files, accept.txt and reject.txt, with one word per line +# These words will be used to check for spelling mistakes in addition to the internal Vale dictionary +# see https://vale.sh/docs/topics/vocab/#folder-structure for more details +Vocab = sample + + +# Sections like the one below can be used to enable the style rules for specific file type +# 'Vale' refers to the default style rules inside the tool, other +# 'package-guide-test' refers to the package-guide-test style rules defined in subdirectories of StylesPath + +[*.md] +BasedOnStyles = package-guide-test From 7740a6efb6e713a4ffde3049473d6d2e3df177ed Mon Sep 17 00:00:00 2001 From: Felipe Moreno Date: Mon, 20 May 2024 17:05:58 -0400 Subject: [PATCH 03/13] set up pre-commit to run vale --- .pre-commit-config.yaml | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index e2e97a03..4062032e 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -31,6 +31,11 @@ repos: - id: codespell additional_dependencies: - tomli + + - repo: https://github.com/errata-ai/vale + rev: v3.4.2 + hooks: + - id: vale ci: autofix_prs: false From 72f87c35006b463becddb6b2855081b06350bdad Mon Sep 17 00:00:00 2001 From: Felipe Moreno Date: Wed, 22 May 2024 15:19:20 -0400 Subject: [PATCH 04/13] renamed folder, reworded comments --- .vale.ini | 41 +- .../config/vocabularies/sample/accept.txt | 0 .../config/vocabularies/sample/reject.txt | 0 vale-styles/package-guide-test/PyPI.yml | 21 + vale-styles/write-good/Cliches.yml | 702 ++++++++++++++++++ vale-styles/write-good/E-Prime.yml | 31 + vale-styles/write-good/Illusions.yml | 11 + vale-styles/write-good/Passive.yml | 183 +++++ vale-styles/write-good/README.md | 27 + vale-styles/write-good/So.yml | 5 + vale-styles/write-good/ThereIs.yml | 6 + vale-styles/write-good/TooWordy.yml | 221 ++++++ vale-styles/write-good/Weasel.yml | 207 ++++++ vale-styles/write-good/meta.json | 4 + 14 files changed, 1437 insertions(+), 22 deletions(-) create mode 100644 vale-styles/config/vocabularies/sample/accept.txt create mode 100644 vale-styles/config/vocabularies/sample/reject.txt create mode 100644 vale-styles/package-guide-test/PyPI.yml create mode 100644 vale-styles/write-good/Cliches.yml create mode 100644 vale-styles/write-good/E-Prime.yml create mode 100644 vale-styles/write-good/Illusions.yml create mode 100644 vale-styles/write-good/Passive.yml create mode 100644 vale-styles/write-good/README.md create mode 100644 vale-styles/write-good/So.yml create mode 100644 vale-styles/write-good/ThereIs.yml create mode 100644 vale-styles/write-good/TooWordy.yml create mode 100644 vale-styles/write-good/Weasel.yml create mode 100644 vale-styles/write-good/meta.json diff --git a/.vale.ini b/.vale.ini index 2dc6e24c..c10dccbe 100644 --- a/.vale.ini +++ b/.vale.ini @@ -1,35 +1,32 @@ # Configuration file for using Vale in the python-package-guide repository # -# This file, along with the rules defined in the styles directory (in YAML files), will be need to be updated based on the preferences -# of the editorial team. -# -# Some configuration notes: +# To disable checks on parts of a MarkDown or HTML file, delimit the section +# using these HTML comments: +# to disabled Vale checks after this line: +# to enable Vale checks after this line: # -# 1) Disabling checks on some places +# To disable checks based on MarkDown scope, see IgnoredScopes. +# To disable checks on certain HTML elements, see IgnoredClasses. # -# During the initial tests, it is clear that vale rules are too strict. If you decide to adopt the internal rules, checks will need -# to be disabled in some places. This can be done in MarkDown and HTML files by defining sections using: -# to disabled Vale checks after this line -# to enable Vale checks after this line -# -# More details about other ways to disable Vale in parts of file can be found in the config options like IgnoredScopes and IgnoredClasses -# -# In general, for information about the configuration can be found here: https://vale.sh/docs/topics/config +# More information about the configuration can be found here: +# https://vale.sh/docs/topics/config -# Path to the styles directory, where the style rules are defined -StylesPath = styles +# Path to the styles directory, where style rules are defined +StylesPath = vale-styles -# Path to a dictionary folders inside the StylesPath config directory (for example styles/sample) -# This folder can have two files, accept.txt and reject.txt, with one word per line -# These words will be used to check for spelling mistakes in addition to the internal Vale dictionary -# see https://vale.sh/docs/topics/vocab/#folder-structure for more details +# Path to a dictionary folders inside the StylesPath config subdirectory. This +# folder can contain two files, accept.txt and reject.txt, with one word per +# line. These words will be used to check for spelling mistakes in addition to +# the internal dictionary, if the 'Vale' ruleset is enabled (see below) +# See https://vale.sh/docs/topics/vocab/#folder-structure for more details Vocab = sample -# Sections like the one below can be used to enable the style rules for specific file type -# 'Vale' refers to the default style rules inside the tool, other -# 'package-guide-test' refers to the package-guide-test style rules defined in subdirectories of StylesPath +# Checks are defined in sections by file type, like the one below for +# MarkDown. In each section you can enable groups of style rules, defined in folders +# inside the StylesPath directory. +# Use 'Vale' to enable the internal style rules and checks. [*.md] BasedOnStyles = package-guide-test diff --git a/vale-styles/config/vocabularies/sample/accept.txt b/vale-styles/config/vocabularies/sample/accept.txt new file mode 100644 index 00000000..e69de29b diff --git a/vale-styles/config/vocabularies/sample/reject.txt b/vale-styles/config/vocabularies/sample/reject.txt new file mode 100644 index 00000000..e69de29b diff --git a/vale-styles/package-guide-test/PyPI.yml b/vale-styles/package-guide-test/PyPI.yml new file mode 100644 index 00000000..b17641d9 --- /dev/null +++ b/vale-styles/package-guide-test/PyPI.yml @@ -0,0 +1,21 @@ +extends: substitution +message: Consider using '%s' instead of '%s' +level: warning +ignorecase: false +action: + name: replace +# swap maps tokens in form of bad: good +swap: + - (?:\spypi[\.,]?\s): PyPI # lower case defined as regex to prevent false positives in URLs + - pyPi: PyPI + - pyPI: PyPI + - PYPI: PyPI + - PyPi: PyPI + - Pypi: PyPI + - testPyPI: TestPyPI + - testpypi: TestPyPI + - testPYPI: TestPyPI + - test-pypi: TestPyPI + - TestPypi: TestPyPI + - TestPYPI: TestPyPI + diff --git a/vale-styles/write-good/Cliches.yml b/vale-styles/write-good/Cliches.yml new file mode 100644 index 00000000..c9531438 --- /dev/null +++ b/vale-styles/write-good/Cliches.yml @@ -0,0 +1,702 @@ +extends: existence +message: "Try to avoid using clichés like '%s'." +ignorecase: true +level: warning +tokens: + - a chip off the old block + - a clean slate + - a dark and stormy night + - a far cry + - a fine kettle of fish + - a loose cannon + - a penny saved is a penny earned + - a tough row to hoe + - a word to the wise + - ace in the hole + - acid test + - add insult to injury + - against all odds + - air your dirty laundry + - all fun and games + - all in a day's work + - all talk, no action + - all thumbs + - all your eggs in one basket + - all's fair in love and war + - all's well that ends well + - almighty dollar + - American as apple pie + - an axe to grind + - another day, another dollar + - armed to the teeth + - as luck would have it + - as old as time + - as the crow flies + - at loose ends + - at my wits end + - avoid like the plague + - babe in the woods + - back against the wall + - back in the saddle + - back to square one + - back to the drawing board + - bad to the bone + - badge of honor + - bald faced liar + - ballpark figure + - banging your head against a brick wall + - baptism by fire + - barking up the wrong tree + - bat out of hell + - be all and end all + - beat a dead horse + - beat around the bush + - been there, done that + - beggars can't be choosers + - behind the eight ball + - bend over backwards + - benefit of the doubt + - bent out of shape + - best thing since sliced bread + - bet your bottom dollar + - better half + - better late than never + - better mousetrap + - better safe than sorry + - between a rock and a hard place + - beyond the pale + - bide your time + - big as life + - big cheese + - big fish in a small pond + - big man on campus + - bigger they are the harder they fall + - bird in the hand + - bird's eye view + - birds and the bees + - birds of a feather flock together + - bit the hand that feeds you + - bite the bullet + - bite the dust + - bitten off more than he can chew + - black as coal + - black as pitch + - black as the ace of spades + - blast from the past + - bleeding heart + - blessing in disguise + - blind ambition + - blind as a bat + - blind leading the blind + - blood is thicker than water + - blood sweat and tears + - blow off steam + - blow your own horn + - blushing bride + - boils down to + - bolt from the blue + - bone to pick + - bored stiff + - bored to tears + - bottomless pit + - boys will be boys + - bright and early + - brings home the bacon + - broad across the beam + - broken record + - brought back to reality + - bull by the horns + - bull in a china shop + - burn the midnight oil + - burning question + - burning the candle at both ends + - burst your bubble + - bury the hatchet + - busy as a bee + - by hook or by crook + - call a spade a spade + - called onto the carpet + - calm before the storm + - can of worms + - can't cut the mustard + - can't hold a candle to + - case of mistaken identity + - cat got your tongue + - cat's meow + - caught in the crossfire + - caught red-handed + - checkered past + - chomping at the bit + - cleanliness is next to godliness + - clear as a bell + - clear as mud + - close to the vest + - cock and bull story + - cold shoulder + - come hell or high water + - cool as a cucumber + - cool, calm, and collected + - cost a king's ransom + - count your blessings + - crack of dawn + - crash course + - creature comforts + - cross that bridge when you come to it + - crushing blow + - cry like a baby + - cry me a river + - cry over spilt milk + - crystal clear + - curiosity killed the cat + - cut and dried + - cut through the red tape + - cut to the chase + - cute as a bugs ear + - cute as a button + - cute as a puppy + - cuts to the quick + - dark before the dawn + - day in, day out + - dead as a doornail + - devil is in the details + - dime a dozen + - divide and conquer + - dog and pony show + - dog days + - dog eat dog + - dog tired + - don't burn your bridges + - don't count your chickens + - don't look a gift horse in the mouth + - don't rock the boat + - don't step on anyone's toes + - don't take any wooden nickels + - down and out + - down at the heels + - down in the dumps + - down the hatch + - down to earth + - draw the line + - dressed to kill + - dressed to the nines + - drives me up the wall + - dull as dishwater + - dyed in the wool + - eagle eye + - ear to the ground + - early bird catches the worm + - easier said than done + - easy as pie + - eat your heart out + - eat your words + - eleventh hour + - even the playing field + - every dog has its day + - every fiber of my being + - everything but the kitchen sink + - eye for an eye + - face the music + - facts of life + - fair weather friend + - fall by the wayside + - fan the flames + - feast or famine + - feather your nest + - feathered friends + - few and far between + - fifteen minutes of fame + - filthy vermin + - fine kettle of fish + - fish out of water + - fishing for a compliment + - fit as a fiddle + - fit the bill + - fit to be tied + - flash in the pan + - flat as a pancake + - flip your lid + - flog a dead horse + - fly by night + - fly the coop + - follow your heart + - for all intents and purposes + - for the birds + - for what it's worth + - force of nature + - force to be reckoned with + - forgive and forget + - fox in the henhouse + - free and easy + - free as a bird + - fresh as a daisy + - full steam ahead + - fun in the sun + - garbage in, garbage out + - gentle as a lamb + - get a kick out of + - get a leg up + - get down and dirty + - get the lead out + - get to the bottom of + - get your feet wet + - gets my goat + - gilding the lily + - give and take + - go against the grain + - go at it tooth and nail + - go for broke + - go him one better + - go the extra mile + - go with the flow + - goes without saying + - good as gold + - good deed for the day + - good things come to those who wait + - good time was had by all + - good times were had by all + - greased lightning + - greek to me + - green thumb + - green-eyed monster + - grist for the mill + - growing like a weed + - hair of the dog + - hand to mouth + - happy as a clam + - happy as a lark + - hasn't a clue + - have a nice day + - have high hopes + - have the last laugh + - haven't got a row to hoe + - head honcho + - head over heels + - hear a pin drop + - heard it through the grapevine + - heart's content + - heavy as lead + - hem and haw + - high and dry + - high and mighty + - high as a kite + - hit paydirt + - hold your head up high + - hold your horses + - hold your own + - hold your tongue + - honest as the day is long + - horns of a dilemma + - horse of a different color + - hot under the collar + - hour of need + - I beg to differ + - icing on the cake + - if the shoe fits + - if the shoe were on the other foot + - in a jam + - in a jiffy + - in a nutshell + - in a pig's eye + - in a pinch + - in a word + - in hot water + - in the gutter + - in the nick of time + - in the thick of it + - in your dreams + - it ain't over till the fat lady sings + - it goes without saying + - it takes all kinds + - it takes one to know one + - it's a small world + - it's only a matter of time + - ivory tower + - Jack of all trades + - jockey for position + - jog your memory + - joined at the hip + - judge a book by its cover + - jump down your throat + - jump in with both feet + - jump on the bandwagon + - jump the gun + - jump to conclusions + - just a hop, skip, and a jump + - just the ticket + - justice is blind + - keep a stiff upper lip + - keep an eye on + - keep it simple, stupid + - keep the home fires burning + - keep up with the Joneses + - keep your chin up + - keep your fingers crossed + - kick the bucket + - kick up your heels + - kick your feet up + - kid in a candy store + - kill two birds with one stone + - kiss of death + - knock it out of the park + - knock on wood + - knock your socks off + - know him from Adam + - know the ropes + - know the score + - knuckle down + - knuckle sandwich + - knuckle under + - labor of love + - ladder of success + - land on your feet + - lap of luxury + - last but not least + - last hurrah + - last-ditch effort + - law of the jungle + - law of the land + - lay down the law + - leaps and bounds + - let sleeping dogs lie + - let the cat out of the bag + - let the good times roll + - let your hair down + - let's talk turkey + - letter perfect + - lick your wounds + - lies like a rug + - life's a bitch + - life's a grind + - light at the end of the tunnel + - lighter than a feather + - lighter than air + - like clockwork + - like father like son + - like taking candy from a baby + - like there's no tomorrow + - lion's share + - live and learn + - live and let live + - long and short of it + - long lost love + - look before you leap + - look down your nose + - look what the cat dragged in + - looking a gift horse in the mouth + - looks like death warmed over + - loose cannon + - lose your head + - lose your temper + - loud as a horn + - lounge lizard + - loved and lost + - low man on the totem pole + - luck of the draw + - luck of the Irish + - make hay while the sun shines + - make money hand over fist + - make my day + - make the best of a bad situation + - make the best of it + - make your blood boil + - man of few words + - man's best friend + - mark my words + - meaningful dialogue + - missed the boat on that one + - moment in the sun + - moment of glory + - moment of truth + - money to burn + - more power to you + - more than one way to skin a cat + - movers and shakers + - moving experience + - naked as a jaybird + - naked truth + - neat as a pin + - needle in a haystack + - needless to say + - neither here nor there + - never look back + - never say never + - nip and tuck + - nip it in the bud + - no guts, no glory + - no love lost + - no pain, no gain + - no skin off my back + - no stone unturned + - no time like the present + - no use crying over spilled milk + - nose to the grindstone + - not a hope in hell + - not a minute's peace + - not in my backyard + - not playing with a full deck + - not the end of the world + - not written in stone + - nothing to sneeze at + - nothing ventured nothing gained + - now we're cooking + - off the top of my head + - off the wagon + - off the wall + - old hat + - older and wiser + - older than dirt + - older than Methuselah + - on a roll + - on cloud nine + - on pins and needles + - on the bandwagon + - on the money + - on the nose + - on the rocks + - on the spot + - on the tip of my tongue + - on the wagon + - on thin ice + - once bitten, twice shy + - one bad apple doesn't spoil the bushel + - one born every minute + - one brick short + - one foot in the grave + - one in a million + - one red cent + - only game in town + - open a can of worms + - open and shut case + - open the flood gates + - opportunity doesn't knock twice + - out of pocket + - out of sight, out of mind + - out of the frying pan into the fire + - out of the woods + - out on a limb + - over a barrel + - over the hump + - pain and suffering + - pain in the + - panic button + - par for the course + - part and parcel + - party pooper + - pass the buck + - patience is a virtue + - pay through the nose + - penny pincher + - perfect storm + - pig in a poke + - pile it on + - pillar of the community + - pin your hopes on + - pitter patter of little feet + - plain as day + - plain as the nose on your face + - play by the rules + - play your cards right + - playing the field + - playing with fire + - pleased as punch + - plenty of fish in the sea + - point with pride + - poor as a church mouse + - pot calling the kettle black + - pretty as a picture + - pull a fast one + - pull your punches + - pulling your leg + - pure as the driven snow + - put it in a nutshell + - put one over on you + - put the cart before the horse + - put the pedal to the metal + - put your best foot forward + - put your foot down + - quick as a bunny + - quick as a lick + - quick as a wink + - quick as lightning + - quiet as a dormouse + - rags to riches + - raining buckets + - raining cats and dogs + - rank and file + - rat race + - reap what you sow + - red as a beet + - red herring + - reinvent the wheel + - rich and famous + - rings a bell + - ripe old age + - ripped me off + - rise and shine + - road to hell is paved with good intentions + - rob Peter to pay Paul + - roll over in the grave + - rub the wrong way + - ruled the roost + - running in circles + - sad but true + - sadder but wiser + - salt of the earth + - scared stiff + - scared to death + - sealed with a kiss + - second to none + - see eye to eye + - seen the light + - seize the day + - set the record straight + - set the world on fire + - set your teeth on edge + - sharp as a tack + - shoot for the moon + - shoot the breeze + - shot in the dark + - shoulder to the wheel + - sick as a dog + - sigh of relief + - signed, sealed, and delivered + - sink or swim + - six of one, half a dozen of another + - skating on thin ice + - slept like a log + - slinging mud + - slippery as an eel + - slow as molasses + - smart as a whip + - smooth as a baby's bottom + - sneaking suspicion + - snug as a bug in a rug + - sow wild oats + - spare the rod, spoil the child + - speak of the devil + - spilled the beans + - spinning your wheels + - spitting image of + - spoke with relish + - spread like wildfire + - spring to life + - squeaky wheel gets the grease + - stands out like a sore thumb + - start from scratch + - stick in the mud + - still waters run deep + - stitch in time + - stop and smell the roses + - straight as an arrow + - straw that broke the camel's back + - strong as an ox + - stubborn as a mule + - stuff that dreams are made of + - stuffed shirt + - sweating blood + - sweating bullets + - take a load off + - take one for the team + - take the bait + - take the bull by the horns + - take the plunge + - takes one to know one + - takes two to tango + - the more the merrier + - the real deal + - the real McCoy + - the red carpet treatment + - the same old story + - there is no accounting for taste + - thick as a brick + - thick as thieves + - thin as a rail + - think outside of the box + - third time's the charm + - this day and age + - this hurts me worse than it hurts you + - this point in time + - three sheets to the wind + - through thick and thin + - throw in the towel + - tie one on + - tighter than a drum + - time and time again + - time is of the essence + - tip of the iceberg + - tired but happy + - to coin a phrase + - to each his own + - to make a long story short + - to the best of my knowledge + - toe the line + - tongue in cheek + - too good to be true + - too hot to handle + - too numerous to mention + - touch with a ten foot pole + - tough as nails + - trial and error + - trials and tribulations + - tried and true + - trip down memory lane + - twist of fate + - two cents worth + - two peas in a pod + - ugly as sin + - under the counter + - under the gun + - under the same roof + - under the weather + - until the cows come home + - unvarnished truth + - up the creek + - uphill battle + - upper crust + - upset the applecart + - vain attempt + - vain effort + - vanquish the enemy + - vested interest + - waiting for the other shoe to drop + - wakeup call + - warm welcome + - watch your p's and q's + - watch your tongue + - watching the clock + - water under the bridge + - weather the storm + - weed them out + - week of Sundays + - went belly up + - wet behind the ears + - what goes around comes around + - what you see is what you get + - when it rains, it pours + - when push comes to shove + - when the cat's away + - when the going gets tough, the tough get going + - white as a sheet + - whole ball of wax + - whole hog + - whole nine yards + - wild goose chase + - will wonders never cease? + - wisdom of the ages + - wise as an owl + - wolf at the door + - words fail me + - work like a dog + - world weary + - worst nightmare + - worth its weight in gold + - wrong side of the bed + - yanking your chain + - yappy as a dog + - years young + - you are what you eat + - you can run but you can't hide + - you only live once + - you're the boss + - young and foolish + - young and vibrant diff --git a/vale-styles/write-good/E-Prime.yml b/vale-styles/write-good/E-Prime.yml new file mode 100644 index 00000000..fdc47a0a --- /dev/null +++ b/vale-styles/write-good/E-Prime.yml @@ -0,0 +1,31 @@ +extends: existence +message: "Try to avoid using '%s'." +ignorecase: true +level: suggestion +tokens: + - am + - are + - aren't + - be + - been + - being + - he's + - here's + - here's + - how's + - i'm + - is + - isn't + - she's + - that's + - there's + - they're + - was + - wasn't + - we're + - were + - weren't + - what's + - where's + - who's + - you're diff --git a/vale-styles/write-good/Illusions.yml b/vale-styles/write-good/Illusions.yml new file mode 100644 index 00000000..b4f13218 --- /dev/null +++ b/vale-styles/write-good/Illusions.yml @@ -0,0 +1,11 @@ +extends: repetition +message: "'%s' is repeated!" +level: warning +alpha: true +action: + name: edit + params: + - truncate + - " " +tokens: + - '[^\s]+' diff --git a/vale-styles/write-good/Passive.yml b/vale-styles/write-good/Passive.yml new file mode 100644 index 00000000..f472cb90 --- /dev/null +++ b/vale-styles/write-good/Passive.yml @@ -0,0 +1,183 @@ +extends: existence +message: "'%s' may be passive voice. Use active voice if you can." +ignorecase: true +level: warning +raw: + - \b(am|are|were|being|is|been|was|be)\b\s* +tokens: + - '[\w]+ed' + - awoken + - beat + - become + - been + - begun + - bent + - beset + - bet + - bid + - bidden + - bitten + - bled + - blown + - born + - bought + - bound + - bred + - broadcast + - broken + - brought + - built + - burnt + - burst + - cast + - caught + - chosen + - clung + - come + - cost + - crept + - cut + - dealt + - dived + - done + - drawn + - dreamt + - driven + - drunk + - dug + - eaten + - fallen + - fed + - felt + - fit + - fled + - flown + - flung + - forbidden + - foregone + - forgiven + - forgotten + - forsaken + - fought + - found + - frozen + - given + - gone + - gotten + - ground + - grown + - heard + - held + - hidden + - hit + - hung + - hurt + - kept + - knelt + - knit + - known + - laid + - lain + - leapt + - learnt + - led + - left + - lent + - let + - lighted + - lost + - made + - meant + - met + - misspelt + - mistaken + - mown + - overcome + - overdone + - overtaken + - overthrown + - paid + - pled + - proven + - put + - quit + - read + - rid + - ridden + - risen + - run + - rung + - said + - sat + - sawn + - seen + - sent + - set + - sewn + - shaken + - shaven + - shed + - shod + - shone + - shorn + - shot + - shown + - shrunk + - shut + - slain + - slept + - slid + - slit + - slung + - smitten + - sold + - sought + - sown + - sped + - spent + - spilt + - spit + - split + - spoken + - spread + - sprung + - spun + - stolen + - stood + - stridden + - striven + - struck + - strung + - stuck + - stung + - stunk + - sung + - sunk + - swept + - swollen + - sworn + - swum + - swung + - taken + - taught + - thought + - thrived + - thrown + - thrust + - told + - torn + - trodden + - understood + - upheld + - upset + - wed + - wept + - withheld + - withstood + - woken + - won + - worn + - wound + - woven + - written + - wrung diff --git a/vale-styles/write-good/README.md b/vale-styles/write-good/README.md new file mode 100644 index 00000000..3edcc9b3 --- /dev/null +++ b/vale-styles/write-good/README.md @@ -0,0 +1,27 @@ +Based on [write-good](https://github.com/btford/write-good). + +> Naive linter for English prose for developers who can't write good and wanna learn to do other stuff good too. + +``` +The MIT License (MIT) + +Copyright (c) 2014 Brian Ford + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. +``` diff --git a/vale-styles/write-good/So.yml b/vale-styles/write-good/So.yml new file mode 100644 index 00000000..e57f099d --- /dev/null +++ b/vale-styles/write-good/So.yml @@ -0,0 +1,5 @@ +extends: existence +message: "Don't start a sentence with '%s'." +level: error +raw: + - '(?:[;-]\s)so[\s,]|\bSo[\s,]' diff --git a/vale-styles/write-good/ThereIs.yml b/vale-styles/write-good/ThereIs.yml new file mode 100644 index 00000000..8b82e8f6 --- /dev/null +++ b/vale-styles/write-good/ThereIs.yml @@ -0,0 +1,6 @@ +extends: existence +message: "Don't start a sentence with '%s'." +ignorecase: false +level: error +raw: + - '(?:[;-]\s)There\s(is|are)|\bThere\s(is|are)\b' diff --git a/vale-styles/write-good/TooWordy.yml b/vale-styles/write-good/TooWordy.yml new file mode 100644 index 00000000..275701b1 --- /dev/null +++ b/vale-styles/write-good/TooWordy.yml @@ -0,0 +1,221 @@ +extends: existence +message: "'%s' is too wordy." +ignorecase: true +level: warning +tokens: + - a number of + - abundance + - accede to + - accelerate + - accentuate + - accompany + - accomplish + - accorded + - accrue + - acquiesce + - acquire + - additional + - adjacent to + - adjustment + - admissible + - advantageous + - adversely impact + - advise + - aforementioned + - aggregate + - aircraft + - all of + - all things considered + - alleviate + - allocate + - along the lines of + - already existing + - alternatively + - amazing + - ameliorate + - anticipate + - apparent + - appreciable + - as a matter of fact + - as a means of + - as far as I'm concerned + - as of yet + - as to + - as yet + - ascertain + - assistance + - at the present time + - at this time + - attain + - attributable to + - authorize + - because of the fact that + - belated + - benefit from + - bestow + - by means of + - by virtue of + - by virtue of the fact that + - cease + - close proximity + - commence + - comply with + - concerning + - consequently + - consolidate + - constitutes + - demonstrate + - depart + - designate + - discontinue + - due to the fact that + - each and every + - economical + - eliminate + - elucidate + - employ + - endeavor + - enumerate + - equitable + - equivalent + - evaluate + - evidenced + - exclusively + - expedite + - expend + - expiration + - facilitate + - factual evidence + - feasible + - finalize + - first and foremost + - for all intents and purposes + - for the most part + - for the purpose of + - forfeit + - formulate + - have a tendency to + - honest truth + - however + - if and when + - impacted + - implement + - in a manner of speaking + - in a timely manner + - in a very real sense + - in accordance with + - in addition + - in all likelihood + - in an effort to + - in between + - in excess of + - in lieu of + - in light of the fact that + - in many cases + - in my opinion + - in order to + - in regard to + - in some instances + - in terms of + - in the case of + - in the event that + - in the final analysis + - in the nature of + - in the near future + - in the process of + - inception + - incumbent upon + - indicate + - indication + - initiate + - irregardless + - is applicable to + - is authorized to + - is responsible for + - it is + - it is essential + - it seems that + - it was + - magnitude + - maximum + - methodology + - minimize + - minimum + - modify + - monitor + - multiple + - necessitate + - nevertheless + - not certain + - not many + - not often + - not unless + - not unlike + - notwithstanding + - null and void + - numerous + - objective + - obligate + - obtain + - on the contrary + - on the other hand + - one particular + - optimum + - overall + - owing to the fact that + - participate + - particulars + - pass away + - pertaining to + - point in time + - portion + - possess + - preclude + - previously + - prior to + - prioritize + - procure + - proficiency + - provided that + - purchase + - put simply + - readily apparent + - refer back + - regarding + - relocate + - remainder + - remuneration + - requirement + - reside + - residence + - retain + - satisfy + - shall + - should you wish + - similar to + - solicit + - span across + - strategize + - subsequent + - substantial + - successfully complete + - sufficient + - terminate + - the month of + - the point I am trying to make + - therefore + - time period + - took advantage of + - transmit + - transpire + - type of + - until such time as + - utilization + - utilize + - validate + - various different + - what I mean to say is + - whether or not + - with respect to + - with the exception of + - witnessed diff --git a/vale-styles/write-good/Weasel.yml b/vale-styles/write-good/Weasel.yml new file mode 100644 index 00000000..e2939144 --- /dev/null +++ b/vale-styles/write-good/Weasel.yml @@ -0,0 +1,207 @@ +extends: existence +message: "'%s' is a weasel word!" +ignorecase: true +level: warning +tokens: + - absolutely + - accidentally + - additionally + - allegedly + - alternatively + - angrily + - anxiously + - approximately + - awkwardly + - badly + - barely + - beautifully + - blindly + - boldly + - bravely + - brightly + - briskly + - bristly + - bubbly + - busily + - calmly + - carefully + - carelessly + - cautiously + - cheerfully + - clearly + - closely + - coldly + - completely + - consequently + - correctly + - courageously + - crinkly + - cruelly + - crumbly + - cuddly + - currently + - daily + - daringly + - deadly + - definitely + - deliberately + - doubtfully + - dumbly + - eagerly + - early + - easily + - elegantly + - enormously + - enthusiastically + - equally + - especially + - eventually + - exactly + - exceedingly + - exclusively + - extremely + - fairly + - faithfully + - fatally + - fiercely + - finally + - fondly + - few + - foolishly + - fortunately + - frankly + - frantically + - generously + - gently + - giggly + - gladly + - gracefully + - greedily + - happily + - hardly + - hastily + - healthily + - heartily + - helpfully + - honestly + - hourly + - hungrily + - hurriedly + - immediately + - impatiently + - inadequately + - ingeniously + - innocently + - inquisitively + - interestingly + - irritably + - jiggly + - joyously + - justly + - kindly + - largely + - lately + - lazily + - likely + - literally + - lonely + - loosely + - loudly + - loudly + - luckily + - madly + - many + - mentally + - mildly + - monthly + - mortally + - mostly + - mysteriously + - neatly + - nervously + - nightly + - noisily + - normally + - obediently + - occasionally + - only + - openly + - painfully + - particularly + - patiently + - perfectly + - politely + - poorly + - powerfully + - presumably + - previously + - promptly + - punctually + - quarterly + - quickly + - quietly + - rapidly + - rarely + - really + - recently + - recklessly + - regularly + - remarkably + - relatively + - reluctantly + - repeatedly + - rightfully + - roughly + - rudely + - sadly + - safely + - selfishly + - sensibly + - seriously + - sharply + - shortly + - shyly + - significantly + - silently + - simply + - sleepily + - slowly + - smartly + - smelly + - smoothly + - softly + - solemnly + - sparkly + - speedily + - stealthily + - sternly + - stupidly + - substantially + - successfully + - suddenly + - surprisingly + - suspiciously + - swiftly + - tenderly + - tensely + - thoughtfully + - tightly + - timely + - truthfully + - unexpectedly + - unfortunately + - usually + - very + - victoriously + - violently + - vivaciously + - warmly + - waverly + - weakly + - wearily + - weekly + - wildly + - wisely + - worldly + - wrinkly + - yearly diff --git a/vale-styles/write-good/meta.json b/vale-styles/write-good/meta.json new file mode 100644 index 00000000..a115d288 --- /dev/null +++ b/vale-styles/write-good/meta.json @@ -0,0 +1,4 @@ +{ + "feed": "https://github.com/errata-ai/write-good/releases.atom", + "vale_version": ">=1.0.0" +} From 00b609fc8420b305214d0105005972be309fdf4c Mon Sep 17 00:00:00 2001 From: Felipe Moreno Date: Wed, 22 May 2024 16:00:05 -0400 Subject: [PATCH 05/13] fixed some regexp issues that cause false positives --- vale-styles/package-guide-test/PyPI.yml | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/vale-styles/package-guide-test/PyPI.yml b/vale-styles/package-guide-test/PyPI.yml index b17641d9..3e243456 100644 --- a/vale-styles/package-guide-test/PyPI.yml +++ b/vale-styles/package-guide-test/PyPI.yml @@ -6,16 +6,18 @@ action: name: replace # swap maps tokens in form of bad: good swap: - - (?:\spypi[\.,]?\s): PyPI # lower case defined as regex to prevent false positives in URLs + # lower case defined as regex to prevent false positives in URLs or other identifiers + - (?:\spypi[\.,]?\s): PyPI + - (?:\stestpypi[\.,;:]?\s): TestPyPI + - (?:\stest-pypi[\.,;:]?\s): TestPyPI + # other tests are defined with strings - pyPi: PyPI - pyPI: PyPI - PYPI: PyPI - PyPi: PyPI - Pypi: PyPI - testPyPI: TestPyPI - - testpypi: TestPyPI - testPYPI: TestPyPI - - test-pypi: TestPyPI - TestPypi: TestPyPI - TestPYPI: TestPyPI From 45d1c5f377dd6b8bb54eb2e64da044008e755ec9 Mon Sep 17 00:00:00 2001 From: Felipe Moreno Date: Wed, 22 May 2024 16:00:41 -0400 Subject: [PATCH 06/13] Fixed instances of PyPI with incorrect capitalization --- index.md | 2 +- package-structure-code/publish-python-package-pypi-conda.md | 2 +- .../python-package-distribution-files-sdist-wheel.md | 4 ++-- tutorials/intro.md | 2 +- tutorials/publish-pypi.md | 2 +- 5 files changed, 6 insertions(+), 6 deletions(-) diff --git a/index.md b/index.md index 76384287..26b8bdde 100644 --- a/index.md +++ b/index.md @@ -71,7 +71,7 @@ The first round of our community-developed, how to create a Python package tutor * [What is a Python package?](/tutorials/intro) * [Make your code installable](/tutorials/installable-code) -* [Publish your package to (test) PyPi](/tutorials/publish-pypi) +* [Publish your package to (test) PyPI](/tutorials/publish-pypi) * [Publish your package to conda-forge](/tutorials/publish-conda-forge) ::: diff --git a/package-structure-code/publish-python-package-pypi-conda.md b/package-structure-code/publish-python-package-pypi-conda.md index 62f6fc2e..af1d476d 100644 --- a/package-structure-code/publish-python-package-pypi-conda.md +++ b/package-structure-code/publish-python-package-pypi-conda.md @@ -104,7 +104,7 @@ exist in the default Anaconda cloud channel. :::{figure-md} pypi-conda-channels -Graphic with the title Python package repositories. Below it says Anything hosted on PyPI can be installed using pip install. Packaging hosted on a conda channel can be installed using conda install. Below that there are two rows. the top row says conda channels. next to it are three boxes one with conda-forge, community maintained; bioconda and then default - managed by the anaconda team. Below that there is a row that says PyPI servers. PyPI - anyone can publish to pypi. and test pypi. a testbed server for you to practice. +Graphic with the title Python package repositories. Below it says Anything hosted on PyPI can be installed using pip install. Packaging hosted on a conda channel can be installed using conda install. Below that there are two rows. the top row says conda channels. next to it are three boxes one with conda-forge, community maintained; bioconda and then default - managed by the anaconda team. Below that there is a row that says PyPI servers. PyPI - anyone can publish to PyPI. and test PyPI. a testbed server for you to practice. Conda channels represent various repositories that you can install packages from. Because conda-forge is community maintained, anyone can submit a recipe there. PyPI is also a community maintained repository. Anyone can submit a package to PyPI and test PyPI. Unlike conda-forge there are no manual checks of packages submitted to PyPI. ::: diff --git a/package-structure-code/python-package-distribution-files-sdist-wheel.md b/package-structure-code/python-package-distribution-files-sdist-wheel.md index 923c4106..a7433496 100644 --- a/package-structure-code/python-package-distribution-files-sdist-wheel.md +++ b/package-structure-code/python-package-distribution-files-sdist-wheel.md @@ -91,14 +91,14 @@ represent on your PyPI landing page. These classifiers also allow users to sort ``` :::{figure-md} build-workflow -Graphic showing the high level packaging workflow. On the left you see a graphic with code, metadata and tests in it. those items all go into your package. Documentation and data are below that box because they aren't normally published in your packaging wheel distribution. an arrow to the right takes you to a build distribution files box. that box leads you to either publishing to testpypi or the real pypi. from pypi you can then connect to conda-forge for an automated build that sends distributions from pypi to conda-forge. +Graphic showing the high level packaging workflow. On the left you see a graphic with code, metadata and tests in it. those items all go into your package. Documentation and data are below that box because they aren't normally published in your packaging wheel distribution. an arrow to the right takes you to a build distribution files box. that box leads you to either publishing to TestPyPI or the real PyPO. from PyPI you can then connect to conda-forge for an automated build that sends distributions from PyPI to conda-forge. You need to build your Python package in order to publish it to PyPI (or Conda). The build process organizes your code and metadata into a distribution format that can be uploaded to PyPI and subsequently downloaded and installed by users. NOTE: you need to publish a sdist to PyPI in order for conda-forge to properly build your package automatically. ::: :::{figure-md} -This screenshot shows the metadata on pypi for the xclim package. on it you can see the name of the license, the author and maintainer names keywords associated with the package and the base python version it requires which is 3.8. +This screenshot shows the metadata on PyPI for the xclim package. on it you can see the name of the license, the author and maintainer names keywords associated with the package and the base python version it requires which is 3.8. PyPI screenshot showing metadata for the xclim package. ::: diff --git a/tutorials/intro.md b/tutorials/intro.md index bc470675..acff47fe 100644 --- a/tutorials/intro.md +++ b/tutorials/intro.md @@ -315,7 +315,7 @@ Then you can create a conda-forge recipe using the [Grayskull](https://github.co [You will learn more about the conda-forge publication process here.](publish-conda-forge.md) :::{figure-md} publish-package-pypi-conda-overview -Graphic showing the high level packaging workflow. On the left you see a graphic with code, metadata and tests in it. Those items all go into your package. Documentation and data are below that box because they aren't normally published in your packaging wheel distribution. an arrow to the right takes you to a build distribution files box. that box leads you to either publishing to testPyPI or the real PyPI. From PyPI you can then connect to conda-forge for an automated build that sends distributions from PyPI to conda-forge. +Graphic showing the high level packaging workflow. On the left you see a graphic with code, metadata and tests in it. Those items all go into your package. Documentation and data are below that box because they aren't normally published in your packaging wheel distribution. an arrow to the right takes you to a build distribution files box. that box leads you to either publishing to TestPyPI or the real PyPI. From PyPI you can then connect to conda-forge for an automated build that sends distributions from PyPI to conda-forge. In the image above, you can see the steps associated with publishing your package on PyPI and conda-forge. Note that the distribution files that PyPI requires are the [sdist](#python-source-distribution) and [wheel](#python-wheel) files. Once you are ready to make your code publicly installable, you can publish it on PyPI. Once your code is on PyPI it is straight forward to then publish to conda-forge. You create a recipe using the Grayskull package and then you open a pr in the conda-forge recipe repository. You will learn more about this process in the [conda-forge lesson](/tutorials/publish-conda-forge). diff --git a/tutorials/publish-pypi.md b/tutorials/publish-pypi.md index 544155cf..f1cedbb5 100644 --- a/tutorials/publish-pypi.md +++ b/tutorials/publish-pypi.md @@ -284,7 +284,7 @@ will remember them. ## Install your package from TestPyPI Once your package upload is complete, you can install it from -TestPYPI. You can find the installation instructions on the TestPyPI +TestPyPI. You can find the installation instructions on the TestPyPI landing page for your newly uploaded package. :::{figure-md} testpypi-landing-page From f1c13c0cab53d56347d8ed43a550736fd1330f4d Mon Sep 17 00:00:00 2001 From: Felipe Moreno Date: Wed, 22 May 2024 16:11:55 -0400 Subject: [PATCH 07/13] add vale as a dependency --- pyproject.toml | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/pyproject.toml b/pyproject.toml index 8e050785..150e3bb7 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -21,7 +21,9 @@ dependencies = [ "sphinxext-opengraph", "sphinx-inline-tabs", # for project cards - "matplotlib" + "matplotlib", + # for checking style rules + "vale" ] [tool.hatch.build.targets.wheel] From 7b2166219ad9b1344b8e59baeb21d8110fcb578a Mon Sep 17 00:00:00 2001 From: Felipe Moreno Date: Thu, 23 May 2024 13:40:03 -0400 Subject: [PATCH 08/13] exclude the vale rule folder from codespell pre-commit hook --- .pre-commit-config.yaml | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 4062032e..d19cc866 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -31,7 +31,11 @@ repos: - id: codespell additional_dependencies: - tomli - + exclude: > + (?x)^( + .*vale-styles.* + )$ + - repo: https://github.com/errata-ai/vale rev: v3.4.2 hooks: From 7edd507344b7ebdf251a3aa7c151cd5917c40f2b Mon Sep 17 00:00:00 2001 From: Felipe Moreno Date: Thu, 23 May 2024 13:44:58 -0400 Subject: [PATCH 09/13] remove trailing white space --- vale-styles/package-guide-test/PyPI.yml | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/vale-styles/package-guide-test/PyPI.yml b/vale-styles/package-guide-test/PyPI.yml index 3e243456..e5f6c9b9 100644 --- a/vale-styles/package-guide-test/PyPI.yml +++ b/vale-styles/package-guide-test/PyPI.yml @@ -7,7 +7,7 @@ action: # swap maps tokens in form of bad: good swap: # lower case defined as regex to prevent false positives in URLs or other identifiers - - (?:\spypi[\.,]?\s): PyPI + - (?:\spypi[\.,]?\s): PyPI - (?:\stestpypi[\.,;:]?\s): TestPyPI - (?:\stest-pypi[\.,;:]?\s): TestPyPI # other tests are defined with strings @@ -19,5 +19,4 @@ swap: - testPyPI: TestPyPI - testPYPI: TestPyPI - TestPypi: TestPyPI - - TestPYPI: TestPyPI - + - TestPYPI: TestPyPI \ No newline at end of file From 3d01f597d3fd92e741e5c3985d3ac133b350e12c Mon Sep 17 00:00:00 2001 From: Felipe Moreno Date: Thu, 23 May 2024 14:11:40 -0400 Subject: [PATCH 10/13] exclude vale-styles folder from sphinx book build --- conf.py | 1 + 1 file changed, 1 insertion(+) diff --git a/conf.py b/conf.py index 45569b0c..04007608 100644 --- a/conf.py +++ b/conf.py @@ -135,6 +135,7 @@ "styles/write-good/README.md", "styles/*", ".pytest_cache/README.md", + "vale-styles/*", ] # For sitemap generation From 9bbf90f1d46604bcc14bdbf3f03ac01a6f25d8c6 Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Thu, 23 May 2024 18:21:03 +0000 Subject: [PATCH 11/13] =?UTF-8?q?'[pre-commit.ci=20=F0=9F=A4=96]=20Apply?= =?UTF-8?q?=20code=20format=20tools=20to=20PR'?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .vale.ini | 4 ++-- vale-styles/package-guide-test/PyPI.yml | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/.vale.ini b/.vale.ini index c10dccbe..7002a6d5 100644 --- a/.vale.ini +++ b/.vale.ini @@ -1,7 +1,7 @@ # Configuration file for using Vale in the python-package-guide repository # # To disable checks on parts of a MarkDown or HTML file, delimit the section -# using these HTML comments: +# using these HTML comments: # to disabled Vale checks after this line: # to enable Vale checks after this line: # @@ -26,7 +26,7 @@ Vocab = sample # Checks are defined in sections by file type, like the one below for # MarkDown. In each section you can enable groups of style rules, defined in folders # inside the StylesPath directory. -# Use 'Vale' to enable the internal style rules and checks. +# Use 'Vale' to enable the internal style rules and checks. [*.md] BasedOnStyles = package-guide-test diff --git a/vale-styles/package-guide-test/PyPI.yml b/vale-styles/package-guide-test/PyPI.yml index e5f6c9b9..dc9be658 100644 --- a/vale-styles/package-guide-test/PyPI.yml +++ b/vale-styles/package-guide-test/PyPI.yml @@ -19,4 +19,4 @@ swap: - testPyPI: TestPyPI - testPYPI: TestPyPI - TestPypi: TestPyPI - - TestPYPI: TestPyPI \ No newline at end of file + - TestPYPI: TestPyPI From 477362213890714c460ad934433ec12250379fd4 Mon Sep 17 00:00:00 2001 From: Felipe Moreno Date: Fri, 24 May 2024 09:15:37 -0400 Subject: [PATCH 12/13] moved vale to dev dependency --- pyproject.toml | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/pyproject.toml b/pyproject.toml index 150e3bb7..0ed39dcf 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -22,6 +22,10 @@ dependencies = [ "sphinx-inline-tabs", # for project cards "matplotlib", +] + +[project.optional-dependencies] +dev = [ # for checking style rules "vale" ] From 0602e7ad36bd47147552361ef29264ed74f27e08 Mon Sep 17 00:00:00 2001 From: Leah Wasser Date: Tue, 4 Jun 2024 16:35:11 -0600 Subject: [PATCH 13/13] Update package-structure-code/python-package-distribution-files-sdist-wheel.md --- .../python-package-distribution-files-sdist-wheel.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package-structure-code/python-package-distribution-files-sdist-wheel.md b/package-structure-code/python-package-distribution-files-sdist-wheel.md index a7433496..6ea58e74 100644 --- a/package-structure-code/python-package-distribution-files-sdist-wheel.md +++ b/package-structure-code/python-package-distribution-files-sdist-wheel.md @@ -91,7 +91,7 @@ represent on your PyPI landing page. These classifiers also allow users to sort ``` :::{figure-md} build-workflow -Graphic showing the high level packaging workflow. On the left you see a graphic with code, metadata and tests in it. those items all go into your package. Documentation and data are below that box because they aren't normally published in your packaging wheel distribution. an arrow to the right takes you to a build distribution files box. that box leads you to either publishing to TestPyPI or the real PyPO. from PyPI you can then connect to conda-forge for an automated build that sends distributions from PyPI to conda-forge. +Graphic showing the high level packaging workflow. On the left you see a graphic with code, metadata and tests in it. those items all go into your package. Documentation and data are below that box because they aren't normally published in your packaging wheel distribution. an arrow to the right takes you to a build distribution files box. that box leads you to either publishing to TestPyPI or the real PyPI. from PyPI you can then connect to conda-forge for an automated build that sends distributions from PyPI to conda-forge. You need to build your Python package in order to publish it to PyPI (or Conda). The build process organizes your code and metadata into a distribution format that can be uploaded to PyPI and subsequently downloaded and installed by users. NOTE: you need to publish a sdist to PyPI in order for conda-forge to properly build your package automatically. :::