| Name | text-file-to-pdf JSON |
| Version |
0.0.7
JSON |
| download |
| home_page | None |
| Summary | A Python-based tool converting a text file to a PDF file |
| upload_time | 2024-08-16 17:42:49 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.10 |
| license | None |
| keywords |
oracle
object
tracker
git
ddl
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Text File to PDF
[<img src="https://img.shields.io/badge/GitHub-TruckCab%2Ftext--file--to--pdf-blue.svg?logo=Github">](https://github.com/TruckCab/text-file-to-pdf)
[](https://github.com/TruckCab/text-file-to-pdf/actions/workflows/ci.yml)
[](https://pypi.org/project/text-file-to-pdf/)
[](https://badge.fury.io/py/text-file-to-pdf)
[](https://pypi.org/project/text-file-to-pdf/)
## Install package
You can install `text-file-to-pdf` from source.
### Option 1 - from PyPi
```shell
# Create the virtual environment
python3 -m venv .venv
# Activate the virtual environment
. .venv/bin/activate
pip install text-file-to-pdf
```
### Option 2 - from source - for development
```shell
git clone https://github.com/TruckCab/text-file-to-pdf.git
cd text-file-to-pdf
# Create the virtual environment
python3 -m venv .venv
# Activate the virtual environment
. .venv/bin/activate
# Upgrade pip, setuptools, and wheel
pip install --upgrade pip setuptools wheel
# Install text-file-to-pdf - in editable mode with dev dependencies
pip install --editable .[dev]
```
### Note
For the following commands - if you running from source and using `--editable` mode (for development purposes) - you will need to set the PYTHONPATH environment variable as follows:
```shell
export PYTHONPATH=$(pwd)/src
```
## Usage
### Help
```shell
text-file-to-pdf --help
Usage: text-file-to-pdf [OPTIONS]
Options:
--version / --no-version Prints the "Text File to PDF" program
version and exits. [required]
--input-file TEXT The input text file to convert to PDF
format. The path can be relative or
absolute. [required]
--output-file TEXT The output PDF file to create. The path can
be relative or absolute. [required]
--orientation [portrait|landscape]
The page orientation to use for the PDF
file. [required]
--format [a3|a4|a5|letter|legal]
The page (paper) format for the PDF file.
[default: letter; required]
--font-name [courier|helvetica|times]
The font to use in the PDF file. [default:
courier; required]
--font-size INTEGER The font-size to use in the PDF file.
[default: 9; required]
--help Show this message and exit.
```
## Handy development commands
#### Version management
##### Bump the version of the application - (you must have installed from source with the [dev] extras)
```bash
bumpver update --patch
```
Raw data
{
"_id": null,
"home_page": null,
"name": "text-file-to-pdf",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "oracle, object, tracker, git, ddl",
"author": null,
"author_email": "Philip Moore <prmoore77@hotmail.com>, Stephen Weber <sweber@truckcab.com>",
"download_url": "https://files.pythonhosted.org/packages/a9/01/07270e8f8348888a4a722dce6c3fb17964da223aaacb21a6557a8f23e53c/text_file_to_pdf-0.0.7.tar.gz",
"platform": null,
"description": "# Text File to PDF\n\n[<img src=\"https://img.shields.io/badge/GitHub-TruckCab%2Ftext--file--to--pdf-blue.svg?logo=Github\">](https://github.com/TruckCab/text-file-to-pdf)\n[](https://github.com/TruckCab/text-file-to-pdf/actions/workflows/ci.yml)\n[](https://pypi.org/project/text-file-to-pdf/)\n[](https://badge.fury.io/py/text-file-to-pdf)\n[](https://pypi.org/project/text-file-to-pdf/)\n\n## Install package\nYou can install `text-file-to-pdf` from source.\n\n### Option 1 - from PyPi\n```shell\n# Create the virtual environment\npython3 -m venv .venv\n\n# Activate the virtual environment\n. .venv/bin/activate\n\npip install text-file-to-pdf\n```\n\n### Option 2 - from source - for development\n```shell\ngit clone https://github.com/TruckCab/text-file-to-pdf.git\n\ncd text-file-to-pdf\n\n# Create the virtual environment\npython3 -m venv .venv\n\n# Activate the virtual environment\n. .venv/bin/activate\n\n# Upgrade pip, setuptools, and wheel\npip install --upgrade pip setuptools wheel\n\n# Install text-file-to-pdf - in editable mode with dev dependencies\npip install --editable .[dev]\n```\n\n### Note\nFor the following commands - if you running from source and using `--editable` mode (for development purposes) - you will need to set the PYTHONPATH environment variable as follows:\n```shell\nexport PYTHONPATH=$(pwd)/src\n```\n\n## Usage\n### Help\n```shell\ntext-file-to-pdf --help\nUsage: text-file-to-pdf [OPTIONS]\n\nOptions:\n --version / --no-version Prints the \"Text File to PDF\" program\n version and exits. [required]\n --input-file TEXT The input text file to convert to PDF\n format. The path can be relative or\n absolute. [required]\n --output-file TEXT The output PDF file to create. The path can\n be relative or absolute. [required]\n --orientation [portrait|landscape]\n The page orientation to use for the PDF\n file. [required]\n --format [a3|a4|a5|letter|legal]\n The page (paper) format for the PDF file.\n [default: letter; required]\n --font-name [courier|helvetica|times]\n The font to use in the PDF file. [default:\n courier; required]\n --font-size INTEGER The font-size to use in the PDF file.\n [default: 9; required]\n --help Show this message and exit.\n```\n\n## Handy development commands\n\n#### Version management\n\n##### Bump the version of the application - (you must have installed from source with the [dev] extras)\n```bash\nbumpver update --patch\n```\n",
"bugtrack_url": null,
"license": null,
"summary": "A Python-based tool converting a text file to a PDF file",
"version": "0.0.7",
"project_urls": {
"Homepage": "https://github.com/TruckCab/text-to-pdf"
},
"split_keywords": [
"oracle",
" object",
" tracker",
" git",
" ddl"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4d0751245e7dd87b074f0a78e007368e756bda1f437769a38b3015f8528f4ecc",
"md5": "ed08337f20f8c8bbc570b6c7c9bc5a94",
"sha256": "da0c21407fb6a1485d547b9053d3b0048c4f5d7e6ffb8c0b17a29a8a381a1df8"
},
"downloads": -1,
"filename": "text_file_to_pdf-0.0.7-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ed08337f20f8c8bbc570b6c7c9bc5a94",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 4367,
"upload_time": "2024-08-16T17:42:48",
"upload_time_iso_8601": "2024-08-16T17:42:48.645473Z",
"url": "https://files.pythonhosted.org/packages/4d/07/51245e7dd87b074f0a78e007368e756bda1f437769a38b3015f8528f4ecc/text_file_to_pdf-0.0.7-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a90107270e8f8348888a4a722dce6c3fb17964da223aaacb21a6557a8f23e53c",
"md5": "84c7b090f917bf4c93155bc05362eff0",
"sha256": "ab0b30a1bcde0812b9da08d01391f9441496f4d3b9a86ebdea5a5ef4fd9c7262"
},
"downloads": -1,
"filename": "text_file_to_pdf-0.0.7.tar.gz",
"has_sig": false,
"md5_digest": "84c7b090f917bf4c93155bc05362eff0",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 4217,
"upload_time": "2024-08-16T17:42:49",
"upload_time_iso_8601": "2024-08-16T17:42:49.438650Z",
"url": "https://files.pythonhosted.org/packages/a9/01/07270e8f8348888a4a722dce6c3fb17964da223aaacb21a6557a8f23e53c/text_file_to_pdf-0.0.7.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-16 17:42:49",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "TruckCab",
"github_project": "text-to-pdf",
"github_not_found": true,
"lcname": "text-file-to-pdf"
}
