Skip to main content

Support technical writing on HubSpot using Markdown.

Project description

Technical Writing on HubSpot

Tests Test coverage Python versions

License Status PyPI Downloads

» Changelog | PyPI | Issues | Source code | License

About

Setup

pip install --upgrade hubspot-tech-writing

After installation, you can verify if it was successful.

hstw --version

Usage

Markup Conversion

You can convert a Markdown file on your workstation, and write the output to an HTML file.

wget -O original.md https://github.com/crate-workbench/hubspot-tech-writing/raw/main/tests/data/hubspot-blog-post-original.md
hstw convert original.md converted.html

Alternatively, convert a Markdown file at a remote location, and write the output to STDOUT.

hstw convert https://github.com/crate-workbench/hubspot-tech-writing/raw/main/tests/data/hubspot-blog-post-original.md

Link Checker

In order to report about missing links to the web, or inline images, run the link checker on your Markdown documents.

hstw linkcheck original.md

Alternatively, you can also use a remote resource here.

hstw linkcheck https://github.com/crate-workbench/hubspot-tech-writing/raw/main/tests/data/hubspot-blog-post-original.md

HubSpot Upload

Uploading to HubSpot is mostly an iterative process, so you will most likely need to use the program multiple times on the same resource. In order ease invocation, we recommend to define an environment variable for storing your access token to the HubSpot API.

export HUBSPOT_ACCESS_TOKEN=pat-na1-e8805e92-b7fd-5c9b-adc8-2299569f56c2

Upload HTML file from workstation. The name of the blog post will be derived from the file name.

hstw upload testdrive.html

Upload PNG image from workstation to folder path on hubfs.

hstw upload testdrive.png --folder-path=/foo/bar

Convert Markdown to HTML, upload the document under a different name, and also upload all referenced images.

hstw upload /path/to/document.md --name=a-different-name --folder-path=/blog/2023/topic

For more detailed information about this feature, please refer to the inline help:

hstw upload --help

HubSpot Delete

You can delete blog post and file entities, by their unique resource identifiers, or by name resp. path.

# Delete blog post by resource identifier.
hstw delete post --id=138458225506
# Delete file by path.
hstw delete file --path=/testdrive/foo.png

For more detailed information about this feature, please refer to the inline help:

hstw delete --help

Troubleshooting

Blog posts may not contain embedded images

If you are uploading directly from GitHub, and run such a command,

hstw upload https://github.com/acme/foo-repo/raw/main/article.md --name=testdrive

only to receive an error message like this,

{
  "correlationId": "4836e94d-e42b-47a1-afff-597d8b67ba93",
  "errorType": "BLOG_POST_CONTAINS_EMBEDDED_IMAGES",
  "message": "Blog posts may not contain embedded images. Please upload images to File Manager.",
  "status": "error"
}

you are most certainly using a "private" repository, where hstw does not have access permissions to.

Prior Art

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

hubspot-tech-writing-0.1.0.tar.gz (18.4 kB view hashes)

Uploaded Source

Built Distribution

hubspot_tech_writing-0.1.0-py3-none-any.whl (16.5 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page