omnimark

Name	omnimark JSON
Version	0.1.2 JSON
	download
home_page	https://github.com/royabes/omnimark
Summary	A PDF to Markdown converter with support for native, scanned, and hybrid PDFs
upload_time	2024-09-17 22:58:05
maintainer	None
docs_url	None
author	Roy Abes
requires_python	>=3.7
license	MIT License Copyright (c) 2024 Roy Abes Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
keywords	pdf markdown converter ocr
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # OmniMark

OmniMark is a powerful PDF to Markdown converter with support for native, scanned, and hybrid PDFs. It's designed to handle various types of PDFs and extract text, tables, and images, converting them into well-formatted Markdown.

## Features

- Supports native (text-based), scanned (image-based), and hybrid PDFs
- Extracts text content using OCR for scanned documents
- Detects and converts tables to Markdown format
- Handles images and converts them to Markdown image links
- Analyzes PDF structure to maintain document hierarchy
- Configurable page limit for processing large documents

## Installation

Since this is currently a private repository, installation is limited to those with access. Here are the steps for authorized users:

1. Clone the repository (you'll need to authenticate with GitHub):
   ```bash
   git clone https://github.com/royabes/omnimark.git
   cd omnimark
   ```

2. Create and activate a virtual environment:
   ```bash
   python -m venv venv
   source venv/bin/activate  # On Windows, use `venv\Scripts\activate`
   ```

3. Install the package in editable mode:
   ```bash
   pip install -e .
   ```

## Usage for Authorized Users

After installation, you can use OmniMark as a command-line tool:

```
omnimark <page_limit> <input_file> <output_md>


- `<page_limit>`: Number of pages to process (use 'A' for all pages)
- `<input_file>`: Path to the input PDF file
- `<output_md>`: Path for the output Markdown file

Example:
omnimark A input.pdf output.md

## Requirements

- Python 3.7+
- Dependencies:
  - pytesseract
  - Pillow
  - PyPDF2 (version 2.12.1)
  - camelot-py[cv]
  - opencv-python
  - pdf2image
  - pypdf
  - filetype
  - pdfplumber

## Project Structure

```bash
omnimark/
├── src/
│ └── omnimark/
│ ├── init.py
│ ├── processors/
│ │ └── pdf_page_processor.py
│ └── utils/
│ ├── utils.py
│ ├── table_detector.py
│ ├── pdf_utils.py
│ ├── markdown_converter.py
│ └── config.py
├── setup.py
├── README.md
├── LICENSE
└── .gitignore

   ```
## Development

To set up the development environment:

1. Clone the repository:
   ```bash
   git clone https://github.com/royabes/omnimark.git
   cd omnimark
   ```

2. Create a virtual environment and activate it:
   ```bash
   python -m venv venv
   source venv/bin/activate  # On Windows, use `venv\Scripts\activate`
   ```

3. Install the development dependencies:
   ```bash
   pip install -e .
   ```

## Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

## For Collaborators

If you're a collaborator on this project:

1. Ensure you have the necessary permissions to access the repository.
2. Follow the installation instructions above.
3. Make your changes in a new branch:
   ```
   git checkout -b feature/your-feature-name
   ```
4. Commit your changes and push to the repository:
   ```
   git add .
   git commit -m "Description of your changes"
   git push origin feature/your-feature-name
   ```
5. Create a pull request on GitHub for review.

## For Other Users

If you're not a collaborator but need to use this package:

1. Contact the repository owner (Roy Abes - roy.abes@gmail.com) to request access.
2. Once granted access, follow the installation instructions above.

Alternatively, if you need to use this in another project without direct access:

1. The repository owner can add the project as a submodule to your project.
2. Or, the owner can build and provide you with a wheel file for installation.

For more detailed instructions on using private repositories, please refer to the `git_instruct.md` file in this repository.


## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

## Contact

For any questions or feedback, please contact:
Your Name - your.email@example.com

Project Link: https://github.com/royabes/omnimark

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/royabes/omnimark",
    "name": "omnimark",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": null,
    "keywords": "pdf, markdown, converter, ocr",
    "author": "Roy Abes",
    "author_email": "Roy Abes <roy.abes@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/d9/25/3440593191b9e5e6daf2394b62e92271a485d714487a05ef0e3c22794fc2/omnimark-0.1.2.tar.gz",
    "platform": null,
    "description": "# OmniMark\r\n\r\nOmniMark is a powerful PDF to Markdown converter with support for native, scanned, and hybrid PDFs. It's designed to handle various types of PDFs and extract text, tables, and images, converting them into well-formatted Markdown.\r\n\r\n## Features\r\n\r\n- Supports native (text-based), scanned (image-based), and hybrid PDFs\r\n- Extracts text content using OCR for scanned documents\r\n- Detects and converts tables to Markdown format\r\n- Handles images and converts them to Markdown image links\r\n- Analyzes PDF structure to maintain document hierarchy\r\n- Configurable page limit for processing large documents\r\n\r\n## Installation\r\n\r\nSince this is currently a private repository, installation is limited to those with access. Here are the steps for authorized users:\r\n\r\n1. Clone the repository (you'll need to authenticate with GitHub):\r\n   ```bash\r\n   git clone https://github.com/royabes/omnimark.git\r\n   cd omnimark\r\n   ```\r\n\r\n2. Create and activate a virtual environment:\r\n   ```bash\r\n   python -m venv venv\r\n   source venv/bin/activate  # On Windows, use `venv\\Scripts\\activate`\r\n   ```\r\n\r\n3. Install the package in editable mode:\r\n   ```bash\r\n   pip install -e .\r\n   ```\r\n\r\n## Usage for Authorized Users\r\n\r\nAfter installation, you can use OmniMark as a command-line tool:\r\n\r\n```\r\nomnimark <page_limit> <input_file> <output_md>\r\n\r\n\r\n- `<page_limit>`: Number of pages to process (use 'A' for all pages)\r\n- `<input_file>`: Path to the input PDF file\r\n- `<output_md>`: Path for the output Markdown file\r\n\r\nExample:\r\nomnimark A input.pdf output.md\r\n\r\n## Requirements\r\n\r\n- Python 3.7+\r\n- Dependencies:\r\n  - pytesseract\r\n  - Pillow\r\n  - PyPDF2 (version 2.12.1)\r\n  - camelot-py[cv]\r\n  - opencv-python\r\n  - pdf2image\r\n  - pypdf\r\n  - filetype\r\n  - pdfplumber\r\n\r\n## Project Structure\r\n\r\n```bash\r\nomnimark/\r\n\u251c\u2500\u2500 src/\r\n\u2502 \u2514\u2500\u2500 omnimark/\r\n\u2502 \u251c\u2500\u2500 init.py\r\n\u2502 \u251c\u2500\u2500 processors/\r\n\u2502 \u2502 \u2514\u2500\u2500 pdf_page_processor.py\r\n\u2502 \u2514\u2500\u2500 utils/\r\n\u2502 \u251c\u2500\u2500 utils.py\r\n\u2502 \u251c\u2500\u2500 table_detector.py\r\n\u2502 \u251c\u2500\u2500 pdf_utils.py\r\n\u2502 \u251c\u2500\u2500 markdown_converter.py\r\n\u2502 \u2514\u2500\u2500 config.py\r\n\u251c\u2500\u2500 setup.py\r\n\u251c\u2500\u2500 README.md\r\n\u251c\u2500\u2500 LICENSE\r\n\u2514\u2500\u2500 .gitignore\r\n\r\n   ```\r\n## Development\r\n\r\nTo set up the development environment:\r\n\r\n1. Clone the repository:\r\n   ```bash\r\n   git clone https://github.com/royabes/omnimark.git\r\n   cd omnimark\r\n   ```\r\n\r\n2. Create a virtual environment and activate it:\r\n   ```bash\r\n   python -m venv venv\r\n   source venv/bin/activate  # On Windows, use `venv\\Scripts\\activate`\r\n   ```\r\n\r\n3. Install the development dependencies:\r\n   ```bash\r\n   pip install -e .\r\n   ```\r\n\r\n## Contributing\r\n\r\nContributions are welcome! Please feel free to submit a Pull Request.\r\n\r\n## For Collaborators\r\n\r\nIf you're a collaborator on this project:\r\n\r\n1. Ensure you have the necessary permissions to access the repository.\r\n2. Follow the installation instructions above.\r\n3. Make your changes in a new branch:\r\n   ```\r\n   git checkout -b feature/your-feature-name\r\n   ```\r\n4. Commit your changes and push to the repository:\r\n   ```\r\n   git add .\r\n   git commit -m \"Description of your changes\"\r\n   git push origin feature/your-feature-name\r\n   ```\r\n5. Create a pull request on GitHub for review.\r\n\r\n## For Other Users\r\n\r\nIf you're not a collaborator but need to use this package:\r\n\r\n1. Contact the repository owner (Roy Abes - roy.abes@gmail.com) to request access.\r\n2. Once granted access, follow the installation instructions above.\r\n\r\nAlternatively, if you need to use this in another project without direct access:\r\n\r\n1. The repository owner can add the project as a submodule to your project.\r\n2. Or, the owner can build and provide you with a wheel file for installation.\r\n\r\nFor more detailed instructions on using private repositories, please refer to the `git_instruct.md` file in this repository.\r\n\r\n\r\n## License\r\n\r\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\r\n\r\n## Contact\r\n\r\nFor any questions or feedback, please contact:\r\nYour Name - your.email@example.com\r\n\r\nProject Link: https://github.com/royabes/omnimark\r\n",
    "bugtrack_url": null,
    "license": "MIT License  Copyright (c) 2024 Roy Abes  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:  The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.  THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.",
    "summary": "A PDF to Markdown converter with support for native, scanned, and hybrid PDFs",
    "version": "0.1.2",
    "project_urls": {
        "Bug Tracker": "https://github.com/royabes/omnimark/issues",
        "Homepage": "https://github.com/royabes/omnimark"
    },
    "split_keywords": [
        "pdf",
        " markdown",
        " converter",
        " ocr"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "ee0583f97f1f803113f85af34d6a537155f02ad96f9212e46d2fdbc4478d3437",
                "md5": "60164f2e940005859a9aaef5de983990",
                "sha256": "9694a0dd20bde3b2d53e352cf136931684f106cf86a64fce5b79fee49aebb124"
            },
            "downloads": -1,
            "filename": "omnimark-0.1.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "60164f2e940005859a9aaef5de983990",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7",
            "size": 14127,
            "upload_time": "2024-09-17T22:58:04",
            "upload_time_iso_8601": "2024-09-17T22:58:04.349289Z",
            "url": "https://files.pythonhosted.org/packages/ee/05/83f97f1f803113f85af34d6a537155f02ad96f9212e46d2fdbc4478d3437/omnimark-0.1.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "d9253440593191b9e5e6daf2394b62e92271a485d714487a05ef0e3c22794fc2",
                "md5": "6ce3e46e339afb216a74abc4a52a6135",
                "sha256": "e1226f6cd6ae60f8dac7c4b7f7498e5bf2c31c8c767c0c2e9366a8f2e42a1f7f"
            },
            "downloads": -1,
            "filename": "omnimark-0.1.2.tar.gz",
            "has_sig": false,
            "md5_digest": "6ce3e46e339afb216a74abc4a52a6135",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7",
            "size": 14178,
            "upload_time": "2024-09-17T22:58:05",
            "upload_time_iso_8601": "2024-09-17T22:58:05.748202Z",
            "url": "https://files.pythonhosted.org/packages/d9/25/3440593191b9e5e6daf2394b62e92271a485d714487a05ef0e3c22794fc2/omnimark-0.1.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-09-17 22:58:05",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "royabes",
    "github_project": "omnimark",
    "github_not_found": true,
    "lcname": "omnimark"
}