Merge branch 'dj/fix-docs' into dj/docs

Author: dilithjay

.env_example

@@ -0,0 +1,4 @@
+GOOGLE_API_KEY=""
+OPENAI_API_KEY=""
+HUGGINGFACEHUB_API_TOKEN=""
+TOGETHER_API_KEY=""

.github/workflows/deploy_docs.yml

@@ -4,20 +4,48 @@ on:
   push:
     branches:
       - main
-      - dj/docs
+      - '**docs**'
     paths:
       - 'docs/**'
       - '.github/workflows/deploy_docs.yml'
 
 jobs:
-  pages:
-    runs-on: ubuntu-20.04
-    environment:
-      name: github-pages
-      url: ${{ steps.deployment.outputs.page_url }}
+  build-docs:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install sphinx docutils
+          pip install -r docs/requirements.txt || true
+
+      - name: Build Sphinx documentation
+        run: |
+          sphinx-build -b html docs/ docs/_build/html
+
+      - name: Upload documentation artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: docs/_build/html
+
+  deploy:
+    needs: build-docs
+    runs-on: ubuntu-latest
     permissions:
       pages: write
       id-token: write
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
     steps:
-    - id: deployment
-      uses: sphinx-notes/pages@v3
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v2

.gitignore

@@ -164,4 +164,7 @@ cython_debug/
 # Custom
 tests/outputs/
 outputs/
-inputs/
+inputs/
+
+# Others
+.DS_Store

CHANGELOG.md

@@ -80,7 +80,85 @@
 ## [0.1.8] - 2025-01-23
 
 ### Added
-* Rretry and error handling for LLM_PARSE
+* Retry and error handling for LLM_PARSE
 
 ### Changed
 * Remove together Python client dependency and use REST API calls instead
+
+## [0.1.8.post1] - 2025-01-28
+
+### Added
+* Documentation
+
+### Changed
+* Specify headers for Playwright web page retrieval
+
+## [0.1.9] - 2025-02-17
+
+### Added
+- Parameters to specify intermediate PDF save path when `as_pdf=True`.
+- Return `token_uage` and `pdf_path` with `parse()` output where applicable
+
+### Changed
+- Switched back to together Python client
+- Improved `parse()` function return format to be a dictionary.
+
+
+## [0.1.10] - 2025-02-23
+
+### Added
+- Parameter to specify page numbers for parsing
+
+### Fixed
+- Errors caused by empty token_usage
+
+## [0.1.11] - 2025-02-27
+
+### Added
+- Priority setting to AUTO routing
+- More models to benchmark
+
+### Changed
+- Set default parse_type to AUTO
+- Set default LLM to Gemini 2.0 Flash
+- Updated benchmark script to aggregate over multiple runs
+
+### Fixed
+- Incorrect title when `as_pdf=True`
+
+
+## [0.1.11.post1] - 2025-03-05
+
+### Added
+- Code of Conduct
+
+### Fixed
+- Segmentation fault when PyQT app is reinitialized
+
+## [0.1.12] - 2025-04-11
+
+### Added
+* Support for OpenRouter models
+* Return token cost when cost mapping is provided
+* Support for custom prompts
+* Support for parsing Excel and PowerPoint files
+
+### Changed
+* Set default `router_priority` to `speed`
+
+## [0.1.13] - 2025-04-20
+
+### Added
+* `STATIC_PARSE` improvements
+    * Horizontal line detection
+    * Strikethrough text detection
+    * Email address formatting
+    * Improved heading level detection
+    * Monospace font detection
+    * Indentation detection
+
+## [0.1.14] - 2025-06-05
+
+### Added
+* Add support for Fireworks API
+* Add support for matching data in document to pre-defined schema or template

CODE_OF_CONDUCT.md

@@ -0,0 +1,134 @@
+At Oid Labs we are committed to enabling a safe, welcoming and collaborative environment for everyone.
+
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+- Demonstrating empathy and kindness toward other people
+- Being respectful of differing opinions, viewpoints, and experiences
+- Giving and gracefully accepting constructive feedback
+- Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+- Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+- The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+- Trolling, insulting or derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+- Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations