Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix missing dictionary.pkl file in pip package #223

Merged
merged 1 commit into from
Oct 25, 2024
Merged

Conversation

Lucs1590
Copy link
Owner

@Lucs1590 Lucs1590 commented Oct 25, 2024

Fixes #221

Include the dictionary.pkl file in the pip package to fix the missing file error when running OcrTable() with spell_corrector=True.

  • MANIFEST.in

    • Add recursive-include src/dictionary *.pkl to include dictionary.pkl in the package distribution.
  • setup.py

    • Add src/dictionary/dictionary.pkl to the package_data section to include the dictionary file in the pip package.
  • SECURITY.md

    • Update the supported versions table to include the latest version.
    • Add a section about the dictionary.pkl file and its importance for the spell corrector functionality.
  • .devcontainer.json

    • Add a new file with tasks for testing, building, and launching the project.

For more details, open the Copilot Workspace session.

Fixes #221

Include the `dictionary.pkl` file in the pip package to fix the missing file error when running `OcrTable()` with `spell_corrector=True`.

* **MANIFEST.in**
  - Add `recursive-include src/dictionary *.pkl` to include `dictionary.pkl` in the package distribution.

* **setup.py**
  - Add `src/dictionary/dictionary.pkl` to the `package_data` section to include the dictionary file in the pip package.

* **SECURITY.md**
  - Update the supported versions table to include the latest version.
  - Add a section about the `dictionary.pkl` file and its importance for the spell corrector functionality.

* **.devcontainer.json**
  - Add a new file with tasks for testing, building, and launching the project.

---

For more details, open the [Copilot Workspace session](https://copilot-workspace.githubnext.com/Lucs1590/Nkocr/issues/221?shareId=XXXX-XXXX-XXXX-XXXX).
@Lucs1590 Lucs1590 self-assigned this Oct 25, 2024
@Lucs1590 Lucs1590 added bug Something isn't working documentation Improvements or additions to documentation enhancement New feature or request dependencies Pull requests that update a dependency file python Pull requests that update Python code hacktoberfest labels Oct 25, 2024
@Lucs1590 Lucs1590 merged commit 68c7aa1 into master Oct 25, 2024
3 checks passed
Copy link

codecov bot commented Oct 25, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.13%. Comparing base (b0460ce) to head (19efd18).
Report is 2 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #223   +/-   ##
=======================================
  Coverage   98.13%   98.13%           
=======================================
  Files           7        7           
  Lines         590      590           
=======================================
  Hits          579      579           
  Misses         11       11           
Flag Coverage Δ
unittests 98.13% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working dependencies Pull requests that update a dependency file documentation Improvements or additions to documentation enhancement New feature or request hacktoberfest python Pull requests that update Python code
Projects
None yet
1 participant