.. bubt-routinepy documentation master file, created by
   sphinx-quickstart on Mon Jun  2 01:26:49 2025.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

bubt-routinepy
==============

.. note::
   Part of the `Project Harukaze <https://harukaze.pages.dev/>`_ - An open-source initiative I commenced during my Spring 2025 semester

.. image:: https://img.shields.io/pypi/v/bubt-routinepy?color=blue&label=PyPI
   :target: https://pypi.org/project/bubt-routinepy/
   :alt: PyPI Version

.. image:: https://img.shields.io/github/license/kurtnettle/bubt-routinepy
   :target: LICENSE
   :alt: License

**routinepy** - A Python wrapper of the BUBT Routine API, seamlessly integrated 
with a robust web scraper and PDF extractor for getting routine data.


Quick Links
-----------
- :doc:`Installation Guide <source/installation>`
- :doc:`CLI Command Reference <source/cli/index>`
- :doc:`Library Documentation <source/lib/index>`


Getting Started
---------------

.. toctree::
   :maxdepth: 2
   
   source/quickstart
   source/lib/index


Indices
~~~~~~~

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

.. toctree::
   :hidden:
   
   GitHub Repository <https://github.com/yourusername/routinepy>
   Issue Tracker <https://github.com/yourusername/routinepy/issues>