Skip to main content

mdfy plugin for esa.

Project description

mdfy-esa

pypi python release & publish workflow test status codecov

mdfy plugin for esa

Usage

The mdfy-esa feature supports uploading of local images and files. With the EsaMdfier, images or files designated with MdImage or MdLink are uploaded automatically. Simply pass the MdImage with the local image path, and voila - it’s done!"

from mdfy import MdImage, MdLink, MdText
from mdfy_esa import EsaMdfier

esa_team = "your esa team name"
post_fullname = "post name as you like"
contents = [
    MdText("This is a test article."),
    MdImage(src="examples/test_image.png"),
    MdLink(url="examples/dummy.pdf"),
]

mdfier = EsaMdfier(post_fullname=post_fullname, esa_team=esa_team)
created_post_info = mdfier.write(contents=contents)

# created_post_info = {'number': 4418, 'name': 'My Test Article', 'full_name': 'note/me/My Test Article', 'wip': True, 'body_md': 'This is a test article.\n', 'body_html': '<p data- ...}
# see esa.io api document for detail
# https://docs.esa.io/posts/102#POST%20/v1/teams/:team_name/posts

You can also update an existing post using its post number!

from mdfy import MdImage, MdLink, MdText
from mdfy_esa import EsaMdfier

esa_team = "your esa team name"
post_number = 4930
contents = [
    MdText("NEW! This post is updated!"),
    MdText("This is a test article."),
    MdImage(src="examples/test_image.png"),
    MdLink(url="examples/dummy.pdf"),
]

mdfier = EsaMdfier(post_number=post_number, esa_team=esa_team)
updated_post_info = mdfier.write(contents=contents)

Features

  • TODO

Credits

This package was created with Cookiecutter and the waynerv/cookiecutter-pypackage project template.

Project details


Download files

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

Source Distribution

mdfy_esa-0.3.1.tar.gz (4.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mdfy_esa-0.3.1-py3-none-any.whl (4.2 kB view details)

Uploaded Python 3

File details

Details for the file mdfy_esa-0.3.1.tar.gz.

File metadata

  • Download URL: mdfy_esa-0.3.1.tar.gz
  • Upload date:
  • Size: 4.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/4.0.2 CPython/3.11.6

File hashes

Hashes for mdfy_esa-0.3.1.tar.gz
Algorithm Hash digest
SHA256 676810bfc849787d4315d1a29af40fa96c7bfa9bcc59dc65d43952c42e753c4f
MD5 60c34809f2e0de45f83bb7b72742ff3f
BLAKE2b-256 6df97af49bc7e918a11b4647f6ad0377afad522889f585eab146229e78151097

See more details on using hashes here.

File details

Details for the file mdfy_esa-0.3.1-py3-none-any.whl.

File metadata

  • Download URL: mdfy_esa-0.3.1-py3-none-any.whl
  • Upload date:
  • Size: 4.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/4.0.2 CPython/3.11.6

File hashes

Hashes for mdfy_esa-0.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 6eff981aedf825264044b62ba1ad40a12e346b4274a70e85517de6ddd7e03d09
MD5 a7559db9146b46f6d7b4f7ae15d39c83
BLAKE2b-256 929afba9898e87a49bc36f4c6b4bbb9ec72534c30725673381ab2aed06b0152a

See more details on using hashes here.

Supported by

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