docs: update and refine README.md#47
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates Chartly’s documentation and onboarding material, but also introduces functional changes to the plotting API (Basemap support and new Chart convenience methods) alongside dependency/version updates.
Changes:
- Refreshes
README.mdwith restructured usage docs and new examples. - Adds Basemap plotting support (including hatching/annotation helpers) and new
Chartconvenience methods (render,add_subplot,add_overlay,add_basemap). - Updates dependency pins across requirements files and bumps the package version.
Reviewed changes
Copilot reviewed 9 out of 11 changed files in this pull request and generated 10 comments.
Show a summary per file
| File | Description |
|---|---|
| requirements/testing.txt | Adds/pins basemap and updates matplotlib/numpy versions for testing deps. |
| requirements/staging.txt | Aligns staging dependency pins with new basemap/matplotlib/numpy versions. |
| requirements/production.txt | Aligns production dependency pins with new basemap/matplotlib/numpy versions. |
| requirements.txt | Adds basemap and updates core pins used by CI installs. |
| docs/source/index.rst | Minor formatting/whitespace normalization at the index footer. |
| chartly/utilities.py | Minor formatting (blank line after module docstring). |
| chartly/charts.py | Adds optional Basemap import wrapper, hatch helper refactor, and new Basemap/AnnotateBasemap plot classes. |
| chartly/chartly.py | Extends Chart with Basemap support and convenience methods; adjusts title/label handling and layout logic. |
| VERSION | Bumps version from 0.0.6 to 1.0.1. |
| README.md | Major rewrite of introduction, requirements, and examples (now referencing new convenience APIs). |
| .github/workflows/ci.yml | Minor YAML formatting/readability updates (document start + multiline if). |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
k-alphonse
force-pushed
the
ka/update-README.md
branch
from
cbfa0b7 to
532a420
Compare
Contributor
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 1 out of 1 changed files in this pull request and generated 4 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
cmbengue-ec-intl
approved these changes
Mar 30, 2026
github-merge-queue Bot
pushed a commit
that referenced
this pull request
Apr 2, 2026
* Set Up Repository (#2) * WIP: Set Up Repo * update requirements * closes string * adds plotting utilities class * Adds tests to the plotting module * Update the default settings * Adds README * linting corrections * Update Workflows (#5) * Update cd.yml * Update ci.yml * Update docs.yml * Update guard.yml * Update super-linter.yml * Delete release-log.yml * adds docs * Update .github/workflows/super-linter.yml Co-authored-by: Cheikh Mbengue <97647866+cmbengue-ec-intl@users.noreply.github.com> * Update docs/source/conf.py Co-authored-by: Cheikh Mbengue <97647866+cmbengue-ec-intl@users.noreply.github.com> * Delete docs/make.bat * Delete docs/Makefile * fix warnings * fix warnings * Update docs/source/index.rst Co-authored-by: Cheikh Mbengue <97647866+cmbengue-ec-intl@users.noreply.github.com> * Update docs/source/index.rst Co-authored-by: Cheikh Mbengue <97647866+cmbengue-ec-intl@users.noreply.github.com> * Update docs/source/index.rst Co-authored-by: Cheikh Mbengue <97647866+cmbengue-ec-intl@users.noreply.github.com> --------- Co-authored-by: Cheikh Mbengue <97647866+cmbengue-ec-intl@users.noreply.github.com> * docs: Add docs and rename plotting to chartly (#3) * Update the docs of the plotting and test_plotting modules * update docs workflows * Fix Sphinx render * add docs * rename plotting --> chartly * linting * Remove unused CSS and HTML files * WIP * update linting * update workflows * Update exclude_patterns in conf.py * adds manifest.in file * Adds CustomizePlot Class * update docs to reflect new changes * Adds HatchArea Class * update contour plot function * adds contour mask hatching * WIP * update tests * Remove hatch feature from this PR * fix isort * Delete docs/Makefile * Delete docs/make.bat * Package the chartly module * updates tests * removes basemap from this PR * linting * silences importation error * updates attr name * updates docs and add figure creator * updates VERSION file * update docs auto api dir * WIP * WIP * WIP * WIP * update chartly * isort * linting changes * update docs * update title * update img addresses * updates save functionality * fea: Add Contour Plot Hatching (#8) * Update the docs of the plotting and test_plotting modules * update docs workflows * Fix Sphinx render * add docs * rename plotting --> chartly * linting * Remove unused CSS and HTML files * WIP * update linting * update workflows * Update exclude_patterns in conf.py * adds manifest.in file * Adds CustomizePlot Class * update docs to reflect new changes * Adds HatchArea Class * update contour plot function * adds contour mask hatching * WIP * update tests * Remove unnecessary code and files related to Sphinx documentation * delete old src folder * Refactor Contour class to add hatch grid and mask functionality * updates customs' keys name * Update docs * updates hatch customs keys * update default * update docs * update docs * Add darker color edges to the filled plot * fix isort * adds optional input dict to `new_subplot` method and fixes orientation of the color bar * linting * Update the README.md to Reflect the Current Repo (#14) * updates LICENSE * deletes containers * deletes unnecessary files * updates README * adds language to codeblock fence * deletes devcontainer dir * Update Sphinx Documentation (#16) * updates broken links * update the sphinx documentation * Update VERSION (#17) * Adds DotPlot to Chartly (#21) * Adds DotPlot to Charlty * updates version file * Add Scatter Plot to Chartly (#24) * Adds scatter plot to chartly * update docs * Update the docs for line plot * update plot title * updates tests * Update the Example in the README.md to be More Illustrative (#26) * Updates example * removes redundant statement * removes extra white space * updates readme * updates readme example explanation * fixes probability plot label * linting * fixes line of best fit (#28) * adds option to specify bins (#30) * chore: Update VERSION to 0.0.4 (#31) * feat: Update DotPlot defaults to use square root of data length for bins (#33) * feat: Update DotPlot defaults to use square root of data length for bins * centers the x ticks * bump: Update setuptools version (#36) * bump: Update setuptools dependency to version 78.1.1 in production, staging, and testing requirements * Update VERSION * bump: setuptools to v78.1.1 (#38) * bump: setuptools to v78.1.1 * fix: resolve docs build pathing * docs: mock dependencies and fix code formatting * docs: fix build pathing and image directive formatting * revert: restore original sphinx config * docs: remove autoapi and unused extensions to fix Sphinx build * chore: format docs Sphinx config --------- Co-authored-by: Kaitlyn Alphonse <kalphonse@eci-iMac-2.local> * bump: chartly to v0.0.6 (#41) * release: charily v0.0.5 (#40) * Set Up Repository (#2) * WIP: Set Up Repo * update requirements * closes string * adds plotting utilities class * Adds tests to the plotting module * Update the default settings * Adds README * linting corrections * Update Workflows (#5) * Update cd.yml * Update ci.yml * Update docs.yml * Update guard.yml * Update super-linter.yml * Delete release-log.yml * adds docs * Update .github/workflows/super-linter.yml Co-authored-by: Cheikh Mbengue <97647866+cmbengue-ec-intl@users.noreply.github.com> * Update docs/source/conf.py Co-authored-by: Cheikh Mbengue <97647866+cmbengue-ec-intl@users.noreply.github.com> * Delete docs/make.bat * Delete docs/Makefile * fix warnings * fix warnings * Update docs/source/index.rst Co-authored-by: Cheikh Mbengue <97647866+cmbengue-ec-intl@users.noreply.github.com> * Update docs/source/index.rst Co-authored-by: Cheikh Mbengue <97647866+cmbengue-ec-intl@users.noreply.github.com> * Update docs/source/index.rst Co-authored-by: Cheikh Mbengue <97647866+cmbengue-ec-intl@users.noreply.github.com> --------- Co-authored-by: Cheikh Mbengue <97647866+cmbengue-ec-intl@users.noreply.github.com> * docs: Add docs and rename plotting to chartly (#3) * Update the docs of the plotting and test_plotting modules * update docs workflows * Fix Sphinx render * add docs * rename plotting --> chartly * linting * Remove unused CSS and HTML files * WIP * update linting * update workflows * Update exclude_patterns in conf.py * adds manifest.in file * Adds CustomizePlot Class * update docs to reflect new changes * Adds HatchArea Class * update contour plot function * adds contour mask hatching * WIP * update tests * Remove hatch feature from this PR * fix isort * Delete docs/Makefile * Delete docs/make.bat * Package the chartly module * updates tests * removes basemap from this PR * linting * silences importation error * updates attr name * updates docs and add figure creator * updates VERSION file * update docs auto api dir * WIP * WIP * WIP * WIP * update chartly * isort * linting changes * update docs * update title * update img addresses * updates save functionality * fea: Add Contour Plot Hatching (#8) * Update the docs of the plotting and test_plotting modules * update docs workflows * Fix Sphinx render * add docs * rename plotting --> chartly * linting * Remove unused CSS and HTML files * WIP * update linting * update workflows * Update exclude_patterns in conf.py * adds manifest.in file * Adds CustomizePlot Class * update docs to reflect new changes * Adds HatchArea Class * update contour plot function * adds contour mask hatching * WIP * update tests * Remove unnecessary code and files related to Sphinx documentation * delete old src folder * Refactor Contour class to add hatch grid and mask functionality * updates customs' keys name * Update docs * updates hatch customs keys * update default * update docs * update docs * Add darker color edges to the filled plot * fix isort * adds optional input dict to `new_subplot` method and fixes orientation of the color bar * linting * Update the README.md to Reflect the Current Repo (#14) * updates LICENSE * deletes containers * deletes unnecessary files * updates README * adds language to codeblock fence * deletes devcontainer dir * Update Sphinx Documentation (#16) * updates broken links * update the sphinx documentation * Update VERSION (#17) * Adds DotPlot to Chartly (#21) * Adds DotPlot to Charlty * updates version file * Add Scatter Plot to Chartly (#24) * Adds scatter plot to chartly * update docs * Update the docs for line plot * update plot title * updates tests * Update the Example in the README.md to be More Illustrative (#26) * Updates example * removes redundant statement * removes extra white space * updates readme * updates readme example explanation * fixes probability plot label * linting * fixes line of best fit (#28) * adds option to specify bins (#30) * chore: Update VERSION to 0.0.4 (#31) * feat: Update DotPlot defaults to use square root of data length for bins (#33) * feat: Update DotPlot defaults to use square root of data length for bins * centers the x ticks * bump: Update setuptools version (#36) * bump: Update setuptools dependency to version 78.1.1 in production, staging, and testing requirements * Update VERSION * bump: setuptools to v78.1.1 (#38) * bump: setuptools to v78.1.1 * fix: resolve docs build pathing * docs: mock dependencies and fix code formatting * docs: fix build pathing and image directive formatting * revert: restore original sphinx config * docs: remove autoapi and unused extensions to fix Sphinx build * chore: format docs Sphinx config --------- Co-authored-by: Kaitlyn Alphonse <kalphonse@eci-iMac-2.local> --------- Co-authored-by: Azendae Popo <97713029+Azendae-Popo@users.noreply.github.com> Co-authored-by: Azendae Popo <apopo@ec-intl.com> Co-authored-by: Kaitlyn Alphonse <kalphonse@ec-intl.com> Co-authored-by: Kaitlyn Alphonse <kalphonse@eci-iMac-2.local> * bump: Version from 0.0.6 to 1.0.1 (#43) * fea: Adds basemap (#10) * Update the docs of the plotting and test_plotting modules * update docs workflows * Fix Sphinx render * add docs * rename plotting --> chartly * linting * Remove unused CSS and HTML files * WIP * update linting * update workflows * Update exclude_patterns in conf.py * adds manifest.in file * Adds CustomizePlot Class * update docs to reflect new changes * Adds HatchArea Class * update contour plot function * adds contour mask hatching * WIP * update tests * add basemap to chartly * Delete docs/Makefile * Delete docs/make.bat * adds basemap feature to the class * update requirements * update requirement file * linting * Add Contour Plot and Hatching to basemap * Adds annotations class to basemap * WIP * fix: resolve basemaps PR lint and dependency issues * fix: resolve basemap dependency conflict and lint issues * style: fix ci workflow yaml lint warning * refactor: remove duplicate hatch logic and apply black formatting * fix: correct ci.yml indentation * fix: resolve basemap centering issue * fix: resolve failing lint check * fix: resolve indentation error * fix: add lint spacing * fix: improve basemap robustness, hatch handling, and input validation Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> * fix: resolve basemap import fallback and hatch validation issues * style: fix import ordering with isort * feat: simplify Chart public API with render and subplot helpers * feat: add basemap convenience helper to simplify Chart API * bump: upgrade numpy, basemap, and twine dependencies * bump: chartly v0.0.7 --------- Co-authored-by: Kaitlyn Alphonse <kalphonse@eci-iMac-2.local> Co-authored-by: Kaitlyn Alphonse <kalphonse@ec-intl.com> Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> * docs: simplify chartly plotting interface (#46) * docs: simplify chartly plotting interface * fix: clarify multiplots intro with new interface methods * feat: add batch subplot helper for cleaner chart interface * feat: add validated batch subplot helper and tests * docs: align subplot titles with existing example images * feat: add add_subplots helper and simplify plotting docs --------- Co-authored-by: Kaitlyn Alphonse <kalphonse@eci-iMac-2.local> * docs: update and refine README.md (#47) * docs: update and refine README.md * fix: resolve markdown lint errors * fix: markdownlint issues and formatting * docs: refine README and add basemap support --------- Co-authored-by: Kaitlyn Alphonse <kalphonse@eci-iMac-2.local> * docs: add basemap documentation and update index (#48) * docs: add basemap documentation and update index * docs: update basemap docs and move images to _static * docs: align dependency versions and spelling in basemap docs --------- Co-authored-by: Kaitlyn Alphonse <kalphonse@eci-iMac-2.local> * bump: chartly v1.1.0 (#49) --------- Co-authored-by: Azendae Popo <97713029+Azendae-Popo@users.noreply.github.com> Co-authored-by: Cheikh Mbengue <97647866+cmbengue-ec-intl@users.noreply.github.com> Co-authored-by: Azendae Popo <apopo@ec-intl.com> Co-authored-by: Kaitlyn Alphonse <kalphonse@eci-iMac-2.local> Co-authored-by: Cheikh Mbengue <cmbengue@ec-intl.com> Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
github-merge-queue Bot
pushed a commit
that referenced
this pull request
Apr 17, 2026
* Set Up Repository (#2) * WIP: Set Up Repo * update requirements * closes string * adds plotting utilities class * Adds tests to the plotting module * Update the default settings * Adds README * linting corrections * Update Workflows (#5) * Update cd.yml * Update ci.yml * Update docs.yml * Update guard.yml * Update super-linter.yml * Delete release-log.yml * adds docs * Update .github/workflows/super-linter.yml Co-authored-by: Cheikh Mbengue <97647866+cmbengue-ec-intl@users.noreply.github.com> * Update docs/source/conf.py Co-authored-by: Cheikh Mbengue <97647866+cmbengue-ec-intl@users.noreply.github.com> * Delete docs/make.bat * Delete docs/Makefile * fix warnings * fix warnings * Update docs/source/index.rst Co-authored-by: Cheikh Mbengue <97647866+cmbengue-ec-intl@users.noreply.github.com> * Update docs/source/index.rst Co-authored-by: Cheikh Mbengue <97647866+cmbengue-ec-intl@users.noreply.github.com> * Update docs/source/index.rst Co-authored-by: Cheikh Mbengue <97647866+cmbengue-ec-intl@users.noreply.github.com> --------- Co-authored-by: Cheikh Mbengue <97647866+cmbengue-ec-intl@users.noreply.github.com> * docs: Add docs and rename plotting to chartly (#3) * Update the docs of the plotting and test_plotting modules * update docs workflows * Fix Sphinx render * add docs * rename plotting --> chartly * linting * Remove unused CSS and HTML files * WIP * update linting * update workflows * Update exclude_patterns in conf.py * adds manifest.in file * Adds CustomizePlot Class * update docs to reflect new changes * Adds HatchArea Class * update contour plot function * adds contour mask hatching * WIP * update tests * Remove hatch feature from this PR * fix isort * Delete docs/Makefile * Delete docs/make.bat * Package the chartly module * updates tests * removes basemap from this PR * linting * silences importation error * updates attr name * updates docs and add figure creator * updates VERSION file * update docs auto api dir * WIP * WIP * WIP * WIP * update chartly * isort * linting changes * update docs * update title * update img addresses * updates save functionality * fea: Add Contour Plot Hatching (#8) * Update the docs of the plotting and test_plotting modules * update docs workflows * Fix Sphinx render * add docs * rename plotting --> chartly * linting * Remove unused CSS and HTML files * WIP * update linting * update workflows * Update exclude_patterns in conf.py * adds manifest.in file * Adds CustomizePlot Class * update docs to reflect new changes * Adds HatchArea Class * update contour plot function * adds contour mask hatching * WIP * update tests * Remove unnecessary code and files related to Sphinx documentation * delete old src folder * Refactor Contour class to add hatch grid and mask functionality * updates customs' keys name * Update docs * updates hatch customs keys * update default * update docs * update docs * Add darker color edges to the filled plot * fix isort * adds optional input dict to `new_subplot` method and fixes orientation of the color bar * linting * Update the README.md to Reflect the Current Repo (#14) * updates LICENSE * deletes containers * deletes unnecessary files * updates README * adds language to codeblock fence * deletes devcontainer dir * Update Sphinx Documentation (#16) * updates broken links * update the sphinx documentation * Update VERSION (#17) * Adds DotPlot to Chartly (#21) * Adds DotPlot to Charlty * updates version file * Add Scatter Plot to Chartly (#24) * Adds scatter plot to chartly * update docs * Update the docs for line plot * update plot title * updates tests * Update the Example in the README.md to be More Illustrative (#26) * Updates example * removes redundant statement * removes extra white space * updates readme * updates readme example explanation * fixes probability plot label * linting * fixes line of best fit (#28) * adds option to specify bins (#30) * chore: Update VERSION to 0.0.4 (#31) * feat: Update DotPlot defaults to use square root of data length for bins (#33) * feat: Update DotPlot defaults to use square root of data length for bins * centers the x ticks * bump: Update setuptools version (#36) * bump: Update setuptools dependency to version 78.1.1 in production, staging, and testing requirements * Update VERSION * bump: setuptools to v78.1.1 (#38) * bump: setuptools to v78.1.1 * fix: resolve docs build pathing * docs: mock dependencies and fix code formatting * docs: fix build pathing and image directive formatting * revert: restore original sphinx config * docs: remove autoapi and unused extensions to fix Sphinx build * chore: format docs Sphinx config --------- Co-authored-by: Kaitlyn Alphonse <kalphonse@eci-iMac-2.local> * bump: chartly to v0.0.6 (#41) * release: charily v0.0.5 (#40) * Set Up Repository (#2) * WIP: Set Up Repo * update requirements * closes string * adds plotting utilities class * Adds tests to the plotting module * Update the default settings * Adds README * linting corrections * Update Workflows (#5) * Update cd.yml * Update ci.yml * Update docs.yml * Update guard.yml * Update super-linter.yml * Delete release-log.yml * adds docs * Update .github/workflows/super-linter.yml Co-authored-by: Cheikh Mbengue <97647866+cmbengue-ec-intl@users.noreply.github.com> * Update docs/source/conf.py Co-authored-by: Cheikh Mbengue <97647866+cmbengue-ec-intl@users.noreply.github.com> * Delete docs/make.bat * Delete docs/Makefile * fix warnings * fix warnings * Update docs/source/index.rst Co-authored-by: Cheikh Mbengue <97647866+cmbengue-ec-intl@users.noreply.github.com> * Update docs/source/index.rst Co-authored-by: Cheikh Mbengue <97647866+cmbengue-ec-intl@users.noreply.github.com> * Update docs/source/index.rst Co-authored-by: Cheikh Mbengue <97647866+cmbengue-ec-intl@users.noreply.github.com> --------- Co-authored-by: Cheikh Mbengue <97647866+cmbengue-ec-intl@users.noreply.github.com> * docs: Add docs and rename plotting to chartly (#3) * Update the docs of the plotting and test_plotting modules * update docs workflows * Fix Sphinx render * add docs * rename plotting --> chartly * linting * Remove unused CSS and HTML files * WIP * update linting * update workflows * Update exclude_patterns in conf.py * adds manifest.in file * Adds CustomizePlot Class * update docs to reflect new changes * Adds HatchArea Class * update contour plot function * adds contour mask hatching * WIP * update tests * Remove hatch feature from this PR * fix isort * Delete docs/Makefile * Delete docs/make.bat * Package the chartly module * updates tests * removes basemap from this PR * linting * silences importation error * updates attr name * updates docs and add figure creator * updates VERSION file * update docs auto api dir * WIP * WIP * WIP * WIP * update chartly * isort * linting changes * update docs * update title * update img addresses * updates save functionality * fea: Add Contour Plot Hatching (#8) * Update the docs of the plotting and test_plotting modules * update docs workflows * Fix Sphinx render * add docs * rename plotting --> chartly * linting * Remove unused CSS and HTML files * WIP * update linting * update workflows * Update exclude_patterns in conf.py * adds manifest.in file * Adds CustomizePlot Class * update docs to reflect new changes * Adds HatchArea Class * update contour plot function * adds contour mask hatching * WIP * update tests * Remove unnecessary code and files related to Sphinx documentation * delete old src folder * Refactor Contour class to add hatch grid and mask functionality * updates customs' keys name * Update docs * updates hatch customs keys * update default * update docs * update docs * Add darker color edges to the filled plot * fix isort * adds optional input dict to `new_subplot` method and fixes orientation of the color bar * linting * Update the README.md to Reflect the Current Repo (#14) * updates LICENSE * deletes containers * deletes unnecessary files * updates README * adds language to codeblock fence * deletes devcontainer dir * Update Sphinx Documentation (#16) * updates broken links * update the sphinx documentation * Update VERSION (#17) * Adds DotPlot to Chartly (#21) * Adds DotPlot to Charlty * updates version file * Add Scatter Plot to Chartly (#24) * Adds scatter plot to chartly * update docs * Update the docs for line plot * update plot title * updates tests * Update the Example in the README.md to be More Illustrative (#26) * Updates example * removes redundant statement * removes extra white space * updates readme * updates readme example explanation * fixes probability plot label * linting * fixes line of best fit (#28) * adds option to specify bins (#30) * chore: Update VERSION to 0.0.4 (#31) * feat: Update DotPlot defaults to use square root of data length for bins (#33) * feat: Update DotPlot defaults to use square root of data length for bins * centers the x ticks * bump: Update setuptools version (#36) * bump: Update setuptools dependency to version 78.1.1 in production, staging, and testing requirements * Update VERSION * bump: setuptools to v78.1.1 (#38) * bump: setuptools to v78.1.1 * fix: resolve docs build pathing * docs: mock dependencies and fix code formatting * docs: fix build pathing and image directive formatting * revert: restore original sphinx config * docs: remove autoapi and unused extensions to fix Sphinx build * chore: format docs Sphinx config --------- Co-authored-by: Kaitlyn Alphonse <kalphonse@eci-iMac-2.local> --------- Co-authored-by: Azendae Popo <97713029+Azendae-Popo@users.noreply.github.com> Co-authored-by: Azendae Popo <apopo@ec-intl.com> Co-authored-by: Kaitlyn Alphonse <kalphonse@ec-intl.com> Co-authored-by: Kaitlyn Alphonse <kalphonse@eci-iMac-2.local> * bump: Version from 0.0.6 to 1.0.1 (#43) * fea: Adds basemap (#10) * Update the docs of the plotting and test_plotting modules * update docs workflows * Fix Sphinx render * add docs * rename plotting --> chartly * linting * Remove unused CSS and HTML files * WIP * update linting * update workflows * Update exclude_patterns in conf.py * adds manifest.in file * Adds CustomizePlot Class * update docs to reflect new changes * Adds HatchArea Class * update contour plot function * adds contour mask hatching * WIP * update tests * add basemap to chartly * Delete docs/Makefile * Delete docs/make.bat * adds basemap feature to the class * update requirements * update requirement file * linting * Add Contour Plot and Hatching to basemap * Adds annotations class to basemap * WIP * fix: resolve basemaps PR lint and dependency issues * fix: resolve basemap dependency conflict and lint issues * style: fix ci workflow yaml lint warning * refactor: remove duplicate hatch logic and apply black formatting * fix: correct ci.yml indentation * fix: resolve basemap centering issue * fix: resolve failing lint check * fix: resolve indentation error * fix: add lint spacing * fix: improve basemap robustness, hatch handling, and input validation Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> * fix: resolve basemap import fallback and hatch validation issues * style: fix import ordering with isort * feat: simplify Chart public API with render and subplot helpers * feat: add basemap convenience helper to simplify Chart API * bump: upgrade numpy, basemap, and twine dependencies * bump: chartly v0.0.7 --------- Co-authored-by: Kaitlyn Alphonse <kalphonse@eci-iMac-2.local> Co-authored-by: Kaitlyn Alphonse <kalphonse@ec-intl.com> Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> * docs: simplify chartly plotting interface (#46) * docs: simplify chartly plotting interface * fix: clarify multiplots intro with new interface methods * feat: add batch subplot helper for cleaner chart interface * feat: add validated batch subplot helper and tests * docs: align subplot titles with existing example images * feat: add add_subplots helper and simplify plotting docs --------- Co-authored-by: Kaitlyn Alphonse <kalphonse@eci-iMac-2.local> * docs: update and refine README.md (#47) * docs: update and refine README.md * fix: resolve markdown lint errors * fix: markdownlint issues and formatting * docs: refine README and add basemap support --------- Co-authored-by: Kaitlyn Alphonse <kalphonse@eci-iMac-2.local> * docs: add basemap documentation and update index (#48) * docs: add basemap documentation and update index * docs: update basemap docs and move images to _static * docs: align dependency versions and spelling in basemap docs --------- Co-authored-by: Kaitlyn Alphonse <kalphonse@eci-iMac-2.local> * bump: chartly v1.1.0 (#49) * bump: setuptools to v82.0.1 (#52) * bump: setuptools to v82.0.1 * bump: setuptools in requirements.txt --------- Co-authored-by: Kaitlyn Alphonse <kalphonse@eci-iMac-2.local> * Build(deps): Bump pytest (#53) Bumps the pip group with 1 update in the /requirements directory: [pytest](https://github.com/pytest-dev/pytest). Updates `pytest` from 8.3.2 to 9.0.3 - [Release notes](https://github.com/pytest-dev/pytest/releases) - [Changelog](https://github.com/pytest-dev/pytest/blob/main/CHANGELOG.rst) - [Commits](pytest-dev/pytest@8.3.2...9.0.3) --- updated-dependencies: - dependency-name: pytest dependency-version: 9.0.3 dependency-type: direct:production dependency-group: pip ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Kaitlyn Alphonse <kalphonse@ec-intl.com> * bump: chartly v1.1.1 (#54) --------- Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: Azendae Popo <97713029+Azendae-Popo@users.noreply.github.com> Co-authored-by: Cheikh Mbengue <97647866+cmbengue-ec-intl@users.noreply.github.com> Co-authored-by: Azendae Popo <apopo@ec-intl.com> Co-authored-by: Kaitlyn Alphonse <kalphonse@eci-iMac-2.local> Co-authored-by: Cheikh Mbengue <cmbengue@ec-intl.com> Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
🥇 Generic Pull Request 🥇
Elizabeth Consulting International Inc
Purpose & Objective
This PR enhances the
README.mdfile to provide a clearer, more professional, and user-friendly introduction to Chartly.The goal is to improve onboarding and usability by presenting the library’s functionality in a structured and intuitive way.
Changes
add_subplot(...)add_subplots(...)add_overlay(...)render()Results
Notes