Releases: pyOpenSci/python-package-guide
Releases · pyOpenSci/python-package-guide
pyOpenSci packaging guide v0.4
What's Changed
- Fix: reorganize index structure for users by @lwasser in #188
- Fix: minor edits by @lwasser in #206
- Fix broken stuff 2 (and keep stuff unbroken) by @sneakers-the-rat in #205
- Use
pyproject.toml
, removerequirements.txt
by @sneakers-the-rat in #204 - docs: add ctb as a contributor for code, and review by @allcontributors in #208
- all my requirements gone by @sneakers-the-rat in #207
- docs: add calekochenour as a contributor for code, and review by @allcontributors in #214
- Version specification in main text of
tutorials/pyproject-toml.md
by @sneakers-the-rat in #191 - Fix: update link to coc by @lwasser in #216
- docs: add miguelalizo as a contributor for code, and review by @allcontributors in #219
- Fix: Issue 201 - conda-forge tutorial learning objectives by @miguelalizo in #218
- docs: add nyeshlur as a contributor for code, and review by @allcontributors in #231
- docs: add Tyler-Bonnell as a contributor for code, and review by @allcontributors in #233
- docs: add ptressel as a contributor for code, and review by @allcontributors in #235
- update: hatch tutorial by @ucodery in #217
- Update installable-code.md by @nyeshlur in #230
- Update installable-code.md by @nyeshlur in #220
- Update publish-conda-forge.md to fix tiny typo by @ptressel in #225
- Update publish-pypi.md to remove near-duplicate line. by @ptressel in #223
- Update intro.md: Remove Duplicate Link/Sentence by @Tyler-Bonnell in #221
- Update text to reflect modern Hatch by @ofek in #241
- Add: text on Hatch backend compatibility by @ucodery in #228
- More consistent LICENSE and CODE_OF_CONDUCT usage by @ptressel in #234
- Add: changelog-file.md to the Docs-for-Contributors-and-Maintainers section. by @miguelalizo in #222
- Update publish-pypi.md with consistent usage for "test PyPI". by @ptressel in #224
- Add: Tutorial for migrating from setup.py to pyproject.toml using Hatch by @miguelalizo in #229
- Update get-to-know-hatch.md for consistent style of "Hatch" etc. by @ptressel in #227
- API Documentation Tutorial: Fix a few typos and clean up punctuation by @Tyler-Bonnell in #242
- Include missed update step pyproject.toml by @Tyler-Bonnell in #243
- Fix: sphinx warnings by @lwasser in #246
- [pre-commit.ci] pre-commit autoupdate by @pre-commit-ci in #245
- docs: add ucodery as a contributor for code, review, and 2 more by @allcontributors in #251
- literalinclude directives by @ucodery in #239
- update version from 0.1.0 to 0.1 by @pb-413 in #262
- docs: add kenseehart as a contributor for code, and review by @allcontributors in #283
- docs: add ryanskeith as a contributor for code, and review by @allcontributors in #284
- Update version references in tutorial: 0.1.0 -> 0.1 by @pb-413 in #279
- docs: add pb-413 as a contributor for code, and review by @allcontributors in #285
- docs: add sosey as a contributor for code, and review by @allcontributors in #286
- docs: add BSuperbad as a contributor for code, and review by @allcontributors in #288
- Add command line example for finding hatch config file location by @sosey in #256
- Fixing Table of Contents/ Nav by @BSuperbad in #266
- docs: add chenghlee as a contributor for code, and review by @allcontributors in #289
- docs: add Vaunty as a contributor for code, and review by @allcontributors in #290
- Replace usage of "Anaconda Cloud" in various contexts by @chenghlee in #269
- Update github actions versions to current by @sosey in #277
- Unique package name - Corrective action steps by @pb-413 in #280
- use literalinclude in code-style-linting-format by @ucodery in #259
- Add: hatch plus meson-python python package example to guidebook by @ucodery in #274
- docs: add flpm as a contributor for review by @allcontributors in #291
- docs: add zackw as a contributor for review by @allcontributors in #292
- docs: add sn3hay as a contributor for code, and review by @allcontributors in #295
- Setup Vale (prose linter) with a minimal unobtrusive configuration by @flpm in #281
- [pre-commit.ci] pre-commit autoupdate by @pre-commit-ci in #294
- Change formatting to satisfy codespell check by @willingc in #296
- Add: help wanted automated workflow to guidebook repo by @lwasser in #297
- Always use
python -m
with pip by @jhkennedy in #300 - Update diagram -hatch backends by @lwasser in #302
- docs: add stefanor as a contributor for review by @allcontributors in #303
- docs: add stefmolin as a contributor for code, and review by @allcontributors in #306
- Mention that the code of conduct has placeholder values by @stefmolin in #305
- docs: add WeepingClown13 as a contributor for review by @allcontributors in #307
- Add support for internationalization to the guide by @flpm in #298
- Add a translation guide for contributors by @flpm in #304
- Start spanish translation by @flpm in #309
- [pre-commit.ci] pre-commit autoupdate by @pre-commit-ci in #312
- [Tuesday july 2 merge] Fix: update hatch install instructions by @lwasser in #308
- Structure the CONTRIBUTING guide to define sprint tasks by @flpm in #311
- Prepare translation files for SciPy sprint by @flpm in #314
- docs: add choldgraf as a contributor for code, and review by @allcontributors in #315
- docs: add npch as a contributor for review by @allcontributors in #316
- update badges url by @sneakers-the-rat in #318
- docs: add RobPasMue as a contributor for code, and review by @allcontributors in #344
- docs: add yardasol as a contributor for code, and review by @allcontributors in #345
- docs: add ayhanxian as a contributor for code, and review by @allcontributors in #346
- docs: add hpodzorski-USGS as a contributor for code, and review by @allcontributors in #347
- docs: add ncclementi as a contributor for code, and review by @allcontributors in #348
...
pyOpenSci packaging guide release v0.3
This release contains
- New tutorials on creating a python package (using hatch) for beginners!
- Updated and enhanced content around packaging / edits from the community
- Lots of new contributors
What's Changed
- Fix links by @hugovk in #166
- Fix: readme file updates by @lwasser in #168
- Fix: logo on readme by @lwasser in #169
- ENH: Publish your python package to PyPI by @lwasser in #164
- docs: add ofek as a contributor for tutorial by @allcontributors in #170
- Fix: missing link to publish pypi lesson in current landing page by @lwasser in #172
- docs: add JacksonBurns as a contributor for code, review, and tutorial by @allcontributors in #179
- Fix: typos throughout the packaging build page and add targets to docs by @lwasser in #180
- Fix: use hatch for workflow by @lwasser in #178
- docs: add jaimergp as a contributor for code, review, and tutorial by @allcontributors in #182
- docs: add h-vetinari as a contributor for code, review, and tutorial by @allcontributors in #183
- Add: readme file tutorial to packaging 101 series by @lwasser in #176
- Add: conda-forge publication tutorials by @lwasser in #177
- Fix: nav for tutorials duplicated by @lwasser in #184
- docs: add xmnlab as a contributor for code, review, and tutorial by @allcontributors in #186
- Fix typo of duplicate lines by @eriknw in #185
- Fix: multiple broken links by @lwasser in #187
- Final series lessons - pyproject, code of conduct & license files by @lwasser in #181
- Concise headings in
tutorials/pyproject-toml.md
by @sneakers-the-rat in #190 - Fix broken stuff by @sneakers-the-rat in #192
- Fix: inconsistent headings by @lwasser in #194
- docs: add tomalrussell as a contributor for code, review, and tutorial by @allcontributors in #196
- Close markdown block for example README by @tomalrussell in #195
- Fix: small edits to headers of lesson by @lwasser in #198
- Description/Author formatting in
tutorials/pyproject-toml.md
by @sneakers-the-rat in #193 - UPDATE: added new contributors by @kierisi in #199
- UPDATE: added Carol to contributors by @kierisi in #200
- FIX: removed duplicates by @kierisi in #203
New Contributors
- @eriknw made their first contribution in #185
- @tomalrussell made their first contribution in #195
- @kierisi made their first contribution in #199
Full Changelog: v0.2...v0.3
v0.2 Tests chapter added and 2 tutorials
What's Changed
- Move ci to update monthly and add to the bottom of the file by @lwasser in #73
- [pre-commit.ci] pre-commit autoupdate by @pre-commit-ci in #75
- Add: typing section to docstring page in guide by @lwasser in #76
- Update intro.md by @kwinkunks in #68
- docs: add kwinkunks as a contributor for code, and review by @allcontributors in #77
- docs: add jezdez as a contributor for code, and review by @allcontributors in #78
- docs: add dhirschfeld as a contributor for review by @allcontributors in #79
- Add: update logo and decision tree diagram by @lwasser in #80
- docs: add ucodery as a contributor for code, and review by @allcontributors in #84
- some user-documentation improvements by @ucodery in #81
- Fix: edits to the packaging section of the guide ✨ by @ucodery in #82
- docs: add abravalheri as a contributor for code, and design by @allcontributors in #86
- docs: add dpprdan as a contributor for code, and review by @allcontributors in #87
- fix: typos by @dpprdan in #85
- Fix: link to peer review in header and update diagram by @lwasser in #88
- [pre-commit.ci] pre-commit autoupdate by @pre-commit-ci in #89
- docs: add yang-ruoxi as a contributor for code, and review by @allcontributors in #92
- Update conf.py file to reduce the number of items in the top header of our guide - fix for safari. by @yang-ruoxi in #91
- Add: package versionioning, pypi / conda publishing & code format pre-commit pages (Reviews Welcome!) by @lwasser in #27
- Fix: broken navigation by @lwasser in #94
- Remove duplicated instructions by @ocefpaf in #93
- docs: Add ruff section in code style page by @Batalex in #95
- docs: add arianesasso as a contributor for code, and review by @allcontributors in #98
- docs: add isabelizimm as a contributor for code, and review by @allcontributors in #99
- docs: add namurphy as a contributor for code, and review by @allcontributors in #100
- package name consistency by @ucodery in #102
- Fix: general cleanup of syntax, sphinx warnings by @lwasser in #103
- docs: add Zeitsperre as a contributor for code, and review by @allcontributors in #107
- docs: add merwok as a contributor for code, and review by @allcontributors in #108
- Add build clarification to package guide by @lwasser in #101
- Fix: broken links and add alt tags by @lwasser in #114
- Minor spelling fix by @lwasser in #113
- [pre-commit.ci] pre-commit autoupdate by @pre-commit-ci in #112
- docs: add kcranston as a contributor for code, and review by @allcontributors in #116
- Fix: styles adjustment to match pyos branding by @lwasser in #118
- Small readme title fix by @lwasser in #119
- Fix: cleanup of existing pages as we create tutorials by @lwasser in #121
- Enh: Remove Google Tag by @sneakers-the-rat in #124
- [CSS] Increase dark mode contrast to meet WCAG requirements and other dark mode things by @sneakers-the-rat in #122
- [CSS] Local fonts, working fonts! by @sneakers-the-rat in #123
- docs: add jhkennedy as a contributor for code, and review by @allcontributors in #125
- docs: add ucodery as a contributor for tutorial by @allcontributors in #126
- Fix: invalid json in contribs file by @lwasser in #128
- docs: add inessapawson as a contributor for code, review, and tutorial by @allcontributors in #129
- docs: add billbrod as a contributor for tutorial by @allcontributors in #130
- docs: add kierisi as a contributor for tutorial by @allcontributors in #131
- docs: add NickleDave as a contributor for tutorial by @allcontributors in #132
- docs: add mknorps as a contributor for code, and review by @allcontributors in #133
- Add: dependency page to guide by @lwasser in #106
- docs: add flying-sheep as a contributor for code, and review by @allcontributors in #137
- Enh: Redesign of packaging guide landing page by @lwasser in #140
- Enh: Tests content - about, write tests, types of tests by @lwasser in #136
- [review-round-2 - Jan 3 merge] What is a Python package intro tutorial? by @lwasser in #139
- Fix: fix overwritten card edits by @lwasser in #142
- Fix: more styles fixes by @lwasser in #143
- Fix: sitemap baseurl by @lwasser in #147
- Fix: sitemap url is wrong by @lwasser in #148
- Fix: a few fixes to support the new theme and also updated cards by @lwasser in #150
- Fix: update homepage nav by @lwasser in #151
- docs: add Midnighter as a contributor for code, and tutorial by @allcontributors in #154
- Fix: book redirect build needs secret by @lwasser in #156
- Fix: redirect still has incorrect info by @lwasser in #157
- Fix: circle ci redirect build by @lwasser in #158
- ENH: Tutorial - Python Packaging - How to make your code installable by @lwasser in #144
- Fix: minor fixes in install code lesson by @lwasser in #159
- Fix: social cards broken by @lwasser in #160
- Fix: try to fix cards and also update contrib file by @lwasser in #162
- Fix: update project name and make year automated by @lwasser in #163
- Enh: Add tests pages - run tests in ci and locally to guide by @lwasser in #145
- Fix: update zenodo file for new release by @lwasser in #146
New Contributors
- @pre-commit-ci made their first contribution in #75
- @kwinkunks made their first contribution in #68
- @ucodery made their first contribution in #81
- @dpprdan made their first contribution in #85
- @yang-ruoxi made their first contribution in #91
- @ocefpaf made their first contribution in #93
- @Batalex made their first contribution in #95
- @sneakers-the-rat made their first contribution in #124
Full Changelog: v0.1...v0.2
v0.1 Updated packaging guide chapter
This release adds the first part of the packaging chapter to the guide. It also updates the authorship list to include everyone that has provided feedback.
What's Changed
- add infra to build sphinx book by @lwasser in #1
- Update contributing and readme and add circle ci by @lwasser in #7
- CONTENT: documentation text and styles by @lwasser in #6
- Fix: HTML PROOFER? 😭 by @lwasser in #2
- ADD: Update package theme to furo and add sitemap and opengraph by @lwasser in #13
- Review 2 (reviews open): Add: documentation section to package guide by @lwasser in #19
- Add: precommit hooks and clean up all files by @lwasser in #43
- Fix: move book to pydata_sphinx_theme by @lwasser in #45
- Add: matomo to guide by @lwasser in #56
- (Review 2 - complete) Packaging section - part 2 by @lwasser in #55
- Fix image as fonts are working with svg by @lwasser in #60
- Fix: ordered list on complex package page by @lwasser in #62
- A11y: Use PyData Theme's Sphinx Design Components to fix dark mode contrast by @hugovk in #61
- fix: incorrect backend key by @henryiii in #64
- fix: incorrect license specification by @henryiii in #65
- Add: zenodo file to repo for citation by @lwasser in #20
New Contributors
Most of the contributors in this PR as comments and edits were new !!
Full Changelog: v0.0...v0.1
Initial release to trigger zenodo
v0.0 Add contributing file