busdayaxis 0.0.1__tar.gz

busdayaxis-0.0.1/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,44 @@
+---
+name: 🐛 Bug Report
+about: Report a bug
+# based on matplotlib issue template
+---
+
+<!--To help us understand and resolve your issue, please fill out the form to the best of your ability.-->
+<!--You can feel free to delete the sections that do not apply.-->
+
+### Bug report
+
+**Bug summary**
+
+<!--A short 1-2 sentences that succinctly describes the bug-->
+
+**Code for reproduction**
+
+<!--A minimum code snippet required to reproduce the bug.
+Please make sure to minimize the number of dependencies required, and provide
+any necessary plotted data.
+
+```python
+# Paste your code here
+#
+#
+```
+
+**Actual outcome**
+
+<!--The output produced by the above code, which may be a screenshot, console output, etc.-->
+
+**Expected outcome**
+
+<!--A description of the expected outcome from the code snippet-->
+<!--If this used to work in an earlier version of Matplotlib, please note the version it used to work on-->
+
+**Version Info**
+<!--Please specify your platform and versions of the relevant libraries you are using:-->
+  * Operating system:
+  * Matplotlib version:
+  * Matplotlib backend (`print(matplotlib.get_backend())`):
+  * Python version:
+  * Jupyter version (if applicable):
+  * Other libraries:

busdayaxis-0.0.1/.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,6 @@
+# Ref: https://help.github.com/en/github/building-a-strong-community/configuring-issue-templates-for-your-repository#configuring-the-template-chooser
+blank_issues_enabled: true # default
+contact_links:
+  - name: ❓ Question/Support/Other
+    url: https://discourse.matplotlib.org/c/3rdparty/18
+    about: If you have a usage question

busdayaxis-0.0.1/.github/ISSUE_TEMPLATE/documentation.md

@@ -0,0 +1,29 @@
+---
+name: 📖 Documentation improvement
+about: Report parts of the docs that are wrong or unclear
+labels: documentation, bug
+---
+
+<!--To help us understand and resolve your issue, please fill out the form to the best of your ability.-->
+<!--You can feel free to delete the sections that do not apply.-->
+
+### Problem
+
+<!--
+If you are referencing an existing piece of documentation or example please provide a link.
+
+* I found [...] to be unclear because [...]
+* [...] made me think that [...] when really it should be [...]
+* There is no example showing how to do [...]
+-->
+
+
+### Suggested Improvement
+
+<!--
+If you have an idea to improve the documentation please suggest it here
+
+* This line should be be changed to say [...]
+* Include a paragraph explaining [...]
+* Add a figure showing [...]
+-->

busdayaxis-0.0.1/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,34 @@
+---
+name: 🚀 Enhancement/Feature Request
+about: Suggest something that could be improved or a New Feature to add
+labels: enhancement
+---
+
+<!--
+Welcome! Thanks for thinking of a way to improve busdayaxis. If this solves a problem for you, then it probably solves that problem for lots of people! So the whole community will benefit from this request.
+
+
+Before creating a new feature request please search the issues for relevant feature requests.
+-->
+
+### Problem
+
+<!-- Provide a clear and concise description of what problem this feature will solve. For example:
+
+* I'm always frustrated when [...] because [...]
+* I would like it if [...] happened when I [...] because [...]
+-->
+
+### Proposed Solution
+
+<!-- Provide a clear and concise description of a way to accomplish what you want. For example:
+
+* Add an option so that when [...]  [...] will happen
+ -->
+
+### Additional context
+
+<!-- Add any other context or screenshots about the feature request here. You can also include links to examples of other programs that have something similar to your request. For example:
+
+* Another project [...] solved this by [...]
+-->

busdayaxis-0.0.1/.github/workflows/lint.yml

@@ -0,0 +1,9 @@
+name: Prek checks
+on: [push, pull_request]
+
+jobs:
+  prek:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+      - uses: j178/prek-action@v1

busdayaxis-0.0.1/.github/workflows/publish.yml

@@ -0,0 +1,25 @@
+name: Publish Package
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.x"
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install build
+      - name: Build package
+        run: python -m build
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          password: ${{ secrets.PYPI_API_TOKEN }}

busdayaxis-0.0.1/.github/workflows/test.yml

@@ -0,0 +1,32 @@
+name: Test
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  test:
+    name: Python ${{ matrix.python-version }}
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+          cache: "pip"
+
+      - name: Install dependencies
+        run: |
+          pip install --upgrade pip
+          pip install ".[test]"
+
+      - name: Tests
+        run: pytest

busdayaxis-0.0.1/.gitignore

@@ -0,0 +1,158 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+docs/generated
+
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# mac stuff
+.DS_store
+
+# editors
+
+## vim
+[._]*.s[a-v][a-z]
+!*.svg  # comment out if you don't need vector files
+[._]*.sw[a-p]
+[._]s[a-rt-v][a-z]
+[._]ss[a-gi-z]
+[._]sw[a-p]
+[._]*.un~
+
+## vscode
+.vscode
+.python-version

