biblatex2qmd

Name	biblatex2qmd JSON
Version	0.1.7 JSON
	download
home_page	None
Summary	BibLaTeX Processor is a Python package that processes BibLaTeX files, extracts information from each entry, creates individual Markdown files for each entry, and generates a combined corpus file.
upload_time	2024-08-27 14:16:47
maintainer	None
docs_url	None
author	None
requires_python	>=3.7
license	MIT License Copyright (c) [year] [fullname] 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	bib latex processor
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # BibLaTeX Processor

BibLaTeX Processor is a Python package that processes BibLaTeX files, extracts information from each entry, creates individual Markdown files for each entry, and generates a combined corpus file.

## Features

- Validates BibLaTeX files
- Extracts key information from BibLaTeX entries
- Generates individual Markdown files for each entry
- Creates a combined corpus file
- Handles custom notes and keywords

## Installation

You can install BibLaTeX Processor using pip:

```bash
pip install biblatex-processor
```

## Usage

Here's a basic example of how to use BibLaTeX Processor:

```python
from biblatex_processor import process_entries

input_file = 'path/to/your/bibfile.bib'
output_directory = 'path/to/output/directory'
fields_to_extract = ['author_last_name', 'year', 'title', 'ID', 'abstract', 'keywords', 'note']

process_entries(input_file, output_directory, fields_to_extract)
```

This will process the BibLaTeX file, create individual Markdown files in the `output_directory/abstract` folder, and generate a corpus file in the `output_directory/corpus` folder.

## Configuration

You can customize the fields to extract by modifying the `fields_to_extract` list. The available fields are:

- 'author_last_name'
- 'year'
- 'title'
- 'ID'
- 'abstract'
- 'keywords'
- 'note'
- Any other fields present in your BibLaTeX entries

## Contributing

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

## License

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

## Acknowledgments

- Thanks to the creators of the `bibtexparser` library, which this project heavily relies on.

## Contact

If you have any questions or feedback, please open an issue on the GitHub repository.
            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "biblatex2qmd",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": null,
    "keywords": "bib, latex, processor",
    "author": null,
    "author_email": "Jan-Ru Muller <janru.muller@edu.vlerick.com>",
    "download_url": "https://files.pythonhosted.org/packages/8b/50/dbec64a8f00fd150c37a9c381a796e6d7c6fe12158177d1fcc8bf8805903/biblatex2qmd-0.1.7.tar.gz",
    "platform": null,
    "description": "# BibLaTeX Processor\n\nBibLaTeX Processor is a Python package that processes BibLaTeX files, extracts information from each entry, creates individual Markdown files for each entry, and generates a combined corpus file.\n\n## Features\n\n- Validates BibLaTeX files\n- Extracts key information from BibLaTeX entries\n- Generates individual Markdown files for each entry\n- Creates a combined corpus file\n- Handles custom notes and keywords\n\n## Installation\n\nYou can install BibLaTeX Processor using pip:\n\n```bash\npip install biblatex-processor\n```\n\n## Usage\n\nHere's a basic example of how to use BibLaTeX Processor:\n\n```python\nfrom biblatex_processor import process_entries\n\ninput_file = 'path/to/your/bibfile.bib'\noutput_directory = 'path/to/output/directory'\nfields_to_extract = ['author_last_name', 'year', 'title', 'ID', 'abstract', 'keywords', 'note']\n\nprocess_entries(input_file, output_directory, fields_to_extract)\n```\n\nThis will process the BibLaTeX file, create individual Markdown files in the `output_directory/abstract` folder, and generate a corpus file in the `output_directory/corpus` folder.\n\n## Configuration\n\nYou can customize the fields to extract by modifying the `fields_to_extract` list. The available fields are:\n\n- 'author_last_name'\n- 'year'\n- 'title'\n- 'ID'\n- 'abstract'\n- 'keywords'\n- 'note'\n- Any other fields present in your BibLaTeX entries\n\n## Contributing\n\nContributions are welcome! Please feel free to submit a Pull Request.\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n\n## Acknowledgments\n\n- Thanks to the creators of the `bibtexparser` library, which this project heavily relies on.\n\n## Contact\n\nIf you have any questions or feedback, please open an issue on the GitHub repository.",
    "bugtrack_url": null,
    "license": "MIT License\n        \n        Copyright (c) [year] [fullname]\n        \n        Permission is hereby granted, free of charge, to any person obtaining a copy\n        of this software and associated documentation files (the \"Software\"), to deal\n        in the Software without restriction, including without limitation the rights\n        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n        copies of the Software, and to permit persons to whom the Software is\n        furnished to do so, subject to the following conditions:\n        \n        The above copyright notice and this permission notice shall be included in all\n        copies or substantial portions of the Software.\n        \n        THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n        SOFTWARE.",
    "summary": "BibLaTeX Processor is a Python package that processes BibLaTeX files, extracts information from each entry, creates individual Markdown files for each entry, and generates a combined corpus file.",
    "version": "0.1.7",
    "project_urls": {
        "Homepage": "https://github.com/jan-ru/biblatex2qmd"
    },
    "split_keywords": [
        "bib",
        " latex",
        " processor"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "f1b86155ab5f40b3d0ac5e0f25598bb0d5d3fbae82dec3ec3ea654b4526ed1b9",
                "md5": "07ba0186f4ce872ec7640eeea3d1fbe9",
                "sha256": "ec1a3465ea9fdda9c83e1d61f57a79eec3dbcb6cd65dbf38ac13d042dee6ec39"
            },
            "downloads": -1,
            "filename": "biblatex2qmd-0.1.7-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "07ba0186f4ce872ec7640eeea3d1fbe9",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7",
            "size": 7802,
            "upload_time": "2024-08-27T14:16:48",
            "upload_time_iso_8601": "2024-08-27T14:16:48.648568Z",
            "url": "https://files.pythonhosted.org/packages/f1/b8/6155ab5f40b3d0ac5e0f25598bb0d5d3fbae82dec3ec3ea654b4526ed1b9/biblatex2qmd-0.1.7-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "8b50dbec64a8f00fd150c37a9c381a796e6d7c6fe12158177d1fcc8bf8805903",
                "md5": "6f65d6f95972d38b9f02066bba006aaa",
                "sha256": "1036d399213559095ce519c27053db005ac528e74d6c26342f3ceb3198c0c516"
            },
            "downloads": -1,
            "filename": "biblatex2qmd-0.1.7.tar.gz",
            "has_sig": false,
            "md5_digest": "6f65d6f95972d38b9f02066bba006aaa",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7",
            "size": 12227,
            "upload_time": "2024-08-27T14:16:47",
            "upload_time_iso_8601": "2024-08-27T14:16:47.428359Z",
            "url": "https://files.pythonhosted.org/packages/8b/50/dbec64a8f00fd150c37a9c381a796e6d7c6fe12158177d1fcc8bf8805903/biblatex2qmd-0.1.7.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-08-27 14:16:47",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "jan-ru",
    "github_project": "biblatex2qmd",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "biblatex2qmd"
}