busdayaxis-0.0.1/.pre-commit-config.yaml

@@ -0,0 +1,26 @@
+minimum_prek_version: "0.2.0"
+
+repos:
+  - repo: builtin
+    hooks:
+      - id: trailing-whitespace
+      - id: check-added-large-files
+      - id: check-case-conflict
+      - id: end-of-file-fixer
+      - id: fix-byte-order-marker
+      - id: check-json
+      - id: check-json5
+      - id: check-toml
+      - id: check-yaml
+      - id: check-xml
+      - id: mixed-line-ending
+      - id: check-symlinks
+      - id: check-merge-conflict
+      - id: detect-private-key
+      - id: check-executables-have-shebangs
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.9.0
+    hooks:
+      - id: ruff
+        args: [--fix]
+      - id: ruff-format

busdayaxis-0.0.1/CONTRIBUTING.md

@@ -0,0 +1,73 @@
+============
+Contributing
+============
+
+Thanks for thinking of a way to help improve this library! Remember that contributions come in all
+shapes and sizes beyond writing bug fixes. Contributing to documentation, opening new `issues <https://github.com//busdayaxis/issues>`_,
+asking for clarification on things you find unclear, and requesting new features, are all super valuable contributions.
+
+Code Improvements
+-----------------
+
+All development for this library happens at https://github.com//busdayaxis,
+
+First set up a dev environment. The instructions here use `mamba <https://github.com/mamba-org/mamba#mamba>`_ which is open source
+implementation of `conda` that offers significant speed ups. You can substitute ``conda`` for ``mamba`` or use ``venv`` without any ill-effects.
+
+.. code-block:: bash
+
+    mamba create -n busdayaxis-dev python
+    conda activate busdayaxis-dev
+
+Now clone your fork of the Git repository and make an editable (``-e``) install.
+
+.. code-block:: bash
+
+   git clone <your fork>
+   cd busdayaxis
+   pip install -e ".[dev]"
+
+
+Working with Git
+^^^^^^^^^^^^^^^^
+
+Using Git/Github can confusing (https://xkcd.com/1597/) so if you're new to Git, you may find
+it helpful to use a program like `Github Desktop <desktop.github.com>`_ and to follow
+a `guide <https://github.com/firstcontributions/first-contributions#first-contributions>`_.
+
+Also feel free to ask for help/advice on the relevant Github `issue <https://github.com//busdayaxis/issues>`_.
+
+Documentation
+-------------
+
+Following changes to the source files, you can view recent adjustments by building the documentation.
+
+1. Make sure you have installed the requirements for building the documentation:
+
+.. code-block:: bash
+
+    cd busdayaxis
+    pip install -e ".[doc]"
+
+2. Run the following commands:
+
+.. code-block:: bash
+
+    cd docs
+    make html
+
+If you open the ``_build/html/index.html`` file in your browser you should now be able to see the rendered documentation.
+
+Autobuild the documentation
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Alternatively, you can use `sphinx-autobuild <https://github.com/GaretJax/sphinx-autobuild>`_ to continuously watch the documentation for changes and rebuild it for you.
+Sphinx-autobuild will be installed automatically by the above ``pip`` command, and we've added it to the ``Makefile``. All you need to do is:
+
+.. code-block:: bash
+
+    cd docs
+    make watch
+
+In a few seconds your web browser should open up the documentation. Now whenever you save a file
+the documentation will automatically regenerate and the webpage will refresh for you!

busdayaxis-0.0.1/LICENSE

@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2026, Simon Niederberger
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its contributors
+   may be used to endorse or promote products derived from this software
+   without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

busdayaxis-0.0.1/PKG-INFO

@@ -0,0 +1,115 @@
+Metadata-Version: 2.4
+Name: busdayaxis
+Version: 0.0.1
+Summary: Business day axis scale for matplotlib
+Author-email: Simon Niederberger <s.niederberger@hotmail.com>
+Maintainer-email: Simon Niederberger <s.niederberger@hotmail.com>
+License-Expression: BSD-3-Clause
+Project-URL: Homepage, https://saemeon.github.io/busdayaxis/
+Project-URL: Repository, https://github.com/saemeon/busdayaxis
+Keywords: matplotlib,business day,busday,matplotlib-scale
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Framework :: Matplotlib
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: matplotlib
+Requires-Dist: numpy
+Requires-Dist: pandas
+Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
+Requires-Dist: pytest-cov; extra == "test"
+Provides-Extra: doc
+Requires-Dist: mkdocs; extra == "doc"
+Requires-Dist: mkdocs-material; extra == "doc"
+Requires-Dist: mkdocs-gallery; extra == "doc"
+Requires-Dist: mkdocstrings[python]; extra == "doc"
+Requires-Dist: mike; extra == "doc"
+Provides-Extra: dev
+Requires-Dist: ruff; extra == "dev"
+Requires-Dist: prek; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pytest-cov; extra == "dev"
+Requires-Dist: mkdocs; extra == "dev"
+Requires-Dist: mkdocs-material; extra == "dev"
+Requires-Dist: mkdocs-gallery; extra == "dev"
+Requires-Dist: mkdocstrings[python]; extra == "dev"
+Requires-Dist: mike; extra == "dev"
+Dynamic: license-file
+
+# busdayaxis
+
+[![PyPI](https://img.shields.io/pypi/v/busdayaxis)](https://pypi.org/project/busdayaxis/)
+[![License](https://img.shields.io/badge/License-BSD--3--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause)
+
+## Business-day axis support for Matplotlib.
+
+`busdayaxis` provides a custom Matplotlib scale that compresses non-business days and displays time in continuous business-day space.
+- Useful when your data has no weekend activity and is naturally defined in business-day units.
+- Integrates directly with Matplotlib’s transformation and autoscaling machinery.
+- No data preprocessing is required.
+- Custom business calendars are supported.
+
+## Motivation
+Many time series evolve in business time rather than calendar time:
+- Equity prices
+- Trading signals
+- Portfolio returns
+- Risk metrics
+- Operational KPIs
+
+When plotted on a standard calendar axis, weekends introduce artificial gaps that visually distort slopes and compress active trading periods.
+`busdayaxis` removes these inactive periods by mapping calendar datetimes to continuous business-day units.
+
+## Installation
+You can install using `pip`:
+
+```bash
+pip install busdayaxis
+```
+
+## Quick Start
+
+```python
+import matplotlib.pyplot as plt
+import busdayaxis
+
+busdayaxis.register_scale()
+
+ax.plot(dates, values)
+ax.set_xscale("busday")
+```
+
+
+## Custom Business Calendars
+
+The scale supports all keyword arguments accepted by NumPy’s business-day functions (is_busday, busday_count, busday_offset). This allows custom weekmasks and holiday lists.
+
+```python
+ax.set_xscale(
+    "busday",
+    weekmask="Mon Tue Wed Thu Fri",
+    holidays=["2025-01-01", "2025-12-25"],
+)
+```
+
+This makes it possible to model exchange holidays or company-specific calendars.
+
+## Matplotlib Integration
+
+- The busday scale is implemented as a proper ScaleBase subclass and:
+- Participates in Matplotlib’s transform pipeline
+- Works with autoscaling
+- Works with shared axes and subplots
+- Supports all artists that go through the standard data transformation system
+- This includes plot, scatter, bar, vlines, fill_between, and other common Matplotlib objects.
+
+## License
+
+BSD 3-Clause

busdayaxis-0.0.1/README.md

@@ -0,0 +1,70 @@
+# busdayaxis
+
+[![PyPI](https://img.shields.io/pypi/v/busdayaxis)](https://pypi.org/project/busdayaxis/)
+[![License](https://img.shields.io/badge/License-BSD--3--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause)
+
+## Business-day axis support for Matplotlib.
+
+`busdayaxis` provides a custom Matplotlib scale that compresses non-business days and displays time in continuous business-day space.
+- Useful when your data has no weekend activity and is naturally defined in business-day units.
+- Integrates directly with Matplotlib’s transformation and autoscaling machinery.
+- No data preprocessing is required.
+- Custom business calendars are supported.
+
+## Motivation
+Many time series evolve in business time rather than calendar time:
+- Equity prices
+- Trading signals
+- Portfolio returns
+- Risk metrics
+- Operational KPIs
+
+When plotted on a standard calendar axis, weekends introduce artificial gaps that visually distort slopes and compress active trading periods.
+`busdayaxis` removes these inactive periods by mapping calendar datetimes to continuous business-day units.
+
+## Installation
+You can install using `pip`:
+
+```bash
+pip install busdayaxis
+```
+
+## Quick Start
+
+```python
+import matplotlib.pyplot as plt
+import busdayaxis
+
+busdayaxis.register_scale()
+
+ax.plot(dates, values)
+ax.set_xscale("busday")
+```
+
+
+## Custom Business Calendars
+
+The scale supports all keyword arguments accepted by NumPy’s business-day functions (is_busday, busday_count, busday_offset). This allows custom weekmasks and holiday lists.
+
+```python
+ax.set_xscale(
+    "busday",
+    weekmask="Mon Tue Wed Thu Fri",
+    holidays=["2025-01-01", "2025-12-25"],
+)
+```
+
+This makes it possible to model exchange holidays or company-specific calendars.
+
+## Matplotlib Integration
+
+- The busday scale is implemented as a proper ScaleBase subclass and:
+- Participates in Matplotlib’s transform pipeline
+- Works with autoscaling
+- Works with shared axes and subplots
+- Supports all artists that go through the standard data transformation system
+- This includes plot, scatter, bar, vlines, fill_between, and other common Matplotlib objects.
+
+## License
+
+BSD 3-Clause

busdayaxis-0.0.1/docs/api.md

@@ -0,0 +1,6 @@
+# API Reference
+
+::: busdayaxis
+    options:
+      show_source: true
+      members_order: source